YII2中behavior行為的理解與使用

YII2中的行為說白了就是對組件功能的擴展，在不改變繼承關系的條件下。

行為附加到組件后，行為將注入自已的方法和屬性到組件，可以像組件訪問自定義的方法和屬性一樣訪問行為。

注意行為是對功能的擴展，不要亂用行為，比如有一個動物類和一個人類，他們各自有自已的名稱，身高，體重，這些是屬性。

他們都會跑，這個時候我們就可以抽象出來做成一個跑的行為，根據不同需求來擴展他們。

這里我們有兩個控制器一個GoodsController，一個OrderController，他們都接收請求，返回數據給客戶端，不過有的需要返回json，有的需要返回xml。

那么我們就創建一個返回數據行為來擴展這兩個控制器。

我們在項目目錄下創建common目錄，並創建ReturnBehavior.php，代碼如下：

<?php

namespace app\common;

use YII;
use yii\base\Behavior;
use yii\web\Controller;
use yii\web\Response;

//必須繼承自yii\base\Behavior
class ReturnBehavior extends Behavior
{

    //返回類型，通過控制器里的behaviors()配置參數獲取值
    public $return_type = '';

    //讓行為響應組件的事件觸發
    public function events()
    {
        return [
            //控制器方法執行后觸發事件，調用returnData函數
            Controller::EVENT_AFTER_ACTION => 'returnData',
        ];
    }

    //返回數據
    public function returnData()
    {
        switch ($this->return_type) {
            case 'json':
                YII::$app->response->format = Response::FORMAT_JSON;
                break;
            case 'xml':
                YII::$app->response->format = Response::FORMAT_XML;
                break;
            case 'html':
                YII::$app->response->format = Response::FORMAT_HTML;
                break;
            default :
                break;
        }
    }

    //定義方法
    public function test() {
        echo 'returnBehavior test ...';
    }
}

然后我們在兩個控制器中配置behaviors()來使用行為：

GoodsController.php代碼如下：

<?php

namespace app\controllers;

use YII;
use app\common\ReturnBehavior;
use yii\web\Controller;

//想要使用行為，必須是component或是其子類
//yii\web\Controller繼承自component，所以可以使用
class GoodsController extends Controller
{

    //配置控制器需要使用的行為
    public function behaviors()
    {
        return [
            'returnBehavior' => [
                'class' => ReturnBehavior::className(),
                'return_type' => 'json',
            ],
        ];
    }

    //獲取商品列表
    public function actionGetGoodsList()
    {
        return [
            ['id' => 1, 'name' => '商品1'],
            ['id' => 2, 'name' => '商品2'],
        ];
    }

    public function actionIndex()
    {
        //控制器調用行為中的方法
        $this->getBehavior('returnBehavior')->test();
        //注意這里，因為使用了行為，方法執行后會設置返回內容為xml，我們重新設置為html
        $this->getBehavior('returnBehavior')->return_type = 'html';
    }
}

OrderController.php代碼如下：

<?php

namespace app\controllers;

use YII;
use app\common\ReturnBehavior;
use yii\web\Controller;

//想要使用行為，必須是component或是其子類
//yii\web\Controller繼承自component，所以可以使用
class OrderController extends Controller
{
    //配置控制器需要使用的行為
    public function behaviors()
    {
        return [
            'returnBehavior' => [
                'class' => ReturnBehavior::className(),
                'return_type' => 'xml',
            ],
        ];
    }

    //獲取商品列表
    public function actionGetOrderList()
    {
        return [
            ['id' => 1, 'name' => '訂單1'],
            ['id' => 2, 'name' => '訂單2'],
        ];
    }

    public function actionIndex()
    {
        //控制器調用行為中的方法
        $this->getBehavior('returnBehavior')->test();
        //注意這里，因為使用了行為，方法執行后會設置返回內容為xml，我們重新設置為html
        $this->getBehavior('returnBehavior')->return_type = 'html';
    }
}

這個時候我們在地址欄訪問/goods/get-goods-list和/order/get-order-list，結果如下：

然后我們訪問/goods/index和/order/index，行為方法成功調用，結果如下：