事件(Event)

如何定义事件?

事件系统的所有操作都通过thinkfacadeEvent类进行静态调用

事件系统使用了观察者模式(可参考PHP设计模式)，提供了解耦应用的更好方式。

在你需要监听事件的位置，例如下面我们在用户完成登录操作之后添加如下事件触发代码：

// 触发UserLogin事件 用于执行用户登录后的一系列操作
Event::trigger('UserLogin');

这里UserLogin表示一个事件标识，如果你定义了单独的事件类，你可以使用事件类名（甚至可以传入一个事件类实例）。

// 直接使用事件类触发
event('app\event\UserLogin');

事件类可以通过命令行快速生成

php think make:event UserLogin

默认会生成一个appeventUserLogin事件类，也可以指定完整类名生成。

我们可以给事件类添加方法

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

默认会生成一个applistenerUserLogin事件监听类，也可以指定完整类名生成。

事件监听类只需要定义一个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

默认会生成appsubscribeUser类，或者你可以指定完整类名生成。

然后你可以在事件订阅类中添加不同事件的监听方法，例如。

<?php
namespace app\subscribe;

class User
{
    public function onUserLogin($user)
    {
        // UserLogin事件响应处理
    }

    public function onUserLogout($user)
    {
        // UserLogout事件响应处理
    }
}

监听事件的方法命名规范是on+事件标识（驼峰命名），然后在事件定义文件注册事件订阅者。

return [
    'bind'    =>    [
        'UserLogin' => 'app\event\UserLogin',
        // 更多事件绑定
    ],
    'listen'  =>    [
        'UserLogin'    =>    ['app\listener\UserLogin'],
        // 更多事件监听
    ],
    'subscribe'    =>    [
       'app\subscribe\User',
        // 更多事件订阅
    ],
];

如果希望统一添加事件前缀标识，可以定义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']);
    }
}

如果需要动态注册，可以使用

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

内置事件

内置的系统事件包括：

AppInit事件定义必须在全局事件定义文件中定义，其它事件支持在应用的事件定义文件中定义。

原来5.1的一些行为标签已经废弃，所有取消的标签都可以使用中间件更好的替代。可以把中间件看成处理请求以及响应输出相关的特殊事件。事实上，中间件的handler方法只是具有特殊的参数以及返回值而已。

数据库操作的回调也称为查询事件，是针对数据库的CURD操作而设计的回调方法，主要包括：

查询事件的参数就是当前的查询对象实例。

模型事件包含：