欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

YII2框架中behavior行为的理解与使用方法示例

程序员文章站 2023-11-21 20:27:40
本文实例讲述了yii2框架中behavior行为的理解与使用方法。分享给大家供大家参考,具体如下:yii2中的行为说白了就是对组件功能的扩展,在不改变继承关系的条件下。行为附加到组件后,行为将注入自已...

本文实例讲述了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,结果如下:

YII2框架中behavior行为的理解与使用方法示例

然后我们访问/goods/index和/order/index,行为方法成功调用,结果如下:

YII2框架中behavior行为的理解与使用方法示例