tp6事件的用法

新版的事件系統可以看成是5.1版本行爲系統的升級版，事件系統相比行爲系統強大的地方在於事件本身可以是一個類，並且可以更好的支持事件訂閱者。

事件相比較中間件的優勢是事件比中間件更加精準定位（或者說粒度更細），並且更適合一些業務場景的擴展。例如，我們通常會遇到用戶註冊或者登錄後需要做一系列操作，通過事件系統可以做到不侵入原有代碼完成登錄的操作擴展，降低系統的耦合性的同時，也降低了BUG的可能性。

事件系統的所有操作都通過think\facade\Event類進行靜態調用

定義事件

事件系統使用了觀察者模式，提供瞭解耦應用的更好方式。在你需要監聽事件的位置，例如下面我們在用戶完成登錄操作之後添加如下事件觸發代碼：

// 觸發UserLogin事件 用於執行用戶登錄後的一系列操作
Event::trigger('UserLogin');

或者使用助手函數

event('UserLogin');

這裏UserLogin表示一個事件標識，如果你定義了單獨的事件類，你可以使用事件類名（甚至可以傳入一個事件類實例）。

// 直接使用事件類觸發
event('app\event\UserLogin');

事件類可以通過命令行快速生成

php think make:event UserLogin

默認會生成一個app\event\UserLogin事件類，也可以指定完整類名生成。

我們可以給事件類添加方法

namespace app\event;

use app\model\User;

class UserLogin
{
    public $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }
}

一般事件類無需繼承任何其它類。

你可以給事件類綁定一個事件標識，一般建議直接在應用的event.php事件定義文件中批量綁定。

return [
    'bind'    =>    [
        'UserLogin' => 'app\event\UserLogin',
        // 更多事件綁定
    ],
];

如果你需要動態綁定，可以使用

Event::bind(['UserLogin' => 'app\event\UserLogin']);

ThinkPHP的事件系統不依賴事件類，如果沒有額外的需求，僅通過事件標識也可以使用，省去定義事件類的麻煩。

如果你沒有定義事件類的話，則無需綁定。對於大部分的場景，可能確實不需要定義事件類。

你可以在event方法中傳入一個事件參數

// user是當前登錄用戶對象實例
event('UserLogin', $user);

事件監聽

你可以手動註冊一個事件監聽

Event::listen('UserLogin', function($user) {
    // 
});

或者使用監聽類來執行監聽

Event::listen('UserLogin', 'app\listener\UserLogin');

可以通過命令行快速生成一個事件監聽類

php think make:listener UserLogin

默認會生成一個app\listener\UserLogin事件監聽類，也可以指定完整類名生成。

事件監聽類只需要定義一個handle方法，支持依賴注入。

<?php
namespace app\listener;

class UserLogin
{
    public function handle($user)
    {
        // 事件監聽處理
    }   
}

在handle方法中如果返回了false，則表示監聽中止，將不再執行該事件後面的監聽。

一般建議直接在事件定義文件中定義對應事件的監聽。

return [
    'bind'    =>    [
        'UserLogin' => 'app\event\UserLogin',
        // 更多事件綁定
    ],
    'listen'  =>    [
        'UserLogin'    =>    ['app\listener\UserLogin'],
        // 更多事件監聽
    ],
];

事件訂閱

可以通過事件訂閱機制，在一個監聽器中監聽多個事件，例如通過命令行生成一個事件訂閱者類，

php think make:subscribe User

默認會生成app\subscribe\User類，或者你可以指定完整類名生成。

然後你可以在事件訂閱類中添加不同事件的監聽方法，例如。

<?php
namespace app\subscribe;

class User
{
    public function onUserLogin($user)
    {
        // UserLogin事件響應處理
    }

    public function onUserLogout($user)
    {
        // UserLogout事件響應處理
    }
}

監聽事件的方法命名規範是on+事件標識（駝峯命名），如果希望統一添加事件前綴標識，可以定義eventPrefix屬性。

<?php
namespace app\subscribe;

class User
{
    protected $eventPrefix = 'User';

    public function onLogin($user)
    {
        // UserLogin事件響應處理
    }

    public function onLogout($user)
    {
        // UserLogout事件響應處理
    }
}

如果希望自定義訂閱方式（或者方法規範），可以定義subscribe方法實現。

<?php
namespace app\subscribe;

use think\Event;

class User
{
    public function onUserLogin($user)
    {
        // UserLogin事件響應處理
    }

    public function onUserLogout($user)
    {
        // UserLogout事件響應處理
    }

    public function subscribe(Event $event)
    {
        $event->listen('UserLogin', [$this,'onUserLogin']);
        $event->listen('UserLogout',[$this,'onUserLogout']);
    }
}

然後在事件定義文件註冊事件訂閱者

return [
    'bind'    =>    [
        'UserLogin' => 'app\event\UserLogin',
        // 更多事件綁定
    ],
    'listen'  =>    [
        'UserLogin'    =>    ['app\listener\UserLogin'],
        // 更多事件監聽
    ],
    'subscribe'    =>    [
       'app\subscribe\User',
        // 更多事件訂閱
    ],
];

如果需要動態註冊，可以使用

Event::subscribe('app\subscribe\User');

內置事件

內置的系統事件包括：

事件	描述	參數
AppInit	應用初始化標籤位	無
HttpRun	應用開始標籤位	無
HttpEnd	應用結束標籤位	當前響應對象實例
LogWrite	日誌write方法標籤位	當前寫入的日誌信息
RouteLoaded	路由加載完成	無

AppInit事件定義必須在全局事件定義文件中定義，其它事件支持在應用的事件定義文件中定義。

原來5.1的一些行爲標籤已經廢棄，所有取消的標籤都可以使用中間件更好的替代。可以把中間件看成處理請求以及響應輸出相關的特殊事件。事實上，中間件的handler方法只是具有特殊的參數以及返回值而已。

數據庫操作的回調也稱爲查詢事件，是針對數據庫的CURD操作而設計的回調方法，主要包括：

事件	描述
before_select	select查詢前回調
before_find	find查詢前回調
after_insert	insert操作成功後回調
after_update	update操作成功後回調
after_delete	delete操作成功後回調

查詢事件的參數就是當前的查詢對象實例。

模型事件包含：

鉤子	對應操作
after_read	查詢後
before_insert	新增前
after_insert	新增後
before_update	更新前
after_update	更新後
before_write	寫入前
after_write	寫入後
before_delete	刪除前
after_delete	刪除後

before_write和after_write事件無論是新增還是更新都會執行

實際項目案例代碼：完整項目 http://github.crmeb.net/u/lingting 開源項目，使用TP6框架開發的

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2018 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <[email protected]>
// +----------------------------------------------------------------------

// 事件定義文件
return [
    'bind'      => [

    ],

    'listen'    => [
        'AppInit'  => [],
        'HttpRun'  => [],
        'HttpEnd'  => [],
        'LogLevel' => [],
        'LogWrite' => [],
        'task_2'=>[],//2秒鐘執行的方法
        'task_6'=>[],//6秒鐘執行的方法
        'task_10'=>[],//10秒鐘執行的方法
        'task_30'=>[],//30秒鐘執行的方法
        'task_60'=>[],//60秒鐘執行的方法
        'task_180'=>[],//180秒鐘執行的方法
        'task_300'=>[],//300秒鐘執行的方法
        'StoreProductOrderDeliveryAfter' => [], // OrderSubscribe 送貨 發送模板消息 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderDeliveryGoodsAfter' => [], // OrderSubscribe 發貨 發送模板消息 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderRefundNAfter' => [], // OrderSubscribe 訂單狀態不退款 發送模板消息 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderOffline' => [], // OrderSubscribe 線下付款成功後 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderEditAfter' => [], // OrderSubscribe 修改訂單金額 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderDistributionAfter' => [], // OrderSubscribe 修改配送信息 admin模塊 order.StoreOrder控制器/order.combinationOrder控制器
        'StoreProductOrderOver' => [], // OrderSubscribe 訂單全部產品評價完  models模塊 store.StoreOrder Model
        'StoreOrderRegressionAllAfter' => [], // OrderSubscribe 回退所有  未支付和已退款的狀態下才可以退積分退庫存退優惠券  models模塊 store.StoreOrder Model
        'AdminVisit' => [], // SystemSubscribe 添加管理員訪問記錄 admin模塊 AuthController控制器
        'SystemAdminLoginAfter' => [], // SystemSubscribe 添加管理員最後登錄時間和ip 添加管理員訪問記錄 admin模塊 system.SystemAdmin控制器
        'StoreProductSetCartAfter' => [], // ProductSubscribe 加入購物車成功之後  wap模塊 AuthApi控制器
        'StoreProductUserOperationConfirmAfter' => [], // ProductSubscribe 用戶操作產品添加事件  用戶點贊產品  用戶收藏產品 Models模塊 store.StoreProductRelation Model
        'StoreProductUserOperationCancelAfter' => [], // ProductSubscribe 用戶操作產品取消事件  用戶取消點贊產品  用戶取消收藏產品 Models模塊 store.StoreProductRelation Model
        'WechatMaterialAfter' => [], // MaterialSubscribe 微信公衆號 圖片/聲音 轉media 存入數據庫  admin模塊 wechat.WechatReplyModel
        'WechatMessageBefore' => [], // MessageSubscribe 微信消息前置操作  crmeb\services\WechatService
        'WechatEventUnsubscribeBefore' => [], // MessageSubscribe 用戶取消關注公衆號前置操作  crmeb\services\WechatService
        'WechatOauthAfter' => [], // UserSubscribe 微信授權成功後  wap模塊 WapBasic控制器
        'InitLogin' => [], // UserSubscribe 微信授權成功後  ebapi模塊 Basic控制器
        'UserLevelAfter' => [], // UserSubscribe 檢查是否能成爲會員  models模塊 user.UserSign Model  store.StoreOrder Model user.UserBill Model
        'OrderCreated' => [], //用戶訂單創建成功
        'OrderPaySuccess' => [], //用戶訂單支付成功
        'OrderCreateAgain' => [], //用戶再次下單
        'UserOrderRemoved' => [], //用戶刪除訂單
        'UserOrderTake' => [], //用戶確認收貨
        'UserCommented' => [], //用戶評價商品
        'RechargeSuccess' => [], //用戶充值成功後
        'ImportNowMoney' => [], //用戶佣金轉成餘額成功後
    ],

    'subscribe' => [
        crmeb\subscribes\SystemSubscribe::class,
        crmeb\subscribes\OrderSubscribe::class,
        crmeb\subscribes\ProductSubscribe::class,
        crmeb\subscribes\UserSubscribe::class,
        crmeb\subscribes\MaterialSubscribe::class,
        crmeb\subscribes\MessageSubscribe::class,
        crmeb\subscribes\TaskSubscribe::class,
    ],
];