解析Laravel事件系统的使用方法-Laravel-PHP中文网

解析Laravel事件系统的使用方法

藏色散人

发布： 2021-10-27 16:27:30

转载

2039人浏览过

下面由laravel教程栏目带大家介绍关于laravel事件系统的使用方法，希望对大家有所帮助！

Laravel 事件系统用法总结

Laravel 的事件提供了一个简单的观察者实现，能够订阅和监听应用中发生的各种事件。事件类保存在 app/Events 目录中，而这些事件的的监听器则被保存在 app/Listeners 目录下。这些目录只有当你使用 Artisan 命令来生成事件和监听器时才会被自动创建。

事件机制是一种很好的应用解耦方式，因为一个事件可以拥有多个互不依赖的监听器。例如，如果你希望每次订单发货时向用户发送一个 Slack 通知。你可以简单地发起一个 OrderShipped 事件，让监听器接收之后转化成一个 Slack 通知，这样你就可以不用把订单的业务代码跟 Slack 通知的代码耦合在一起了。

生成一个事件类

比如通过 artisan 命令生成一个 UserLogin 事件：

php artisan make:event UserLogin

登录后复制

在 app/Events 中就会自动生成一个 UserLogin.php 文件，内容不多，如下：

<?php
 
namespace AppEvents;
 
use IlluminateBroadcastingChannel;
use IlluminateQueueSerializesModels;
use IlluminateBroadcastingPrivateChannel;
use IlluminateBroadcastingPresenceChannel;
use IlluminateBroadcastingInteractsWithSockets;
use IlluminateContractsBroadcastingShouldBroadcast;
 
class UserLogin
{
    use InteractsWithSockets, SerializesModels;
 
    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }
 
    /**
     * Get the channels the event should broadcast on.
     *
     * @return Channel|array
     */
    public function broadcastOn()
    {
        return new PrivateChannel('channel-name');
    }
}

登录后复制

定义监听器

一个事件可以被一个或多个监听器监听，也就是观察者模式，我们可以定义多个监听器，当这个事件发生，执行一系列逻辑。

在 EventServiceProvider 的 $listen 中可以定义事件和监听器，如下：

protected $listen = [
    'AppEventsUserLogin' => [
        'AppListenersDoSomething1',
        'AppListenersDosomething2',
    ],
];

登录后复制

然后执行 artisan 命令，就可以自动在 app/Listeners 目录生成监听器。

php artisan event:generate

登录后复制

可以看到 app/Listeners 目录多了 DoSomething1.php 和 DoSomething2.php 两个文件，我们看看其中一个内容：

<?php
 
namespace AppListeners;
 
use AppEventsUserLogin;
use IlluminateQueueInteractsWithQueue;
use IlluminateContractsQueueShouldQueue;
 
class DoSomething1
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }
 
    /**
     * Handle the event.
     *
     * @param  UserLogin  $event
     * @return void
     */
    public function handle(UserLogin $event)
    {
        info('do something1');
    }
}

登录后复制

在两个监听器的 handle 方法中我们打印一个日志来测试一下，如代码 handle 方法所示。

分发和触发事件

我们在某个控制器的方法中来分发事件，也就是触发事件，看监听器是否正常工作。

就是一句话：

event(new UserLogin());

登录后复制

然后我们请求这个控制器，观察日志，发现打印了日志：

[2018-06-17 10:04:29] local.INFO: do something1 [2018-06-17 10:04:29] local.INFO: do something2

登录后复制

那么这个事件-监听机制就正常工作了。

队列异步处理

如果某个监听器需要执行的操作比较慢，可以放到消息队列进行异步处理。

比如把上面的 DoSomething1 改成需要放入队列的，只需要 implements ShoulQueue 接口。

class DoSomething1 implements ShouldQueue

登录后复制

也可以指定队列驱动，如下代码。

/**
     * 任务应该发送到的队列的连接的名称
     *
     * @var string|null
     */
    public $connection = 'redis';
 
    /**
     * 任务应该发送到的队列的名称
     *
     * @var string|null
     */
    public $queue = 'listeners';

登录后复制

我们再次执行控制器方法。

日志里没有打印 do something1，只有 do something2，但是在 redis 队列里发现了一个名为 queues:default 的列表。

{"job":"Illuminate\Events\CallQueuedHandler@call","data":{"class":"App\Listeners\DoSomething1","method":"handle","data":"a:1:{i:0;O:20:"App\Events\UserLogin":1:{s:6:"socket";N;}}"},"id":"3D7VDUwueYGtUvsazicWsifwWQxnnLID","attempts":1}

登录后复制

这个时候需要使用 php artisan queue:work 执行队列任务，才是真正执行 DoSomething1 这个监听器的 handle 方法。