分享每一天-学习laravel 框架的事件系统

学习laravel 框架的事件系统

PHP 1743 0 创建时间：2020-06-13 10:47:06

事件系统

Laravel 的事件提供了一个简单的观察者实现，允许你在应用中订阅和监听各种发生的事件。事件类通常放在 app/Events 目录下，而这些事件类的监听器则放在 app/Listeners 目录下。如果在你的应用中你没有看到这些目录，不用担心，它们会在你使用 Artisan 控制台命令生成事件与监听器的时候自动创建。 
事件系统为应用各个方面的解耦提供了非常棒的方法，因为单个事件可以拥有多个互不依赖的监听器。举个例子，你可能希望每次订单发货时向用户推送一个 Slack 通知。你可以简单地发起一个可以被监听器接收并转化为 Slack 通知的 OrderShipped 事件，而不是将订单处理代码和 Slack 通知代码耦合在一起。

#### 生成事件和监听器
```php
php artisan event:generate
```
命令会生成在 EventServiceProvider 中列出的所有事件和监听器。当然，已经存在的事件和监听器将保持不变.

#### 手动注册事件
通常，事件应该通过 EventServiceProvider 的 $listen 数组来注册的，然而，你也可以在 EventServiceProvider 的 boot 方法中手动的注册基于闭包的事件：
```php
/**
 * 注册应用的任何其他事件
 *
 * @return void
 */
public function boot()
{
    parent::boot();

Event::listen('event.name', function ($foo, $bar) {
        //
    });
}
```
#### 通配符事件监听器
你可以在注册监听器时使用 * 作为通配符参数，这样可以在同一个监听器上捕获多个事件。通配符监听器接收事件名作为其第一个参数，并将整个事件数据数组作为其第二个参数：
```php
Event::listen('event.*', function ($eventName, array $data) {
    //
});
```

#### 事件发现
你可以启用自动事件发现，而不是在 EventServiceProvider 的 $listen 数组中手动的注册事件和监听器。事件发现启用后，Laravel 会通过扫描你应用的 Listeners 目录来自动的查找和注册事件和监听器。此外，EventServiceProvider 中列出的任何明确定义的事件仍将被注册。

Laravel 通过使用反射扫描监听器类来查找事件监听器。 当 Laravel 找到以 handle 开头的监听器类方法时，Laravel 会将这些方法注册为方法签名中类型提示的事件的事件监听器：
```php
use App\Events\PodcastProcessed;

class SendPodcastProcessedNotification
{
    /**
     * 处理给定的事件。
     *
     * @param  \App\Events\PodcastProcessed
     * @return void
     */
    public function handle(PodcastProcessed $event)
    {
        //
    }
}
```
事件发现默认情况下是禁用的，但你可以通过覆盖应用程序的 EventServiceProvider 的 shouldDiscoverEvents 方法来启用它：
```php
/**
 * 确定是否应自动发现事件和侦听器。
 *
 * @return bool
 */
public function shouldDiscoverEvents()
{
    return true;
}
```
默认情况下，在应用程序的 Listeners 目录中的所有监听器将被扫描。如果你想要定义扫描其他目录，可以覆盖 EventServiceProvider 中的 discoverEventsWithin 方法：
```php
/**
 * 获取应该用于发现事件的监听器的目录。
 *
 * @return array
 */
protected function discoverEventsWithin()
{
    return [
        $this->app->path('Listeners'),
    ];
}
```
在生产环境中，你可能不希望框架在每个请求上扫描所有监听器。 因此，在部署过程中，您应该运行 event:cache Artisan 命令来缓存应用程序的所有事件和监听器的列表。 框架将使用此列表来加速事件注册过程。event:clear 命令则可用于销毁缓存。

#### 定义事件
事件类就是一个包含与事件相关信息数据的容器。例如，假设我们生成的 OrderShipped 事件接受一个 Eloquent ORM 对象：
```php
<?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 模型。
#### 定义监听器
接下来，让我们看一下例子中事件的监听器。事件监听器在 handle 方法中接受了事件实例作为参数。 event:generate 命令将会在事件的 handle 方法中自动加载正确的事件类和类型提示。在 handle 方法中，你可以运行任何需要响应该事件的业务逻辑。
```php
<?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 ...
    }
}
```
 你的事件监听器也可以在构造函数中对任何依赖使用类型提示。所有的事件监听器会经由 Laravel 的 服务容器 做解析，所以所有的依赖都将会被自动注入.
####  停止事件传播
如果你的监听器中需要实现一些耗时的任务，比如发送邮件或者进行 HTTP 请求，那把它放到队列中处理是非常有用的。在使用队列化监听器之前，一定要在服务器或者本地环境中配置 队列 并开启一个队列监听器。

要对监听器进行队列化的话，只需增加 ShouldQueue 接口到你的监听器类。由 Artisan 命令 event:generate 生成的监听器已经将此接口导入到命名空间了，因此你可以直接使用它：
 有时，你可能希望停止一个事件传播到其他的监听器。这时你可以通过在监听器的 handle 方法中返回 false 来实现。
####  队列化事件监听器
如果你的监听器中需要实现一些耗时的任务，比如发送邮件或者进行 HTTP 请求，那把它放到队列中处理是非常有用的。在使用队列化监听器之前，一定要在服务器或者本地环境中配置 队列 并开启一个队列监听器。

要对监听器进行队列化的话，只需增加 ShouldQueue 接口到你的监听器类。由 Artisan 命令 event:generate 生成的监听器已经将此接口导入到命名空间了，因此你可以直接使用它：
```php
<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    //
}
```
就这样！当事件被监听器调用时， 事件分发器会使用 Laravel 的 队列系统 自动将它进行队列化。如果监听器通过队列运行且没有抛出任何异常，则已执行完的任务将会自动从队列中删除。
#### 自定义队列的连接和名称
如果你想要自定义队列的连接和名称，你可以在监听器类中定义 $connection 和 $queue 属性。
```php
<?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';
}
```
#### 手动访问队列
如果你需要手动访问底层队列任务的 delete 和 release 方法，你可以使用 Illuminate\Queue\InteractsWithQueue trait 来实现。这个 trait 在生成的监听器中是默认加载的，它提供了这些方法：
```php
<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;

public function handle(OrderShipped $event)
    {
        if (true) {
            $this->release(30);
        }
    }
}
```
#### 处理失败任务
有时你队列化的事件监听器可能失败了。如果队列监听器任务执行次数超过在工作队列中定义的最大尝试次数，监听器的 failed 方法将会被自动调用。 failed 方法接受事件实例和失败的异常作为参数：
```php
<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;

public function handle(OrderShipped $event)
    {
        //
    }

public function failed(OrderShipped $event, $exception)
    {
        //
    }
}
```
#### 触发事件
如果要触发事件，你可以传递一个事件实例给 event 辅助函数。这个函数将会把事件分发到它所有已经注册的监听器上。因为 event 函数是全局可访问的，所以你可以在应用中的任何地方调用它：
```php
<?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 方法，这个方法接受一个事件分发器的实例。你可以调用事件分发器的 listen 方法来注册事件监听器：
```php
<?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
<?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',
    ];
}
```

学习laravel 框架的事件系统

商品推荐

广告推荐

推荐文章