Laravel 5.1 事件

简介

Laravel事件提供了简单的观察者模式实现，允许你订阅和监听应用中的事件。事件类通常存放在app/Events目录，监听器存放在app/Listeners。
注意区别旧的laravel版本。下图为laravel5.1的升级说明。

注册事件和监听器

我们可以在app/Providers/目录下的EventServiceProvider中注册事件和监听器映射关系，其中的listen属性包含了事件（键）和对应监听器（值）数组。如果应用需要，你可以添加多个事件到该数组。例如，让我们添加StockChangeEvent事件和StockChangeListener：

/**
 * 事件监听器映射
 *
 * @var array
 */
protected $listen = [
    'Shark\Events\Product\StockChangeEvent' => [
        'Shark\Listeners\Product\StockChangeListener',
    ],
    'Shark\Events\Product\ProductAddEvent' => [
        'Shark\Listeners\Product\ProductListener',
        'Shark\Listeners\Product\ProductAddListener',
    ],
];

当然你也可以一个事件绑定多个监听器。
你也可以使用下面的方法注册事件和监听器：

Event::listen('Shark\Events\Product\StockChangeEvent', 'Shark\Listeners\Product\StockChangeListener');

你也可以使用下面的方法解除事件监听器的绑定

\Event::forget('Shark\Events\Product\StockChangeEvent');

定义事件和监听器

你可以使用artisan make:event 和artisan make:listener生成对应的文件，你也可以使用artisan event:generate 前提是你先在EventServiceProvider中注册好事件。

<?php

namespace Shark\Events\Product;

use Shark\Events\Event;
use Illuminate\Queue\SerializesModels;

class StockChangeEvent extends Event
{
    use SerializesModels;
    protected $product_id = 0;
    protected $sku_id = 0;

    /**
     * StockChangeEvent constructor.
     * @param $product_id
     * @param $sku_id
     */
    public function __construct($product_id, $sku_id)
    {
        //这里接收事件
        $this->product_id = $product_id;
        $this->sku_id = $sku_id;
        \Log::alert('event', ['event' => func_get_args()]);
    }

    /**
     * Get the channels the event should be broadcast on.
     *
     * @return array
     */
    public function broadcastOn()
    {
        return [];
    }
}

<?php

namespace Shark\Listeners\Product;

use Shark\Events\Product\StockChangeEvent;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class StockChangeListener implements ShouldQueue
{
    use InteractsWithQueue;

    /**
     * 创建事件监听器.
     *
     * @return void
     */
    public function __construct()
    {
    //你的事件监听器还可以在构造器中类型提示任何需要的依赖，所有事件监听器通过服务容器解析，所以依赖会自动注入。
    }

    /**
     * 处理事件.
     *
     * @param  StockChangeEvent $event
     * @return void
     */
    public function handle(StockChangeEvent $event)
    {
        //这里写你对监听的这个事件的处理。这里你可以使用$event->product_id获取参数
        \Log::alert('Listen', ['Listen' => func_get_args()]);
    }
}

注意事项：

1. 你的事件监听器还可以在构造器中类型提示任何需要的依赖，所有事件监听器通过服务容器解析，所以依赖会自动注入。
2. 如果你的事件绑定了多个监听器，有时候，你希望停止事件被传播到其它监听器，你可以通过从监听器的handle方法中返回false来实现。

---

事件监听器队列

如果你想使用异步队列的监听器，让监听器类实现ShouldQueue接口即可。你可以参照命令artisan help make:listener来生成异步的监听代码。如果直接使用event:generate生成的监听器不是异步的。
如果你使用异步监听，会写入队列queues:default中。

当监听器被事件调用，将会使用Laravel的队列系统通过队列分发器自动队列化。如果通过队列执行监听器的时候没有抛出任何异常，队列任务在执行完成后被自动删除。

如果你需要手动访问底层队列任务的delete和release方法，在生成的监听器中默认导入的Illuminate\Queue\InteractsWithQueue trait提供了访问这两个方法的权限：

触发事件

要触发一个事件，可以使用Event门面，传递一个事件实例到fire方法，fire方法会分发事件到所有监听器：

Event::fire(new StockChangeEvent(1, 1));
event(new StockChangeEvent(1, 1));

以上两种写法均可。

其他

Event门面方法说明：

• void listen(string|array $events, mixed $listener, int $priority) 手动注册事件和监听器的关系。
• bool hasListeners(string $eventName)判断一个事件是否注册的有监听器。
• void push(string $event, array $payload = array())Register an event and payload to be fired later.
• void subscribe(object|string $subscriber)Register an event subscriber with the dispatcher.
• mixed until(string $event, array $payload = array()) Fire an event until the first non-null response is returned.触发一个事件，顺序执行监听器直到非null的响应返回。
• void flush(string $event)Flush a set of pushed events.
• array|null fire(string|object $event, mixed $payload = array(), bool $halt = false) 触发事件
• array getListeners(string $eventName) 获取一个事件注册的所有监听器
• void forget(string $event) 取消一个事件的注册器绑定（Remove a set of listeners from the dispatcher.）

---

参考资料

1. http://laravelacademy.org/post/198.html
2. https://laravel.com/api/5.1/Illuminate/Events/Dispatcher.html