larave 事件——迹忆客-ag捕鱼王app官网

简介

laravel 事件提供了简单的观察者模式实现，允许你订阅和监听应用中的事件。事件类通常存放在 app/events 目录，监听器存放在 app/listeners。如果你在应用中没有看到这些目录，不要担心，它们会在你使用 artisan 命令生成事件和监听器的时候自动创建。

事件为应用功能模块解耦提供了行之有效的解决办法，因为单个事件可以有多个监听器而这些监听器之间并不相互依赖。例如，你可能想要在每次订单发送时给用户发送一个 slack 通知，有了事件之后，你大可不必将订单处理代码和 slack 通知代码耦合在一起，而只需要简单触发一个可以被监听器接收并处理为 slack 通知的 ordershipped 事件即可。

注册事件/监听器

在laravel 自带的 eventserviceprovider 中可以很容易的注册事件监听器。其中的 listen 属性是用来注册监听器的数组。事件类作为key，值则是对应的监听器的数组。如果应用需要，我们可以添加在该数组中添加多个事件。下面让我们添加一个 ordershipped 事件：

/**
 * the event listener mappings for the application.
 *
 * @var array
 * @translator laravelacademy.org
 */
protected $listen = [
    'app\events\ordershipped' => [
        'app\listeners\sendshipmentnotification',
    ],
];

生成事件/监听器类

当然，手动为每个事件和监听器创建文件是很笨重的，取而代之地，我们只需简单添加监听器和事件到 eventserviceprovider 然后运行 event:generate 命令。该命令将会生成罗列在 eventserviceprovider 中的所有事件和监听器。当然，已存在的事件和监听器不会被重复创建：

$php artisan event:generate

手动注册事件

通常，我们需要通过 eventserviceprovider 的 $listen 数组注册事件，此外，还可以在 eventserviceprovider 的 boot 方法中手动注册基于闭包的事件：

/**
 * register any other events for your application.
 *
 * @return void
 */
public function boot()
{
    parent::boot();
​
    event::listen('event.name', function ($foo, $bar) {
        //
    });
}

通配符事件监听器

我们甚至还可以使用通配符*来注册监听器，这样就可以通过同一个监听器捕获多个事件。通配符监听器接收整个事件数据数组作为参数：

$events->listen('event.*', function ($eventname, array $data) {
    //
});

自动注册事件

除了在 eventserviceprovider 的 $listen 数组中手动注册事件及对应监听器之外，还可以开启自动事件发现。当事件发现开启后，laravel 将会通过遍历应用的 listeners 目录自动查找并注册事件及对应监听器。此外，任何定义在 eventserviceprovider 的列表中的事件仍然会被注册。

laravel 使用反射遍历监听器类来发现事件监听器，当 laravel 发现某个监听器类方法以 handle 开头，将会从方法签名中提取类型提示指定的事件，然后将该方法作为该事件的事件监听器：

use app\events\podcastprocessed;
​
class sendpodcastprocessednotification
{
    /**
     * handle the given event.
     *
     * @param  \app\events\podcastprocessed
     * @return void
     */
    public function handle(podcastprocessed $event)
    {
        //
    }
}

laravel默认情况下是禁用自动注册事件的，我们可以通过重写 eventserviceprovider 的 shoulddiscoverevents 方法来开启它：

/**
 * determine if events and listeners should be automatically discovered.
 *
 * @return bool
 */
public function shoulddiscoverevents()
{
    return true;
}

默认情况下，所有位于应用监听器目录下的监听器类都会被遍历，如果你想要添加额外的需要遍历的目录，可以重写 eventserviceprovider 的 discovereventswithin 方法：

/**
 * get the listener directories that should be used to discover events.
 *
 * @return array
 */
protected function discovereventswithin()
{
    return [
        $this->app->path('listeners'),
    ];
}

在生产环境中，我们可能不想要框架每次请求都要遍历所有监听器。因此，在部署过程中，你可以运行 artisan 命令 event:cache 来缓存应用事件和监听器的清单（manifest），框架会使用该清单来加速事件注册流程。相对的，可以通过 event:clear 命令来清除缓存。

注：event:list 命令可用于显示应用中事件和对应注册的监听器列表。

定义事件

事件类是一个处理与事件相关的简单数据容器，例如，假设我们生成的 ordershipped 事件接收一个 eloquent orm 对象：

order = $order;
    }
}

正如我们所看到的，该事件类不包含任何特定逻辑，只是一个存放被购买的 order 对象的容器，如果事件对象被序列化的话，事件使用的 serializesmodels trait 将会使用 php 的 serialize 函数序列化所有 eloquent 模型。

定义监听器

接下来，让我们看看示例事件的监听器，事件监听器在 handle 方法中接收事件实例，event:generate 命令将会自动在 handle 方法中导入相应的事件类和类型提示事件。在 handle 方法内，我们可以执行任何需要的逻辑以响应事件：

order...
    }
}

注：事件监听器还可以在构造器中类型提示任何需要的依赖，所有事件监听器通过服务容器解析，所以依赖会自动注入。

阻止事件冒泡

有时候，你希望停止事件被传播到其它监听器，你可以通过从监听器的 handle 方法中返回 false 来实现。

事件监听器队列

如果监听器将要执行耗时任务比如发送邮件或者发送 http 请求，那么将监听器放到队列是一个不错的选择。在队列化监听器之前，确保已经配置好队列并且在服务器或本地环境启动一个队列监听器。

要指定某个监听器需要放到队列，只需要让监听器类实现 shouldqueue 接口即可，通过 artisan 命令 event:generate 生成的监听器类已经将这个接口导入当前命名空间，所有你可以直接拿来使用：

/**
 * get the name of the listener's queue.
 *
 * @return string
 */
public function viaqueue()
{
    return 'listeners';
}

order->subtotal >= 5000;
    }
}

release(30);
        }
    }
}

ordershipped::dispatch($order);

listen(
            'illuminate\auth\events\login',
            'app\listeners\usereventsubscriber@handleuserlogin'
        );
        $events->listen(
            'illuminate\auth\events\logout',
            'app\listeners\usereventsubscriber@handleuserlogout'
        );
    }
}