## 事件調度 (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); ~~~