如何在YII2框架中使用behavior

tangjin

作者

本篇文章给大家分享的是有关如何在YII2框架中使用behavior，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。

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

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

注意行为是对功能的扩展，不要乱用行为，比如有一个动物类和一个人类，他们各自有自已的名称，身高，体重，这些是属性。

他们都会跑，这个时候我们就可以抽象出来做成一个跑的行为，根据不同需求来扩展他们。

这里我们有两个控制器一个GoodsController，一个OrderController，他们都接收请求，返回数据给客户端，不过有的需要返回json，有的需要返回xml。

那么我们就创建一个返回数据行为来扩展这两个控制器。

我们在项目目录下创建common目录，并创建ReturnBehavior.php，代码如下：

<?php

namespaceapp\common;

useYII;
useyii\base\Behavior;
useyii\web\Controller;
useyii\web\Response;

//必须继承自yii\base\Behavior
classReturnBehaviorextendsBehavior
{

//返回类型，通过控制器里的behaviors()配置参数获取值
public$return_type='';

//让行为响应组件的事件触发
publicfunctionevents()
{
return[
//控制器方法执行后触发事件，调用returnData函数
Controller::EVENT_AFTER_ACTION=>'returnData',
];
}

//返回数据
publicfunctionreturnData()
{
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;
}
}

//定义方法
publicfunctiontest(){
echo'returnBehaviortest...';
}
}

然后我们在两个控制器中配置behaviors()来使用行为：

GoodsController.php代码如下：

<?php

namespaceapp\controllers;

useYII;
useapp\common\ReturnBehavior;
useyii\web\Controller;

//想要使用行为，必须是component或是其子类
//yii\web\Controller继承自component，所以可以使用
classGoodsControllerextendsController
{

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

//获取商品列表
publicfunctionactionGetGoodsList()
{
return[
['id'=>1,'name'=>'商品1'],
['id'=>2,'name'=>'商品2'],
];
}

publicfunctionactionIndex()
{
//控制器调用行为中的方法
$this->getBehavior('returnBehavior')->test();
//注意这里，因为使用了行为，方法执行后会设置返回内容为xml，我们重新设置为html
$this->getBehavior('returnBehavior')->return_type='html';
}
}

OrderController.php代码如下：

<?php

namespaceapp\controllers;

useYII;
useapp\common\ReturnBehavior;
useyii\web\Controller;

//想要使用行为，必须是component或是其子类
//yii\web\Controller继承自component，所以可以使用
classOrderControllerextendsController
{
//配置控制器需要使用的行为
publicfunctionbehaviors()
{
return[
'returnBehavior'=>[
'class'=>ReturnBehavior::className(),
'return_type'=>'xml',
],
];
}

//获取商品列表
publicfunctionactionGetOrderList()
{
return[
['id'=>1,'name'=>'订单1'],
['id'=>2,'name'=>'订单2'],
];
}

publicfunctionactionIndex()
{
//控制器调用行为中的方法
$this->getBehavior('returnBehavior')->test();
//注意这里，因为使用了行为，方法执行后会设置返回内容为xml，我们重新设置为html
$this->getBehavior('returnBehavior')->return_type='html';
}
}

这个时候我们在地址栏访问/goods/get-goods-list和/order/get-order-list，结果如下：