PHP的Yii框架中过滤器相关的使用总结

yii过滤器简介

过滤器是一段代码，可被配置在控制器动作执行之前或之后执行。例如， 访问控制过滤器将被执行以确保在执行请求的动作之前用户已通过身份验证；性能过滤器可用于测量控制器执行所用的时间。

一个动作可以有多个过滤器。过滤器执行顺序为它们出现在过滤器列表中的顺序。过滤器可以阻止动作及后面其他过滤器的执行。

过滤器有两种写法：

• 基于方法的过滤器
• 基于自定义过滤器类的过滤器

无论哪种过滤器，都必须在控制器中重写控制器的public function filters()方法，设置哪个过滤器对哪个动作起作用。

基于方法的过滤器

编写基于方法的过滤器，要经过三步：

在控制器中编写动作（action）；
在控制器中编写过滤器函数，函数名必须以filter为前缀，如：function filteraccesscontrol()；
重写父类ccontroller的filters()方法，定义过滤器与动作的关系；
实例：

<?php 
   
  class usercontroller extends ccontroller{ 
    ** 
     * 第一步：创建动作 
     */ 
      function actionadd(){  
        echo "actionadd"; 
      } 
      /** 
      * 第二步：创建基于方法的过滤器 
       */ 
      public function filteraddfilter($filterchain) { 
        echo "基于方法的过滤器usercontroller.filteradd<br>"; 
        $filterchain->run(); 
      } 
      /** 
      * 第三步：重写父类ccontroller的filters()方法，定义过滤器与动作的关系 
      * @see ccontroller::filters() 
      */ 
      public function filters(){ 
        return array( 
      //定义过滤器与动作的关联关系 
          'addfilter + add', 
//         array( 
//             'application.filters.testfilter',           
//         ), 
           
      ); 
    } 
  } 

自定义过滤器类

自定义过滤器类，需要单独写一个过滤器类，并继承cfilter类，重写cfilter类下的部分方法。大家可以看一下cfilter类的代码，该类代码不多，还是很容易看懂的。

自定义过滤器实例：

<?php 
class testfilter extends cfilter{ 
  /** 
   * performs the pre-action filtering. 
   * @param cfilterchain $filterchain the filter chain that the filter is on. 
   * @return boolean whether the filtering process should continue and the action 
   * should be executed. 
   */ 
  protected function prefilter($filterchain) 
  { 
    echo "--->testfilter.prefilter.<br>"; 
    return true; 
  } 
   
  /** 
   * performs the post-action filtering. 
   * @param cfilterchain $filterchain the filter chain that the filter is on. 
   */ 
  protected function postfilter($filterchain) 
  { 
    echo "--->testfilter.postfilter.<br>"; 
  } 
} 

在控制器中注册该自定义过滤器与动作的绑定关系：

/**
* 第三步：重写父类ccontroller的filters()方法，定义过滤器与动作的关系 
* @see ccontroller::filters() 
*/ 
ublic function filters(){ 
return array( 
  //定义过滤器与动作的关联关系 
    'addfilter + add', 
      array( 
          'application.filters.testfilter',           
      ), 
     
); 

我自定义了一个过滤器：testfilter，继承了cfilter类，重写了cfilter类的两个主要方法：prefilter（前控制器，在动作执行前运行）和postfilter（后控制器，在动作执行后运行）。

两种控制器的执行顺序

假设我将上面编写的自定义过滤器类与动作actionadd绑定，那么，自定义过滤器继承自父类cfilter两个方法：prefilter和postfilter，与绑定的actionadd之间的执行顺序是怎样的呢？

经过试验，执行顺序为：cfilter::prefilter--------->usercontroller::actionadd--------->cfilter::postfilter。

也就是说，在动作执行前后都可以执行过滤操作。

那么文章开头说“过滤器可以阻止动作及后面其他过滤器的执行”是怎么做到的呢？

看了cfilter::prefilter的官方注释就知道了：

@return boolean whether the filtering process should continue and the action should be executed。

cfilter::prefilter函数默认return
 true;即，默认执行后面的动作和后过滤器。如果在自定义过滤器类中，重写cfilter::prefilter方法，并return
 false；就可以阻止后面的动作和过滤器执行了！

使用过滤器

过滤器本质上是一类特殊的 行为，所以使用过滤器和 使用 行为一样。 可以在控制器类中覆盖它的 yii\base\controller::behaviors() 方法来申明过滤器，如下所示：

public function behaviors()
{
  return [
    [
      'class' => 'yii\filters\httpcache',
      'only' => ['index', 'view'],
      'lastmodified' => function ($action, $params) {
        $q = new \yii\db\query();
        return $q->from('user')->max('updated_at');
      },
    ],
  ];
}

控制器类的过滤器默认应用到该类的 所有 动作，你可以配置yii\base\actionfilter::only属性明确指定控制器应用到哪些动作。 在上述例子中，httpcache 过滤器只应用到index和view动作。 也可以配置yii\base\actionfilter::except属性使一些动作不执行过滤器。

除了控制器外，可在 模块或应用主体 中申明过滤器。 申明之后，过滤器会应用到所属该模块或应用主体的 所有 控制器动作， 除非像上述一样配置过滤器的 yii\base\actionfilter::only 和 yii\base\actionfilter::except 属性。

补充: 在模块或应用主体中申明过滤器，在yii\base\actionfilter::only 和 yii\base\actionfilter::except 属性中使用路由 代替动作id， 因为在模块或应用主体中只用动作id并不能唯一指定到具体动作。.
当一个动作有多个过滤器时，根据以下规则先后执行：

预过滤

• 按顺序执行应用主体中behaviors()列出的过滤器。
• 按顺序执行模块中behaviors()列出的过滤器。
• 按顺序执行控制器中behaviors()列出的过滤器。
• 如果任意过滤器终止动作执行，后面的过滤器（包括预过滤和后过滤）不再执行。
• 成功通过预过滤后执行动作。

后过滤

• 倒序执行控制器中behaviors()列出的过滤器。
• 倒序执行模块中behaviors()列出的过滤器。
• 倒序执行应用主体中behaviors()列出的过滤器。

创建过滤器

继承 yii\base\actionfilter 类并覆盖 yii\base\actionfilter::beforeaction() 和/或 yii\base\actionfilter::afteraction() 方法来创建动作的过滤器，前者在动作执行之前执行，后者在动作执行之后执行。 yii\base\actionfilter::beforeaction() 返回值决定动作是否应该执行， 如果为false，之后的过滤器和动作不会继续执行。

下面的例子申明一个记录动作执行时间日志的过滤器。

namespace app\components;

use yii;
use yii\base\actionfilter;

class actiontimefilter extends actionfilter
{
  private $_starttime;

  public function beforeaction($action)
  {
    $this->_starttime = microtime(true);
    return parent::beforeaction($action);
  }

  public function afteraction($action, $result)
  {
    $time = microtime(true) - $this->_starttime;
    yii::trace("action '{$action->uniqueid}' spent $time second.");
    return parent::afteraction($action, $result);
  }
}

核心过滤器

yii提供了一组常用过滤器，在yii\filters命名空间下，接下来我们简要介绍这些过滤器。

1.yii\filters\accesscontrol

accesscontrol提供基于yii\filters\accesscontrol::rules规则的访问控制。 特别是在动作执行之前，访问控制会检测所有规则并找到第一个符合上下文的变量（比如用户ip地址、登录状态等等）的规则， 来决定允许还是拒绝请求动作的执行，如果没有规则符合，访问就会被拒绝。

如下示例表示表示允许已认证用户访问create 和 update 动作，拒绝其他用户访问这两个动作。

use yii\filters\accesscontrol;

public function behaviors()
{
  return [
    'access' => [
      'class' => accesscontrol::classname(),
      'only' => ['create', 'update'],
      'rules' => [
        // 允许认证用户
        [
          'allow' => true,
          'roles' => ['@'],
        ],
        // 默认禁止其他用户
      ],
    ],
  ];
}

2.认证方法过滤器

认证方法过滤器通过http basic auth或oauth 2 来认证一个用户，认证方法过滤器类在 yii\filters\auth 命名空间下。

如下示例表示可使用yii\filters\auth\httpbasicauth来认证一个用户，它使用基于http基础认证方法的令牌。 注意为了可运行，yii\web\user::identityclass 类必须 实现 yii\web\identityinterface::findidentitybyaccesstoken()方法。

use yii\filters\auth\httpbasicauth;

public function behaviors()
{
  return [
    'basicauth' => [
      'class' => httpbasicauth::classname(),
    ],
  ];
}

认证方法过滤器通常在实现restful api中使用。

3.yii\filters\contentnegotiator

contentnegotiator支持响应内容格式处理和语言处理。 通过检查 get 参数和 accept http头部来决定响应内容格式和语言。

如下示例，配置contentnegotiator支持json和xml响应格式和英语（美国）和德语。

use yii\filters\contentnegotiator;
use yii\web\response;

public function behaviors()
{
  return [
    [
      'class' => contentnegotiator::classname(),
      'formats' => [
        'application/json' => response::format_json,
        'application/xml' => response::format_xml,
      ],
      'languages' => [
        'en-us',
        'de',
      ],
    ],
  ];
}

在应用主体生命周期过程中检测响应格式和语言简单很多， 因此contentnegotiator设计可被引导启动组件调用的过滤器。 如下例所示可以将它配置在应用主体配置。

use yii\filters\contentnegotiator;
use yii\web\response;

[
  'bootstrap' => [
    [
      'class' => contentnegotiator::classname(),
      'formats' => [
        'application/json' => response::format_json,
        'application/xml' => response::format_xml,
      ],
      'languages' => [
        'en-us',
        'de',
      ],
    ],
  ],
];

补充: 如果请求中没有检测到内容格式和语言，使用formats和languages第一个配置项。
4.yii\filters\httpcache

httpcache利用last-modified 和 etag http头实现客户端缓存。例如：

use yii\filters\httpcache;

public function behaviors()
{
  return [
    [
      'class' => httpcache::classname(),
      'only' => ['index'],
      'lastmodified' => function ($action, $params) {
        $q = new \yii\db\query();
        return $q->from('user')->max('updated_at');
      },
    ],
  ];
}

5.yii\filters\pagecache

pagecache实现服务器端整个页面的缓存。如下示例所示，pagecache应用在index动作， 缓存整个页面60秒或post表的记录数发生变化。它也会根据不同应用语言保存不同的页面版本。

use yii\filters\pagecache;
use yii\caching\dbdependency;

public function behaviors()
{
  return [
    'pagecache' => [
      'class' => pagecache::classname(),
      'only' => ['index'],
      'duration' => 60,
      'dependency' => [
        'class' => dbdependency::classname(),
        'sql' => 'select count(*) from post',
      ],
      'variations' => [
        \yii::$app->language,
      ]
    ],
  ];
}

6.yii\filters\ratelimiter

ratelimiter 根据 漏桶算法 来实现速率限制。

7.yii\filters\verbfilter

verbfilter检查请求动作的http请求方式是否允许执行，如果不允许，会抛出http 405异常。 如下示例，verbfilter指定crud动作所允许的请求方式。

use yii\filters\verbfilter;

public function behaviors()
{
  return [
    'verbs' => [
      'class' => verbfilter::classname(),
      'actions' => [
        'index' => ['get'],
        'view'  => ['get'],
        'create' => ['get', 'post'],
        'update' => ['get', 'put', 'post'],
        'delete' => ['post', 'delete'],
      ],
    ],
  ];
}

8.yii\filters\cors

跨域资源共享 cors 机制允许一个网页的许多资源（例如字体、javascript等） 这些资源可以通过其他域名访问获取。 特别是javascript's ajax 调用可使用 xmlhttprequest 机制，由于同源安全策略该跨域请求会被网页浏览器禁止. cors定义浏览器和服务器交互时哪些跨域请求允许和禁止。

yii\filters\cors 应在 授权 / 认证 过滤器之前定义，以保证cors头部被发送。

use yii\filters\cors;
use yii\helpers\arrayhelper;

public function behaviors()
{
  return arrayhelper::merge([
    [
      'class' => cors::classname(),
    ],
  ], parent::behaviors());
}

cors 可转为使用 cors 属性。

• cors['origin']: 定义允许来源的数组，可为['*'] (任何用户) 或 ['http://www.myserver.net', 'http://www.myotherserver.com']. 默认为 ['*'].
• cors['access-control-request-method']: 允许动作数组如 ['get', 'options', 'head']. 默认为 ['get', 'post', 'put', 'patch', 'delete', 'head', 'options'].
• cors['access-control-request-headers']: 允许请求头部数组，可为 ['*'] 所有类型头部 或 ['x-request-with'] 指定类型头部. 默认为 ['*'].
• cors['access-control-allow-credentials']: 定义当前请求是否使用证书，可为 true, false 或 null (不设置). 默认为null.
• cors['access-control-max-age']: 定义请求的有效时间，默认为 86400.

例如，允许来源为 http://www.myserver.net 和方式为 get, head 和 options 的cors如下：

use yii\filters\cors;
use yii\helpers\arrayhelper;

public function behaviors()
{
  return arrayhelper::merge([
    [
      'class' => cors::classname(),
      'cors' => [
        'origin' => ['http://www.myserver.net'],
        'access-control-request-method' => ['get', 'head', 'options'],
      ],
    ],
  ], parent::behaviors());
}

可以覆盖默认参数为每个动作调整cors 头部。例如，为login动作增加access-control-allow-credentials参数如下所示：

use yii\filters\cors;
use yii\helpers\arrayhelper;

public function behaviors()
{
  return arrayhelper::merge([
    [
      'class' => cors::classname(),
      'cors' => [
        'origin' => ['http://www.myserver.net'],
        'access-control-request-method' => ['get', 'head', 'options'],
      ],
      'actions' => [
        'login' => [
          'access-control-allow-credentials' => true,
        ]
      ]
    ],
  ], parent::behaviors());
}