以下知识参考中文文档：https://learnku.com/docs/laravel/5.5/events/1318
什么是Laravel事件系统？
Laravel事件系统提供了一个简单的观察者模式的实现，能够订阅和监听应用中发生的各种事件。事件类保存在app/Events目录中，而这些事件的监听器则被保存在app/Listeners目录下。这些目录只有当你使用Artisan命令来生成事件和监听器时才会被自动创建。
怎么实现事件和监听器？
最基本的步骤的是：注册事件和监听器 --> 生成事件&监听器 --> 定义事件 --> 定义监听器
1. 注册事件和监听器
Laravel应用中的EventServiceProvider有个listen数组包含所有的事件（键）以及事件对应的监听器（值）来注册所有的事件监听器，可以灵活地根据需求来添加事件。
/**
* 应用程序的事件监听器映射。
* @var array
*/
protected $listen = [
'App\Events\OrderShipped' => [
'App\Listeners\SendShipmentNotification',
],
];
注：可以使用 event:list 命令显示应用程序
2. 生成事件&监听器
为每个事件和监听器手动创建文件是件很麻烦的事情，而在这里，只需要将监听器和事件添加到EventServiceProvider中，再使用event:generate命令即可。这个命令就生成在EventServiceProvider中列出所有事件和监听器。当然，已经存在的事件和监听器保持不变：
php artisan event:generate
或者，你可以使用 make:event 以及 make:listener 用于生成单个事件和监听器的 Artisan 命令：
php artisan make:event PodcastProcessed
php artisan make:listener SendPodcastNotification --event=PodcastProcessed
3. 定义事件
事件类其实就只是一个保存与事件相关的信息的数据容器。
<?php
namespace App\Events;
use App\Order;
use Illuminate\Queue\SerializesModels;
class OrderShipped
{
use SerializesModels;
public $order;
/**
* 创建一个事件实例。
* @param Order $order
* @return void
*/
public function __construct(Order $order)
{
$this->order = $order;
}
}
正如你所见，这个事件类中没有包含其他逻辑。它只是一个被构建的Order对象的容器。如果使用PHP的serialize函数序列化事件对象，事件使用的SerializesModels trait将会优雅地序列化任何Eloquent模型。
4. 定义监听器
事件监听器在handle方法中接受事件实例。event:generate命令会自动加载正确的事件类和在handle加入的类型提示。
<?php
namespace App\Listeners;
use App\Events\OrderShipped;
class SendShipmentNotification
{
/**
* 创建事件监听器。
* @return void
*/
public function __construct()
{ }
/**
* 处理事件
* @param OrderShipped $event
* @return void
*/
public function handle(OrderShipped $event)
{
// 使用 $event->order 来访问 order ...
}
}
事件监听器可以用队列实现吗？
如果你的监听器中要执行诸如发送邮件或者进行HTTp请求等比较慢的任务，你可以选择将其丢给队列处理。
要指定监听器启动队列，只需将ShouldQueue接口添加到监听器类。由Artisan命令event:generate生成的监听器已经将此接口导入到当前的命名空间中：
<?php
namespace App\Listeners;
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
class SendShipmentNotification implements ShouldQueue
{ }
当这个监听器被事件调用时，事件调度器会自动使用Laravel的队列系统，如果在队列中执行监听器时没有抛出异常，任务会在执行完成后自动从队列中删除。
可以自定义队列的连接和名称吗？
可以在监听器类中定义$connection和$queue属性
<?php
namespace App\Listeners;
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
class SendShipmentNotification implements ShouldQueue
{
/**
* 任务应该发送到的队列的连接的名称
* @var string|null
*/
public $connection = 'sqs';
/**
* 任务应该发送到的队列的名称
* @var string|null
*/
public $queue = 'listeners';
}
怎么处理失败任务？
事件监听器的队列任务可能会失败，如果监听器的队列任务超过了队列中定义的最大尝试次数，则会在监听器上调用failed方法。failed方法接受接收事件实例和导致失败的异常作为参数。
<?php
namespace App\Listeners;
use App\Events\OrderShipped;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
class SendShipmentNotification implements ShouldQueue
{
use InteractsWithQueue;
/**
* 处理事件
* @param \App\Events\OrderShipped $event
* @return void
*/
public function handle(OrderShipped $event)
{ }
/**
* 处理任务失败
* @param \App\Events\OrderShipped $event
* @param \Exception $exception
* @return void
*/
public function failed(OrderShipped $event, $exception)
{ }
}
怎么分发事件？
如果要分发事件，可以把事件实例传递给辅助函数event。这个函数将会把事件分发给所有已经注册的监听器上。因为辅助函数event是全局可访问的，所以你可以在应用中的任何地方调用它：
<?php
namespace App\Http\Controllers;
use App\Order;
use App\Events\OrderShipped;
use App\Http\Controllers\Controller;
class OrderController extends Controller
{
/**
* 将传递过来的订单发货。
* @param int $orderId
* @return Response
*/
public function ship($orderId)
{
$order = Order::findOrFail($orderId);
// 订单的发货逻辑...
event(new OrderShipped($order));
}
}
事件订阅者是什么？
事件订阅是一个可以在自身内部订阅多个事件的类，即能够在单个类中定义多个事件处理器。订阅者应该定义一个subscribe方法，这个方法接受一个事件分发器的实例。
<?php
namespace App\Listeners;
class UserEventSubscriber
{
/**
* 处理用户登录事件。
*/
public function onUserLogin($event) {}
/**
* 处理用户注销事件。
*/
public function onUserLogout($event) {}
/**
* 为订阅者注册监听器。
* @param Illuminate\Events\Dispatcher $events
*/
public function subscribe($events)
{
$events->listen(
'Illuminate\Auth\Events\Login',
'App\Listeners\UserEventSubscriber@onUserLogin'
);
$events->listen(
'Illuminate\Auth\Events\Logout',
'App\Listeners\UserEventSubscriber@onUserLogout'
);
}
}
注册事件订阅者
订阅者写好后，就将器注册到事件分发器中。你可以在EventServiceProvider类的$subscribe属性中注册订阅者。例如，将UserEventSubscriber添加到数组列表中：
<?php
namespace App\Providers;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
/**
* 应用中事件监听器的映射。
* @var array
*/
protected $listen = [ ];
/**
* 需要注册的订阅者类。
* @var array
*/
protected $subscribe = [
'App\Listeners\UserEventSubscriber',
];
}
网友评论