## **说明** >[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] 模型事件方法的参数就是当前的模型对象实例。