## **說明** >[danger] 事件相比較中間件的優勢是事件比中間件更加精準定位（或者說粒度更細），并且更適合一些業務場景的擴展。例如，我們通常會遇到用戶注冊或者登錄后需要做一系列操作 >事件的作用是在某個代碼中間插入新的或者擴展的業務邏輯代碼 而不必改變原有的代碼 > 事件系統的所有操作都通過`think\facade\Event`類進行靜態調用 >`V6.0.3+`版本開始，事件機制不能關閉 ## **步驟** 1，需要聲明一個UserLogin事件類 2，還有可能需要綁定這個事件，第一步<b style="color:blue">未</b>申明UserLogin事件類則<b style="color:blue">無</b>需綁定 3，注冊監聽這個事件， 4，在需要的地方觸發這個事件， 事件綁定以后就可以用了 為什么還要監聽和訂閱？事件綁定只能綁定一個事件，但是如果監聽 一個事件可以有多個監聽 事件監聽與事件訂閱 有什么本質區別? 事件監聽 只能監聽某個事件 事件訂閱 可以訂閱（監聽）多個事件； 訂閱事件必須配置相關listen后才能觸發 ## **定義事件類(可選)**：(只能監聽單個事件) ~~~ namespace app\event; use app\model\User; class UserLogin { public $user; public function __construct(User $user) { $this->user = $user; } } ~~~ >[danger]ThinkPHP的事件系統不依賴事件類，如果沒有額外的需求，僅通過事件標識也可以使用，省去定義事件類的麻煩 ## **將事件類綁定一個標識（可選）** ~~~ //動態綁定,不推薦一般推薦在app/應用（如：admin）/event.php里靜態綁定 Event::bind(['UserLogin' => 'app\event\UserLogin']); //靜態綁定在應用下的event.php 好處是方便統一管理 return [ 'bind' => [ 'UserLogin' => 'app\admin\event\UserLogin', // 更多事件綁定 ], ]; ~~~ >[danger]如果你沒有定義事件類的話，則無需綁定。對于大部分的場景，可能確實不需要定義事件類。 bind可有可無，可以看成是一個別名，官方文檔這樣寫會讓讓產生誤解 'bind' => \[ 'U' => 'UserLogin', // 更多事件綁定 \], 'listen' => \[ 'UserLogin' => \['app\\listener\\UserLogin'\], // 更多事件監聽 \] 那么調用event('UserLogin');或者event('U')都可以 監聽和訂閱不一定非要同時存在 ## **觸發事件** >[danger]參數可以傳自定義的事件標識或者一個帶命名空間的完整的類 事件系統使用了觀察者模式，提供了解耦應用的更好方式。在你需要監聽事件的位置，例如下面我們在用戶完成登錄操作之后添加如下事件觸發代碼： ~~~ // 觸發UserLogin事件 用于執行用戶登錄后的一系列操作 Event::trigger('UserLogin'); // 直接使用事件類觸發,上面的`UserLogin`表示一個事件標識，如果你定義了單獨的事件類，你可以使用事件類名（甚至可以傳入一個事件類實例） Event::trigger('app\admin\event\UserLogin'); //或者使用助手函數 event('UserLogin'); // 直接使用事件類觸發 event('app\admin\event\UserLogin'); //tp6的事件系統不依賴事件類，如果你沒有定義線面的事件類則可以通過傳入自定義標識與數據即可 // user是當前登錄用戶對象實例 定義后成為事件監聽類的handle方法的一個參數 event('UserLogin', $user); //如果是定義了事件類，可以直接傳入事件對象實例 event(new UserLogin($user)); ~~~ ## **事件監聽** ~~~ //方法1：手動注冊一個事件監聽 Event::listen('UserLogin', function($user) { // }); //方法2：使用監聽類來執行監聽 Event::listen('UserLogin', 'app\listener\UserLogin'); //方法3：不推薦上面的方法來監聽，一般使用app/應用（如：admin）/event.php里配置監聽 return [ 'bind' => [ 'UserLogin' => 'app\event\UserLogin', // 更多事件綁定 ], 'listen' => [ 'UserLogin' => ['app\listener\UserLogin'], // 更多事件監聽 ], ]; //使用監聽類監聽那么就必須要有個監聽類 app\admin\listener\UserLogin.php namespace app\admin\listener; class UserLogin { //監聽類必須要申明一個handle類,此方法支持依賴注入 //在`handle`方法中如果返回了`false`，則表示監聽中止，將不再執行該事件后面的監聽 public function handle($user) { // 事件監聽處理 } } ~~~ `V6.0.9+`版本開始，事件監聽可以支持通配符，例如： ~~~ // 監聽所有的模型事件 Event::listen('model.*', 'app\listener\ModelListen'); ~~~ >可以通過命令行`php think make:listener UserLogin`快速生成一個事件監聽類,默認會生成一個`app\listener\UserLogin`事件監聽類，也可以指定完整類名生成 >單個事件監聽完結撒花！ ## **事件訂閱：(可監聽多個事件)** >[danger]上面的例子一個監聽器只能監聽一個事件，監聽多個事件則需要下面的時間訂閱機制 >app\admin\subscribe\User.php中監聽事件 監聽事件的方法命名規范是`on`+事件標識（駝峰命名） ``` <?php namespace app\admin\subscribe; class User { //如果希望統一添加事件前綴標識，可以定義`eventPrefix`屬性。 protected $eventPrefix = 'User'; public function onUserLogin($user) { // UserLogin事件響應處理 } public function onUserLogout($user) { // UserLogout事件響應處理 } } ``` >可以通過命令行`php think make:subscribe User`生成一個事件訂閱者類,默認會生成`app\subscribe\User`類，或者你可以指定完整類名生成。 如果希望自定義訂閱方式（或者方法規范），可以定義`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']); } } 所以可知： 監聽多個事件有兩種方法 1.event.php定義文件里面配置 'UserLogin'=> \['app\\listener\\UserLogin','app\\istener\\Email'\] 2.訂閱里面 $event->listen('UserLogin', \[$this,'onUserLogin'\]); $event->listen('UserLogin',\[$this,'onEmail'\]); ~~~ 然后在事件定義文件的'subscribe'注冊事件訂閱者 ## **監聽事件** 事件定義文件 ~~~ //方法1：動態監聽不推薦 Event::subscribe('app\admin\subscribe\User'); //方法2：推薦在app/應用（如：admin）/event.php里配置監聽 return [ 'bind' => [ 'UserLogin' => 'app\event\UserLogin', // 更多事件綁定 ], 'listen' => [ 'UserLogin' => ['app\listener\UserLogin'], // 更多事件監聽 ], 'subscribe' => [ 'app\admin\subscribe\User', // 更多事件訂閱 ], ]; ~~~ ## **內置事件** | 事件 | 描述 | 參數 | | --- | --- | --- | | AppInit | 應用初始化標簽位（此事件必須在全局事件定義文件app/event.php中定義） | 無 | | HttpRun | 應用開始標簽位 | 無 | | HttpEnd | 應用結束標簽位 | 當前響應對象實例 | | LogWrite | 日志write方法標簽位 | 當前寫入的日志信息 | | RouteLoaded | 路由加載完成 | 無 | |LogRecord日志記錄|V6.0.8+|無| >[danger]`AppInit`事件定義必須在全局事件定義文件中定義，其它事件支持在應用的事件定義文件中定義。 ## **數據庫查詢事件** >[info]數據庫操作的回調也稱為查詢事件，是針對數據庫的CURD操作而設計的回調方法，主要包括： | 事件 | 描述 | | --- | --- | | before\_select | `select`查詢前回調 | | before\_find | `find`查詢前回調 | | after\_insert | `insert`操作成功后回調 | | after\_update | `update`操作成功后回調 | | after\_delete | `delete`操作成功后回調 | > [info]查詢事件的參數就是當前的查詢對象實例。 ## **模型事件包含：** | 鉤子 | 對應操作 | | --- | --- | | after\_read | 查詢后 | | before\_insert | 新增前 | | after\_insert | 新增后 | | before\_update | 更新前 | | after\_update | 更新后 | | before\_write | 寫入前 | | after\_write | 寫入后 | | before\_delete | 刪除前 | | after\_delete | 刪除后 | >[warning]`before_write`和`after_write`事件無論是新增還是更新都會執行。 >[info] 模型事件方法的參數就是當前的模型對象實例。