event事件處理

webman/event 提供一種精巧的事件機制，可實現在不侵入代碼的情況下執行一些業務邏輯，使業務模組之間達到解耦。典型的場景如一個新用戶註冊成功時，只要發布一個自定義事件如user.register，各個模組便能收到該事件執行相應的業務邏輯。

安裝

composer require webman/event

訂閱事件

訂閱事件統一通過文件config/event.php來配置

<?php
return [
    'user.register' => [
        [app\event\User::class, 'register'],
        // ...其它事件處理函數...
    ],
    'user.logout' => [
        [app\event\User::class, 'logout'],
        // ...其它事件處理函數...
    ]
];

說明：

user.register user.logout 等是事件名稱，字符串類型，建議小寫單詞並以點(.)分割
一個事件可以對應多個事件處理函數，調用順序為配置的順序

事件處理函數

事件處理函數可以是任意的類方法、函數、閉包函數等。
例如創建事件處理類 app/event/User.php (目錄不存在請自行創建)

<?php
namespace app\event;
class User
{
    function register($user)
    {
        var_export($user);
    }

    function logout($user)
    {
        var_export($user);
    }
}

發布事件

使用 Event::dispatch($event_name, $data); 或 Event::emit($event_name, $data); 發布事件，例如

<?php
namespace app\controller;
use support\Request;
use Webman\Event\Event;
class User
{
    public function register(Request $request)
    {
        $user = [
            'name' => 'webman',
            'age' => 2
        ];
        Event::dispatch('user.register', $user);
    }
}

發布事件有兩個函數，Event::dispatch($event_name, $data); 和 Event::emit($event_name, $data); 二者參數一樣。
區別在於 emit 內部會自動捕獲異常，也就是說如果一個事件有多個處理函數，某個處理函數發生異常不會影響其它處理函數的執行。
而 dispatch 則內部不會自動捕獲異常，當前事件的任何一個處理函數發生異常，則停止執行下一個處理函數並直接向上拋出異常。

提示
參數$data 可以是任意的數據，例如數組、類實例、字符串等

通配符事件監聽

通配符註冊監聽允許您在同一個監聽器上處理多個事件，例如config/event.php裡配置

<?php
return [
    'user.*' => [
        [app\event\User::class, 'deal']
    ],
];

我們可以透過事件處理函數第二個參數$event_data獲得具體的事件名

<?php
namespace app\event;
class User
{
    function deal($user, $event_name)
    {
        echo $event_name; // 具體的事件名，如 user.register user.logout 等
        var_export($user);
    }
}

停止事件廣播

當我們在事件處理函數裡返回false時，該事件將停止廣播

閉包函數處理事件

事件處理函數可以是類方法，也可以是閉包函數例如

<?php
return [
    'user.login' => [
        function($user){
            var_dump($user);
        }
    ]
];

查看事件及監聽器

使用命令 php webman event:list 查看專案配置的所有事件及監聽器

支持範圍

除了主專案基礎插件和應用插件同樣支持 event.php 配置。
基礎插件配置文件 config/plugin/插件廠商/插件名/event.php
應用插件配置文件 plugin/插件名/config/event.php

注意事項

event事件處理並不是異步的，event不適合處理慢業務，慢業務應該用消息隊列處理，例如webman/redis-queue