yii2.0 事件

Posted 风水工程师

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了yii2.0 事件相关的知识，希望对你有一定的参考价值。

事件（Event）

使用事件，可以在特定的时点，触发执行预先设定的一段代码，事件既是代码解耦的一种方式，也是设计业务流程的一种模式。现代软件中，事件无处不在，比如，你发了个微博，触发了一个事件，导致关注你的人，看到了你新发出来的内容。对于事件而言，有这么几个要素：

  • 这是一个什么事件？一个软件系统里，有诸多事件，发布新微博是事件，删除微博也是一种事件。
  • 谁触发了事件？你发的微博，就是你触发的事件。
  • 谁负责监听这个事件？或者谁能知道这个事件发生了？服务器上处理用户注册的模块，肯定不会收到你发出新微博的事件。
  • 事件怎么处理？对于发布新微博的事件，就是通知关注了你的其他用户。
  • 事件相关数据是什么？对于发布新微博事件，包含的数据至少要有新微博的内容，时间等。

Yii中与事件相关的类

Yii中，事件是在 yii\base\Component 中引入的，注意， yii\base\Object 不支持事件。所以，当你需要使用事件时，请从 yii\base\Component 进行继承。同时，Yii中还有一个与事件紧密相关的 yii\base\Event ，他封装了与事件相关的有关数据，并提供一些功能函数作为辅助:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
class Event extends Object
{
    public $name;               // 事件名
    public $sender;             // 事件发布者，通常是调用了 trigger() 的对象或类。
    public $handled = false;    // 是否终止事件的后续处理
    public $data;               // 事件相关数据

    private static $_events = [];

    public static function on($class, $name, $handler, $data = null,
        $append = true)
    {
        // ... ...
        // 用于绑定事件handler
    }

    public static function off($class, $name, $handler = null)
    {
        // ... ...
        // 用于取消事件handler绑定
    }

    public static function hasHandlers($class, $name)
    {
        // ... ...
        // 用于判断是否有相应的handler与事件对应
    }

    public static function trigger($class, $name, $event = null)
    {
        // ... ...
        // 用于触发事件
    }
}

事件handler

所谓事件handler就是事件处理程序，负责事件触发后怎么办的问题。从本质上来讲，一个事件handler就是一段php代码，即一个PHP函数。对于一个事件handler，可以是以下的形式提供：

  • 一个PHP全局函数的函数名，不带参数和括号，光秃秃的就一个函数名。如 trim ，注意，不是trim($str) 也不是 trim() 。
  • 一个对象的方法，或一个类的静态方法。如 $person->sayHello() 可以用为事件handler，但要改写成以数组的形式， [$person, ‘sayHello‘] ，而如果是类的静态方法，那应该是[‘namespace\to\Person‘, ‘sayHello‘] 。
  • 匿名函数。如 function ($event) { ... }

但无论是何种方式提供，一个事件handler必须具有以下形式:

function ($event) {
    // $event 就是前面提到的 yii\base\Event
}

也就是只有长得像上面这样的，才可以作为事件handler。

还有一点容易犯错的地方，就是对于类自己的成员函数，尽管在调用 on() 进行绑定时，看着这个handler是有效的，因此，有的小伙伴就写成这样了 $this->on(EVENT_A, ‘publicMethod‘) ，但事实上，这是一个错误的写法。以字符串的形式提供handler，只能是PHP的全局函数。这是由于handler的调用是通过call_user_func() 来实现的。因此，handler的形式，与 call_user_func() 的要求是一致的。这将在 事件的触发 中介绍。

事件的绑定与解除

事件的绑定

有了事件handler，还要告诉Yii，这个handler是负责处理哪种事件的。这个过程，就是事件的绑定， 把事件和事件handler这两个蚂蚱绑在一根绳上，当事件跳起来的时候，就会扯动事件handler啦。

yii\base\Component::on() 就是用来绑定的，很容易就猜到， yii\base\Component::off() 就是用来解除的。对于绑定，有以下形式:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
$person = new Person;

// 使用PHP全局函数作为handler来进行绑定
$person->on(Person::EVENT_GREET, ‘person_say_hello‘);

// 使用对象$obj的成员函数say_hello来进行绑定
$person->on(Person::EVENT_GREET, [$obj, ‘say_hello‘]);

// 使用类Greet的静态成员函数say_hello进行绑定
$person->on(Person::EVENT_GREET, [‘app\helper\Greet‘, ‘say_hello‘]);

// 使用匿名函数
$person->on(Person::EVENT_GREET, function ($event) {
    echo ‘Hello‘;
});

事件的绑定可以像上面这样在运行时以代码的形式进行绑定，也可以在配置中进行绑定。 当然，这个配置生效的过程其实也是在运行时的。原理可以参见 配置项（Configuration） 部分的内容。

上面的例子只是简单的绑定了事件与事件handler，如果有额外的数据传递给handler，可以使用yii\base\Component::on() 的第三个参数。这个参数将会写进 Event 的相关数据字段，即属性 data 。如:

1
2
3
4
5
6
7
 
$person->on(Person::EVENT_GREET, ‘person_say_hello‘, ‘Hello World!‘);

// ‘Hello World!‘ 可以通过 $event访问。
function person_say_hello($event)
{
    echo $event->data;                // 将显示 Hello World!
}

yii\base\Component 维护了一个handler数组，用来保存绑定的handler:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
 
// 这个就是handler数组
private _events = [];

// 绑定过程就是将handler写入_event[]
public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

保存handler的数据结构

从上面代码我们可以了解两个方向的内容，一是 $_event[] 的数据结构，二是绑定handler的逻辑。

从handler数组 $_evnet[] 的结构看，首先他是一个数组，保存了该Component的所有事件handler。 该数组的下标为事件名，数组元素是形为一系列 [$handler, $data] 的数组，如 $_event[]数组的数据结构示意图所示。

技术分享

$_event[]数组的数据结构示意图

在事件的绑定逻辑上，按照以下顺序：

  • 参数 $append 是否为 true 。为 true 表示所要绑定的事件handler要放在 $_event[] 数组的最后面。这也是默认的绑定方式。
  • 参数 $append 是否为 false 。表示handler要放在数组的最前面。这个时候，要多进行一次判定。
  • 如果所有绑定的事件还没有已经绑定好的handler，也就是说，将要绑定的handler是第一个，那么无论$append 是否是 true ，该handler必然是第一个元素，也是最后一个元素。
  • 如果 $append 为 false ，且要绑定的事件已经有了handler，那么，就将新绑定的事件插入到数组的最前面。

handler在 $event[] 数组中的位置很重要，代表的是执行的先后顺序。这个在 多个事件handler的顺序 中会讲到。

事件的解除

在解除时，就是使用 unset() 函数，处理 $_event[] 数组的相应元素。 yii\base\Component::off() 如下所示:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name])) {
        return false;
    }

    // $handler === null 时解除所有的handler
    if ($handler === null) {
        unset($this->_events[$name]);
        return true;
    } else {
        $removed = false;

        // 遍历所有的 $handler
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
        }
        return $removed;
    }
}

要留意以下几点：

  • 当 $handler 为 null 时，表示解除 $name 事件的所有handler。
  • 在解除 $handler 时，将会解除所有的这个事件下的 $handler 。虽然一个handler多次绑定在同一事件上的情况不多见，但这并不是没有，也不是没有意义的事情。在特定的情况下，确实有一个handler多次绑定在同一事件上。因此在解除时，所有的 $handler 都会被解除。而且没有办法只解除其中的一两个。

事件的触发

事件的处理程序handler有了，事件与事件handler关联好了，那么只要事件触发了，handler就会按照设计的路子走。事件的触发，需要调用 yii\base\Component::trigger()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        if ($event === null) {
            $event = new Event;
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;

        // 遍历handler数组，并依次调用
        foreach ($this->_events[$name] as $handler) {
            $event->data = $handler[1];

            // 使用PHP的call_user_func调用handler
            call_user_func($handler[0], $event);

            // 如果在某一handler中，将$evnet->handled 设为true，
            // 就不再调用后续的handler
            if ($event->handled) {
                return;
            }
        }
    }
    Event::trigger($this, $name, $event);   // 触发类一级的事件
}

以 yii\base\Application 为例，他定义了两个事件， EVENT_BEFORE_REQUEST EVENT_AFTER_REQUEST 分别在处理请求的前后触发:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
abstract class Application extends Module
{
    // 定义了两个事件
    const EVENT_BEFORE_REQUEST = ‘beforeRequest‘;
    const EVENT_AFTER_REQUEST = ‘afterRequest‘;

    public function run()
    {
        try {

            $this->state = self::STATE_BEFORE_REQUEST;

            // 先触发EVENT_BEFORE_REQUEST
            $this->trigger(self::EVENT_BEFORE_REQUEST);

以上是关于yii2.0 事件的主要内容，如果未能解决你的问题，请参考以下文章

Yii2.0 事件的简单用法

Yii2.0源码阅读-behavior的实现原理

Android 事件分发事件分发源码分析 ( Activity 中各层级的事件传递 | Activity -＞ PhoneWindow -＞ DecorView -＞ ViewGroup )(代码片段

Yii系列Yii2.0的安装与调试

Yii2.0 手动添加扩展 redis为例

如何使用yii2开发