## 事件调度 (Event) 事件调度基于 [PSR-14](https://www.php-fig.org/psr/psr-14/) 标准实现。 ## 组件 使用 [composer]([https://www.phpcomposer.com/](https://www.phpcomposer.com/)) 安装： ~~~ composer require mix/event ~~~ ## 基础 事件调度实现基于 [PSR-14](https://www.php-fig.org/psr/psr-14/)： - 事件(Event)：一个自定义类，事件数据的载体 - 监听器(Listener)：实现 Mix\Event\ListenerInterface 接口的一个类 [[例]](https://github.com/mix-php/mix-skeleton/blob/master/app/Common/Listeners/DatabaseListener.php)，负责处理对应的事件数据 - 事件调度器(EventDispatcher)：用于触发某个事件 ## 定义一个事件 事件可以为任意类，本次我们以 mix/databese 内的 SQL 执行事件调度来举例： > Mix 的 databese、redis 库的执行日志都基于 event 事件驱动实现 ~~~ <?php namespace Mix\Database\Event; /** * Class ExecuteEvent * @package Mix\Database\Event * @author liu,jian <coder.keda@gmail.com> */ class ExecuteEvent { /** * @var string */ public $sql = ''; /** * @var array */ public $bindings = []; /** * @var float */ public $time = 0; /** * @var string|null */ public $error; } ~~~ ## 定义一个监听器 监听器是用户编写处理事件逻辑代码的地方，`events` 方法返回一个要监听的事件类的数组，当这些事件触发时，会调用 `process` 方法： ~~~ <?php namespace App\Common\Listeners; use Mix\Database\Event\ExecuteEvent; use Mix\Event\ListenerInterface; /** * Class DatabaseListener * @package App\Common\Listeners * @author liu,jian <coder.keda@gmail.com> */ class DatabaseListener implements ListenerInterface { /** * 监听的事件 * @return array */ public function events(): array { // TODO: Implement events() method. // 要监听的事件数组，可监听多个事件 return [ ExecuteEvent::class, ]; } /** * 处理事件 * @param object $event * @return mixed|void */ public function process(object $event) { // TODO: Implement process() method. // 事件触发后，会执行该方法 } } ~~~ ## 注册监听器 用户编写的监听器需要注册到调度程序中方能执行，因此需要在 [manifest/beans/event](https://github.com/mix-php/mix-skeleton/blob/master/manifest/beans/event.php) 的 \\Mix\\Event\\EventDispatcher::class 类的依赖配置中注册： ~~~ // 事件调度器 [ // 作用域 'scope' => \Mix\Bean\BeanDefinition::SINGLETON, // 类路径 'class' => \Mix\Event\EventDispatcher::class, // 构造函数注入 'constructorArgs' => [ \App\Common\Listeners\DatabaseListener::class, \App\Common\Listeners\RedisListener::class, ], ], ~~~ ## 触发事件 如果是用户自己定义的事件，需要用户自己触发： ~~~ $dispatcher = context()->get(\Mix\Event\EventDispatcher::class); $event = new Event(); $dispatcher->dispatch($event); ~~~ 本次范例是 mix/databese 库定义的事件，所以是在该库的代码中触发： ~~~ $event = new ExecutedEvent(); $event->sql = $sql; $event->bindings = $bindings; $event->time = $time; $event->error = $error; $this->dispatcher->dispatch($event); ~~~