Yii2的事件

Yii2的事件

一、事件

事件是什么？

     事件可以将自定义代码“注入”到现有代码中的特定执行点。 附加自定义代码到某个事件，当这个事件被触发时，这些代码就会自动执行。事件既是代码解耦的一种方式，也是设计业务流程的一种模式。

     在Yii2中可以很好的支持事件，在执行一个操作后，可以触发一个事件，实现不同的功能。比如用户在网站注册成功后，接下来网站要给用户邮箱发送通知的邮件。这就是两个相当独立的功能，我们就可以定义好这些独立的事件，在发布成功后，按顺序触发这些事件，一方面可以解耦代码复杂的关系，另一方面利于维护。事件相对于硬编码的方式来说也增加了服务器资源开销，所以比较建议在任务较为复杂时使用事件！

     Yii2 引入了名为 yii\base\Component 的基类以支持事件。 如果一个类需要触发事件就应该继承 yii\base\Component 或其子类。同时，Yii2中还有一个与事件紧密相关的 yii\base\Event ，他封装了与事件相关的有关数据，并提供一些功能函数作为辅助。

     在命名上，yii2 借用了 jquery 事件系统的那一套，on，off，trigger。

事件的绑定

     在yii2中，事件的绑定是通过yii\base\Component的 on 方法进行操作的，很显然，同js操作一样，我们在定义事件的同时，需要为其绑定一个回调函数，用于事件触发。

<?php

namespace backend\controllers;

use Yii;
use yii\web\Controller;

class EventTestController extends Controller
{
    const EVENT_TEST = 'event_test';

    public function init ()
    {
        parent::init();
        // 这里写了一个function作为回调函数
        $this->on(self::EVENT_TEST, function () {
            echo "I`m a test event.";
        });
    }
}

    注意：推荐使用类常量来表示事件名。上例中，常量 EVENT_TEST 用来表示 test 。 这有两个好处。第一，它可以防止拼写错误并支持 IDE 的自动完成。 第二，只要简单检查常量声明就能了解一个类支持哪些事件。

    关于回调函数的写法，有以下几种方式：

$foo = new Foo;

// 处理器是全局函数
$foo->on(Foo::EVENT_HELLO, 'function_name');

// 处理器是对象方法
$foo->on(Foo::EVENT_HELLO, [$object, 'methodName']);

// 处理器是静态类方法
$foo->on(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);

// 处理器是匿名函数
$foo->on(Foo::EVENT_HELLO, function ($event) {
    //事件处理逻辑
});

事件的触发

    如果一个事件只有定义，但是却没有被触发，那这个事件要之何用？事件的触发也很简单，只需要调用 yii\base\Component类的trigger方法，指定事件名即可。

<?php

namespace backend\controllers;

use Yii;
use yii\web\Controller;

class EventTestController extends Controller
{
    const EVENT_TEST = 'event_test';

    // ...
    public function actionIndex (){
       $this->trigger(self::EVENT_TEST);
    }

}

   有些时候，我们想要在触发事件时同时传递一些额外信息到事件处理器，比如下面：

<?php

namespace app\components;

use yii\base\Component;
use yii\base\Event;

class MessageEvent extends Event
{
    public $message;
}

class Mailer extends Component
{
    const EVENT_MESSAGE_SENT = 'messageSent';

    public function send($message)
    {
        // ...发送 $message 的逻辑...

        $event = new MessageEvent;
        $event->message = $message;
        $this->trigger(self::EVENT_MESSAGE_SENT, $event);
    }
}

事件的移除

    从事件移除处理器，调用 yii\base\Component类的off() 方法。如：

// 处理器是全局函数
$foo->off(Foo::EVENT_HELLO, 'function_name');

// 处理器是对象方法
$foo->off(Foo::EVENT_HELLO, [$object, 'methodName']);

// 处理器是静态类方法
$foo->off(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);

// 处理器是匿名函数
$foo->off(Foo::EVENT_HELLO, $anonymousFunction);

二、预定义事件

     预定义事件就是yii在源码内提前定义好的事件，注意这个定义好并不是其提前on好的，而是提前trigger好的。yii内其实还是定义了很多事件的，我们主要介绍三种事件的使用，包括跟应用相关的，跟user组件相关以及最常用的model相关事件。

1、应用相关事件

    在yii中，我们知道，一个项目，就是一个应用。在程序中这个应用用Yii::$app来表示，既然是应用级别的事件，那自然就跟Yii::$app有关。
    yii\base\Application类中定义了下面这两个事件：

<?php
namespace yii\base;

use Yii;
abstract class Application extends Module
{
    const EVENT_BEFORE_REQUEST = 'beforeRequest';

    const EVENT_AFTER_REQUEST = 'afterRequest';
    

   下面通过一段代码来测试下：

<?php

defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'dev');

//...

// (new yii\web\Application($config))->run();
$application=new \yii\web\Application($config);
Yii::$app->on(\yii\base\Application::EVENT_BEFORE_REQUEST,function ($event){
    yii::info('请求前：This is beforeRequest event.');
});
Yii::$app->on(\yii\base\Application::EVENT_AFTER_REQUEST,function ($event){
    yii::info('请求后：This is afterRequest event.');
});
$application->run();

 

   刷新网页后，通过yii2-debug我们看到下面信息（为了方便查看，中间省略了一些其他信息）：

  

 

2、user组件相关事件

     user组件类yii\web\User定义了4个事件，包括登陆前后和退出前后各两个事件，打开该文件看下：

<?php
namespace yii\web;

use Yii;
use yii\base\Component;
use yii\base\InvalidConfigException;
use yii\base\InvalidValueException;
use yii\rbac\CheckAccessInterface;

class User extends Component
{
    const EVENT_BEFORE_LOGIN = 'beforeLogin';
    const EVENT_AFTER_LOGIN = 'afterLogin';
    const EVENT_BEFORE_LOGOUT = 'beforeLogout';
    const EVENT_AFTER_LOGOUT = 'afterLogout';

    开发中可能会有这样的需求：用户登录成功后，更新用户最后的登录时间，ip等信息，比如下面：

<?php
namespace common\models;

use Yii;
use yii\base\Model;

class AdminLoginForm extends Model
{
    public $username;
    public $password;
    public $rememberMe = true;

    private $_user;
    // ...

    public function login()
    {
        if ($this->validate()) {
            Yii::$app->user->on(yii\web\User::EVENT_AFTER_LOGIN, [$this, 'onAfterLogin']);
            // 校验成功后，session保存用户信息
            return Yii::$app->user->login($this->getUser(), $this->rememberMe ? 3600 * 24 * 30 : 0);
        } else {
            return false;
        }
    }

    public function onAfterLogin ($event)
    {
      $identity = $event->identity;
      $date = date('Y-m-d H:i:s');
      yii::info("id={$identity->id}的用户最后一次登录系统的时间是{$date}");
    }
}

3、model层相关事件

     既然跟model相关，那自然就离不开yii\db\BaseActiveRecord了，打开该文件看下，果然里面定义了9个事件：

<?php

namespace yii\web;

namespace yii\db;

use yii\base\Event;
use yii\base\InvalidCallException;
use yii\base\InvalidConfigException;
use yii\base\InvalidParamException;
use yii\base\Model;
use yii\base\ModelEvent;
use yii\base\NotSupportedException;
use yii\base\UnknownMethodException;
use yii\helpers\ArrayHelper;

abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
{

    const EVENT_INIT = 'init';

    const EVENT_AFTER_FIND = 'afterFind';

    const EVENT_BEFORE_INSERT = 'beforeInsert';

    const EVENT_AFTER_INSERT = 'afterInsert';

    const EVENT_BEFORE_UPDATE = 'beforeUpdate';

    const EVENT_AFTER_UPDATE = 'afterUpdate';

    const EVENT_BEFORE_DELETE = 'beforeDelete';

    const EVENT_AFTER_DELETE = 'afterDelete';

    const EVENT_AFTER_REFRESH = 'afterRefresh';
    

  若想要触发yii\db\BaseActiveRecord::EVENT_BEFORE_INSERT事件，第一步我们先要在model类中绑定yii\db\BaseActiveRecord::EVENT_BEFORE_INSERT

  下面我们打开common\models\Post类，增加init方法如下：

<?php
namespace common\models;

use Yii;
use yii\bootstrap\Html;

class Post extends \yii\db\ActiveRecord
{
    public function init ()
    {
       parent::init();
       $this->on(self::EVENT_BEFORE_INSERT, [$this, 'onBeforeInsert']);
       $this->on(self::EVENT_AFTER_INSERT, [$this, 'onAfterInsert']);
    }
    
    // ...

    public function onBeforeInsert ($event)
    {
       yii::info('This is beforeInsert event.');
    }

    public function onAfterInsert ($event)
    {
       yii::info('This is alterInsert event.');
    }
}

 

参考链接：

http://www.manks.top/document/yii2-event-predefine.html