Laravel事件 event

最新推荐文章于 2024-09-21 15:28:45 发布

陌阡

最新推荐文章于 2024-09-21 15:28:45 发布

阅读量1w

点赞数 1

分类专栏： php

php 专栏收录该内容

61 篇文章 0 订阅

订阅专栏

概述

事件是一种常见的观察者模式的应用。简单的来说，就是当...干...。这个当...和干...在Laravel 事件中分别对应：
当(event)...干(listener)...
放置event和listener文件的位置分别是：
app/Events
app/Listeners

对于产品经理来说，事件主要用来规范你的业务逻辑，使支线逻辑与主线逻辑独立分拆。对于程序员来说，事件可以让Controller变得非常简洁，解耦，可维护。

定义事件(Event)

用Artisan命令可以快速生成一个模板：
php artisan event:generate

 
 <?php
namespace App\Events;
use App\Podcast;
use App\Events\Event;
use Illuminate\Queue\SerializesModels;
class PodcastWasPurchased extends Event
{
    use SerializesModels;
    public $podcast;
    /**
     * Create a new event instance.
     *
     * @param  Podcast  $podcast
     * @return void
     */
    public function __construct(Podcast $podcast)
    {
        $this->podcast = $podcast;
    }
}

这样就定义了一个事件，这个事件里没有任何业务逻辑，就是一个数据传输层DTL（Data Transpotation Layer）,记住这个概念，在很多设计模式中都需要涉及到。

定义事件的侦听和处理器（Listener and Handler）

你在用artisan命令生成Event的时候，对应的Listner也一并生成好了：

 
 <?php
namespace App\Listeners;
use App\Events\PodcastWasPurchased;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
class EmailPurchaseConfirmation
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }
    /**
     * Handle the event.
     *
     * @param  PodcastWasPurchased  $event
     * @return void
     */
    public function handle(PodcastWasPurchased $event)
    {
        // Access the podcast using $event->podcast...
    }
}

handler里就是写业务逻辑的地方了，这里可以用type-hint依赖注入的方式，注入任何你需要的类。

将Event和Listener绑定并注册

这里就用到Service Provider: providers/EventServiceProvider.php 注册事件和Listener：

 
 protected $listen = [
    'App\Events\PodcastWasPurchased' => [
        'App\Listeners\EmailPurchaseConfirmation',
    ],
];

触发事件

经过上面的设置，你的事件和事件处理器就可以在controller里使用了：

 
 <?php
namespace App\Http\Controllers;
use Event;
use App\Podcast;
use App\Events\PodcastWasPurchased;
use App\Http\Controllers\Controller;
class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $userId
     * @param  int  $podcastId
     * @return Response
     */
    public function purchasePodcast($userId, $podcastId)
    {
        $podcast = Podcast::findOrFail($podcastId);
        // Purchase podcast logic...
        Event::fire(new PodcastWasPurchased($podcast));
    }
}

Event::fire(new PodcastWasPurchased($podcast));就是触发事件的写法，程序运行到这里，就会触发跟这个事件绑定的listener(handler)。
Event::fire()有个辅助函数可以简写：

 
 event(new PodcastWasPurchased($podcast));

将事件加入队列

如果要处理的事件很多，那么会影响当前进程的执行效率，这时我们需要把事件加入队列，让它延迟异步执行。

定义队列执行是在Listener那里定义的：

 
 <?php
namespace App\Listeners;
use App\Events\PodcastWasPurchased;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
class EmailPurchaseConfirmation implements ShouldQueue
{
    //
}

只要implements ShouldQueue一下就好了。

如果你想手动指定一下任务延迟执行的时间：

 
 <?php
namespace App\Listeners;
use App\Events\PodcastWasPurchased;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
class EmailPurchaseConfirmation implements ShouldQueue
{
    use InteractsWithQueue;
    public function handle(PodcastWasPurchased $event)
    {
        if (true) {
            $this->release(10);
        }
    }
}

触发后延迟10秒执行。

事件订阅(Event Subscribers)

Event Subscribers是一种特殊的Listener,前面讲的是一个listener里只能放一个hander（），事件订阅可以把很多处理器（handler）放到一个类里面，然后用一个listner把它们集合起来，这样不同的事件只要对应一个listner就可以了。

 
 <?php
namespace App\Listeners;
class UserEventListener
{
    /**
     * Handle user login events.
     */
    public function onUserLogin($event) {}
    /**
     * Handle user logout events.
     */
    public function onUserLogout($event) {}
    /**
     * Register the listeners for the subscriber.
     *
     * @param  Illuminate\Events\Dispatcher  $events
     * @return array
     */
    public function subscribe($events)
    {
        $events->listen(
            'App\Events\UserLoggedIn',
            'App\Listeners\UserEventListener@onUserLogin'
        );
        $events->listen(
            'App\Events\UserLoggedOut',
            'App\Listeners\UserEventListener@onUserLogout'
        );
    }
}

看后面的subscribe()，每个事件和处理器是一一对应的。

绑定 Event Subscriber到Service Provider

 
 <?php
namespace App\Providers;
use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        //
    ];
    /**
     * The subscriber classes to register.
     *
     * @var array
     */
    protected $subscribe = [
        'App\Listeners\UserEventListener',
    ];
}