事件机制

    事件模式是一种经过了充分测试的可靠机制,是一种非常适用于解耦的机制,分别存在以下 3 种角色:

    • 监听器(Listener) 是用于监听 事件(Event) 的发生的监听对象
    • 事件调度器(EventDispatcher) 是用于触发 事件(Event) 和管理 监听器(Listener)事件(Event) 之间的关系的管理者对象

    用通俗易懂的例子来说明就是,假设我们存在一个 UserService::register() 方法用于注册一个账号,在账号注册成功后我们可以通过事件调度器触发 UserRegistered 事件,由监听器监听该事件的发生,在触发时进行某些操作,比如发送用户注册成功短信,在业务发展的同时我们可能会希望在用户注册成功之后做更多的事情,比如发送用户注册成功的邮件等待,此时我们就可以通过再增加一个监听器监听 UserRegistered 事件即可,无需在 UserService::register() 方法内部增加与之无关的代码。

    1. <?php
    2. namespace App\Event;
    3. class UserRegistered
    4. {
    5. // 建议这里定义成 public 属性,以便监听器对该属性的直接使用,或者你提供该属性的 Getter
    6. public function __construct($user)
    7. {
    8. $this->user = $user;
    9. }
    10. }

    监听器都需要实现一下 Hyperf\Event\Contract\ListenerInterface 接口的约束方法,示例如下。

    通过配置文件注册监听器

    在定义完监听器之后,我们需要让其能被 事件调度器(Dispatcher) 发现,可以在 config/autoload/listeners.php 配置文件 (如不存在可自行创建) 内添加该监听器即可,监听器的触发顺序根据该配置文件的配置顺序:

    1. return [
    2. ];

    在通过注解注册监听器时,我们可以通过设置 priority 属性定义当前监听器的顺序,如 @Listener(priority=1) ,底层使用 SplPriorityQueue 结构储存,priority 数字越大优先级越高。