Yii2 Behavior

YII2中的行为就是对组件功能的扩展,在不改变继承关系的条件下。

行为附加到组件后,行为将注入自已的方法和属性到组件,可以像组件访问自定义的方法和属性一样访问行为。

行为是对功能的扩展,不要乱用行为

有两个控制器一个GoodsController,一个OrderController,他们都接收请求,返回数据给客户端

不过有的需要返回json,有的需要返回xml,那么我们就创建一个返回数据行为来扩展这两个控制器。

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代码如下:

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代码如下:

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';
    }
}

Comments are closed.