laravel 事件/监听器实例

导语

上一篇文章实现了记录用户访问，设计上是有缺陷的，代码紧耦合在中间件。如果后续修改需求，不仅记录 ip、城市，还需要记录数据到新的数据表，或者需要进行其它统计，那么不停的增加、修改代码是不合理的。这个时候可以使用 Laravel 的事件/监听器进行处理。代码可查看 GitHub。

事件/监听器

Laravel 事件提供了简单的观察者模式实现，允许你订阅和监听应用中的事件。

观察者模式有时也被称作发布/订阅模式，该模式用于为对象实现发布/订阅功能：一旦主体对象状态发生改变，与之关联的观察者对象会收到通知，并进行相应操作。

以上是事件/监听器、观察者模式的简要说明。结合这次的需求理解，当触发用户访问事件，它的观察者进行处理。观察者可以是多个，本例仅做入库操作。

创建事件/监听器

在 app/Providers/EventServiceProvider.php 文件中添加事件/监听器，如下

 /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            SendEmailVerificationNotification::class,
        ],
        'App\Events\UserBrowse' => [
            'App\Listeners\CreateBrowseLog',
            // 其它监听器
        ],
    ];

添加好之后，执行 php artisan event:generate，会自动创建对应的事件/监听器。分别创建了 app/Events/UserBrowse.php 和 app/Listeners/CreateBrowseLog.php 两个文件。

实现代码

把目光聚集到事件 app/Events/UserBrowse.php 文件，这里需要接收数据以便后续处理，代码如下

    public $ip_addr;
    public $request_url;
    public $city_name;

    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct($ip_addr, $request_url, $city_name)
    {
        $this->ip_addr = $ip_addr;
        $this->request_url = $request_url;
        $this->city_name = $city_name;
    }

然后是监听器 app/Listeners/CreateBrowseLog.php，这里要做的是，将事件中接收到的数据进行入库操作，代码如下

/**
     * Handle the event.
     *
     * @param  UserBrowse $event
     * @return void
     */
    public function handle(UserBrowse $event)
    {
        $log = new \App\Models\BrowseLog();

        $log->ip_addr = $event->ip_addr;
        $log->request_url = $event->request_url;
        $log->city_name = $event->city_name;

        $log->save();
    }

分发事件

最后就是分发事件，修改 app/Http/Middleware/BrowseLog.php 中间件的代码，修改后如下

/**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        // 使用事件/监听器入库
        event(new UserBrowse($request->getClientIp(), $request->path(), get_city_by_ip(false, 'null')));
        
        return $next($request);
    }

测试之后是没有问题的。

结语

这次所做的修改，感官上来看，就是将入库操作从中间件转移到监听器中，实际上的意义远不止于此。例如同一个事件，可以分发在不同的地方；事件添加了需求，只需要在添加一个监听器即可；监听器中也可以使用队列等等。

参考资料：事件、观察者模式。