Yii2模塊自定義響應類

Question

我已經定義了自定義響應類，並試圖在模塊中使用它。

在控制器操作中，我返回一個結果數組，但不使用自定義響應類。

相反，所用的類是缺省YII \網絡\響應

我的實現

在配置/ web.php模塊配置：

'mymodule' => [ 
     'class' => 'app\modules\mymod\Mymod', 
     'components' => [     
      'response' => [ 
       'class' => 'app\modules\mymod\components\apiResponse\ApiResponse', 
       'format' => yii\web\Response::FORMAT_JSON, 
       'charset' => 'UTF-8', 
      ], 
     ], 
    ], 

在控制器我編輯行爲方法：

public function behaviors() { 
    $behaviors = parent::behaviors();   
    $behaviors['contentNegotiator'] = [ 
     'class' => 'yii\filters\ContentNegotiator',    
     'response' => $this->module->get('response'),     
     'formats' => [ //supported formats 
      'application/json' => \yii\web\Response::FORMAT_JSON, 
     ], 
    ]; 
    return $behaviors; 
} 

在行動，如果我做的：

public function actionIndex() { 

    \Yii::$app->response->format = \yii\web\Response::FORMAT_JSON; 

    $dataList = [ 
     ['id' => 1, 'name' => 'John', 'surname' => 'Davis'], 
     ['id' => 2, 'name' => 'Marie', 'surname' => 'Baker'], 
     ['id' => 3, 'name' => 'Albert', 'surname' => 'Bale'], 
    ]; 
    return $dataList; 
} 

我得到這樣的結果（從警予\網絡\響應預期）：

[ 
{ 
    "id": 1, 
    "name": "John", 
    "surname": "Davis" 
}, 
{ 
    "id": 2, 
    "name": "Marie", 
    "surname": "Baker" 
}, 
{ 
    "id": 3, 
    "name": "Albert", 
    "surname": "Bale" 
} 
] 

但是，如果我改變行動在：

$dataList = [ 
    ['id' => 1, 'name' => 'John', 'surname' => 'Davis'], 
    ['id' => 2, 'name' => 'Marie', 'surname' => 'Baker'], 
    ['id' => 3, 'name' => 'Albert', 'surname' => 'Bale'], 
]; 
//return $dataList; 

$resp = $this->module->get('response'); //getting the response component from the module configuration 
$resp->data = $dataList; 

return $resp; 

然後我得到預期的結果，這是這樣的：

{ 
"status": { 
    "response_code": 0, 
    "response_message": "OK", 
    "response_extra": null 
}, 
"data": [ 
    { 
     "id": 1, 
     "name": "John", 
     "surname": "Davis" 
    }, 
    { 
     "id": 2, 
     "name": "Marie", 
     "surname": "Baker" 
    }, 
    { 
     "id": 3, 
     "name": "Albert", 
     "surname": "Bale" 
    } 
]} 

看來我定義的行爲沒有做任何事情。

我需要做些什麼才能在操作中返回數組並使用自定義響應組件？

在此先感謝

Answer 1

yii\base\Module沒有響應組件，因此您的配置將無法正常工作。 而不是將response組件添加到您的模塊您可以改變Yii::$app->responseMyMod::init()功能。

如果你想完全自己的組件替換Yii::$app->response：

public function init() 
{ 
    parent::init(); 

    \Yii::configure(\Yii::$app, [ 
     'components' => [ 
      'response' => [ 
       'class' => 'app\modules\mymod\components\apiResponse\ApiResponse', 
       'format' => yii\web\Response::FORMAT_JSON, 
       'charset' => 'UTF-8', 
      ], 
     ] 
    ]); 
} 

但我認爲這是一個壞主意，完全取代父應用程序的響應部件的模塊中。更好的方法是修改您的需求的響應行爲。例如，你可以使用EVENT_BEFORE_SEND並建立自己的數據結構響應：

public function init() 
{ 
    parent::init(); 

    // you can use ContentNegotiator at the level of module 
    // and remove this behavior declaration from controllers 
    \Yii::configure($this, [ 
     'as contentNegotiator' => [ 
      'class' => 'yii\filters\ContentNegotiator', 
      // if in a module, use the following IDs for user actions 
      // 'only' => ['user/view', 'user/index'] 
      'formats' => [ 
       'application/json' => Response::FORMAT_JSON, 
      ], 
     ], 
    ]); 


    // you can daclare handler as function in you module and pass it as parameter here 
    \Yii::$app->response->on(Response::EVENT_BEFORE_SEND, function ($event) { 
     $response = $event->sender; 
     // here you can get and modify everything in current response 
     // (data, headers, http status etc.) 
     $response->data = [ 
      'status' => 'Okay', 
      'data' => $response->data 
     ]; 
    }); 
}