ZF3 EventManager 简介

EventManager 简称 事件管理器.

创建一个能生成 EventManager 的类来做测试

use Zend\EventManager\EventManagerInterface;
use Zend\EventManager\EventManager;
use Zend\EventManager\EventManagerAwareInterface;
​
class Foo implements EventManagerAwareInterface
{
    protected $events;
​
    public function setEventManager(EventManagerInterface $events)
    {
        $events->setIdentifiers([
            __CLASS__,
            get_called_class(),
        ]);
        $this->events = $events;
        return $this;
    }
​
    public function getEventManager()
    {
        if (null === $this->events) {
            $this->setEventManager(new EventManager());
        }
        return $this->events;
    }
}

上面定义的类中, 调用 setEventManager() 方法可以使用指定 EventManager 的实例. 如果没有先调用 setEventManager() 方法, 任何人都可以调 getEventManager() 方法也可以获取到 EventManager 的实例.

使用 EventManager 触发一个事件, 最简单的方法是通过 trigger() 方法触发. 并且带以下三个参数.

• 事件名字: 通常使用当前的函数或者方法名. 比如: FUNCTION
• 事件目标: 通常是用当前的对象实例.
• 事件参数: 要传入给事件监听者的参数.

添加一个事件触发方法

参考下面的一段代码, 我们在刚才的类中添加一个方法. 方法内执行触发一个事件.

class Foo
{
    // ... 之前的代码块
​
    public function bar($baz, $bat = null)
    {
        //更多的 compact: http://php.net/manual/zh/function.compact.php
        $params = compact('baz', 'bat'); // 相当于 $params = ['baz' => $baz, 'bat' => $bat]; 
        $this->getEventManager()->trigger(__FUNCTION__, $this, $params);
    }
}

创建一个事件接收代码

上面我们添加了一个方法 bar(), 只要调用这个方法, 就会触发 bar 事件.
我们重写一个程序, 来测试监听发出的事件.
要监听EventManager 触发的事件, 需要使用 EventManager 对象的 attach() 方法先注册监听器.

注册监听器我们提供3个参数如下:

事件名字: 这个监听器要监听的事件名称.
事件处理函数: 这里是任何一个PHP的回调函数均可, 简单的可以使用匿名函数. 这个回调函数接收一个 Zend\EventManager\Event 实例, 这个实例可以获取到事件的名字, 对象, 和参数信息.
监听器优先级: 同一个事件可以注册多个监听器, 优先级高的优先处理, 整型数字.

测试代码:

use Zend\Log\Factory as LogFactory;
​
$log = LogFactory($someConfig);
$foo = new Foo();
$foo->getEventManager()->attach('bar', function ($e) use ($log) {
    $event  = $e->getName();
    $target = get_class($e->getTarget());
    $params = json_encode($e->getParams());
​
    $log->info(sprintf(
        '对象: %s 的 %s 方法被执行, 并带了参数: %s',
        $target,
        $event,
        $params
    ));
});
​
$foo->bar('hello', 'world'); //触发 $foo 对象的 bar 事件

上面的代码会输出:

对象: Foo 的 bar 方法被执行, 并带了参数: {"baz" : "hello", "bat" : "world"}

bar方法内只是触发了一个事件, 切勿以为是进入了死循环模式, trigger()只是执行了一个广播机制.

上面的测试代码可以看出, 一个 EventManager 实例要触发事件, 需要提前在这个EventManager的实例上进行监听器的绑定. 否则是不能够得到回应. 因为 EventManager 类并没有使用单例设计模式, 每一个 Foo 实例可以有自己的一个 EventManager 实例.

然而对于事件的响应, 通常设计在不同的类中的特定的响应方法. 并且会在系统的某个挂载点或者某个启动阶段统一完成注册. 如果按上面的模式, 那么在这个挂载点或者启动阶段就要完成这个 Foo 对象的实例化, 然而这个阶段我们并不需要 Foo 实例化, 实例化仅仅是因为要提前注册监听器.

显然这样的需求和 EventManager 的设计不匹配, 解决方案就是我们需要一个共享的 EventManager, 系统在启动之初就先生成一个 EventManager 实例, 然后所有的监听器注册到这个实例中, 然后在需要 EventManager 的地方, 将这个共享的 EventManager 传递过去. 这个在当前ZF3系统中, 我们称为 SharedEventManager

使用 SharedEventManager 绑定监听器和 EventManager 绑定监听器的方法一样, 都是使用 attach() 方法. 唯一不同的区别是比之前的多的一个参数, 新多出的参数放在第一个参数位置. 通常我们把这个参数设置为要监听的某个class的名字.

特别需要注意的是在 setEventManager() 方法中, 我们有个对 EventManager 实例做身份登记的动作. $event->setIdentifiers() 接口会登记这个 EventManager 实例下的身份ID, 一个 EventManager 的实例下是可以登记很多身份ID的. 另外再次看这个 $event->setIdentifiers() 方法调用的时候我们传入了2个参数, 其实都是指向了当前的 class 名字. 这2个其实就是2个身份ID, 这2个身份ID做什么用途呢? 其实就是为了上面提到的 SharedEventManager 服务的. 在 EventManager 触发事件的时候. 如果系统中存在 SharedEventManager, 那么会把 SharedEventManager 实例中注册的监听器一并提取出来执行, 但是如何提取出来呢? 我们在前一部分中说道 SharedEventManager 实例注册监听器的时候多了一个参数, 这个参数值就是一个身份ID, EventManager 实例中注册的身份ID到 SharedEventManager 实例中的注册的身份ID进行匹配, 有同样的就可以提取出来作为一个正式的监听器进行触发.

使用SharedEventManager 来监听事件.

我们先假设已经有了一个 SharedEventManager 实例, 测试下面的代码:

use Zend\Log\Factory as LogFactory;
​
// 假设 $sharedEvents 是 Zend\EventManager\SharedEventManager 的一个实例
​
$log = LogFactory($someConfig);
$sharedEvents->attach('Foo', 'bar', function ($e) use ($log) {
    $event  = $e->getName();
    $target = get_class($e->getTarget());
    $params = json_encode($e->getParams());
​
    $log->info(sprintf(
        '类 %s 的方法 %s 被执行, 附带的参数 %s',
        $target,
        $event,
        $params
    ));
});

//...

//所有其他业务设置完毕, 实例化事件对象, 准备触发
$eventManager = new EventManager($sharedEvents, []);
$foo = new Foo();
$foo->setEventManager($eventManager);
​
//执行触发
$foo->bar('Hello', 'Baby');

执行结果会是:

类 Foo 的方法 bar 被执行, 附带的参数{"baz" : "Hello", "bat" : "Baby"}