摘要：對于包含通配符的事件名，會被統一放入數組中，是用來創建事件對應的的如果是監聽器是類，去創建監聽類創建的時候，會判斷監聽對象是監聽類還是閉包函數。對于閉包監聽來說，會再包裝一層返回一個閉包函數作為事件的監聽者。

Laravel 的事件提供了一個簡單的觀察者實現，能夠訂閱和監聽應用中發生的各種事件。事件機制是一種很好的應用解耦方式，因為一個事件可以擁有多個互不依賴的監聽器。laravel?中事件系統由兩部分構成，一個是事件的名稱，事件的名稱可以是個字符串，例如?event.email，也可以是一個事件類，例如?AppEventsOrderShipped；另一個是事件的?監聽器listener，可以是一個閉包，還可以是監聽類，例如?AppListenersSendShipmentNotification。

我們還是通過官方文檔里給出的這個例子來向下分析事件系統的源碼實現，不過在應用注冊事件和監聽器之前，Laravel在應用啟動時會先注冊處理事件用的events服務。

Laravel應用在創建時注冊的基礎服務里就有Event服務

namespace IlluminateFoundation;

class Application extends Container implements ...
{
    public function __construct($basePath = null)
    {
        ...
        $this->registerBaseServiceProviders();
        ...
    }
    
    protected function registerBaseServiceProviders()
    {
        $this->register(new EventServiceProvider($this));

        $this->register(new LogServiceProvider($this));

        $this->register(new RoutingServiceProvider($this));
    }
}

其中的?EventServiceProvider?是?/Illuminate/Events/EventServiceProvider

public function register()
{
    $this->app->singleton("events", function ($app) {
        return (new Dispatcher($app))->setQueueResolver(function () use ($app) {
            return $app->make(QueueFactoryContract::class);
        });
    });
}

IlluminateEventsDispatcher?就是?events服務真正的實現類，而Event門面時events服務的靜態代理，事件系統相關的方法都是由IlluminateEventsDispatcher來提供的。

我們還是通過官方文檔里給出的這個例子來向下分析事件系統的源碼實現，注冊事件和監聽器有兩種方法，AppProvidersEventServiceProvider?有個?listen?數組包含所有的事件（鍵）以及事件對應的監聽器（值）來注冊所有的事件監聽器，可以靈活地根據需求來添加事件。

/**
 * 應用程序的事件監聽器映射。
 *
 * @var array
 */
protected $listen = [
    "AppEventsOrderShipped" => [
        "AppListenersSendShipmentNotification",
    ],
];

也可以在 AppProvidersEventServiceProvider 類的 boot 方法中注冊基于事件的閉包。

/**
 * 注冊應用程序中的任何其他事件。
 *
 * @return void
 */
public function boot()
{
    parent::boot();

    Event::listen("event.name", function ($foo, $bar) {
        //
    });
}

可以看到AppProvidersEventProvider類的主要工作就是注冊應用中的事件，這個注冊類的主要作用是事件系統的啟動，這個類繼承自?IlluminateFoundationSupportProvidersEventServiceProvide。

我們在將服務提供器的時候說過，Laravel應用在注冊完所有的服務后會通過IlluminateFoundationBootstrapBootProviders調用所有Provider的boot方法來啟動這些服務，所以Laravel應用中事件和監聽器的注冊就發生在?IlluminateFoundationSupportProvidersEventServiceProvide類的boot方法中，我們來看一下：

public function boot()
{
    foreach ($this->listens() as $event => $listeners) {
        foreach ($listeners as $listener) {
            Event::listen($event, $listener);
        }
    }

    foreach ($this->subscribe as $subscriber) {
        Event::subscribe($subscriber);
    }
}

可以看到事件系統的啟動是通過events服務的監聽和訂閱方法來創建事件與對應的監聽器還有系統里的事件訂閱者。

namespace IlluminateEvents;
class Dispatcher implements DispatcherContract
{
    public function listen($events, $listener)
    {
        foreach ((array) $events as $event) {
            if (Str::contains($event, "*")) {
                $this->setupWildcardListen($event, $listener);
            } else {
                $this->listeners[$event][] = $this->makeListener($listener);
            }
        }
    }
    
    protected function setupWildcardListen($event, $listener)
    {
        $this->wildcards[$event][] = $this->makeListener($listener, true);
    }
}

對于包含通配符的事件名，會被統一放入?wildcards?數組中，makeListener是用來創建事件對應的listener的:

class Dispatcher implements DispatcherContract
{
    public function makeListener($listener, $wildcard = false)
    {
        if (is_string($listener)) {//如果是監聽器是類，去創建監聽類
            return $this->createClassListener($listener, $wildcard);
        }

        return function ($event, $payload) use ($listener, $wildcard) {
            if ($wildcard) {
                return $listener($event, $payload);
            } else {
                return $listener(...array_values($payload));
            }
        };
    }
}

創建listener的時候，會判斷監聽對象是監聽類還是閉包函數。

對于閉包監聽來說，makeListener 會再包裝一層返回一個閉包函數作為事件的監聽者。

對于監聽類來說，會繼續通過 createClassListener 來創建監聽者

class Dispatcher implements DispatcherContract
{
    public function createClassListener($listener, $wildcard = false)
    {
        return function ($event, $payload) use ($listener, $wildcard) {
            if ($wildcard) {
                return call_user_func($this->createClassCallable($listener), $event, $payload);
            } else {
                return call_user_func_array(
                    $this->createClassCallable($listener), $payload
                );
            }
        };
    }

    protected function createClassCallable($listener)
    {
        list($class, $method) = $this->parseClassCallable($listener);

        if ($this->handlerShouldBeQueued($class)) {
            //如果當前監聽類是隊列的話，會將任務推送給隊列
            return $this->createQueuedHandlerCallable($class, $method);
        } else {
            return [$this->container->make($class), $method];
        }
    }
}

對于通過監聽類的字符串來創建監聽者也是返回的一個閉包，如果當前監聽類是要執行隊列任務的話，返回的閉包是在執行后會將任務推送給隊列，如果是普通監聽類返回的閉包中會將監聽對象make出來，執行對象的handle方法。 所以監聽者返回閉包都是為了包裝好事件注冊時的上下文，等待事件觸發的時候調用閉包來執行任務。

創建完listener后就會把它放到listener數組中以對應的事件名稱為鍵的數組里，在listener數組中一個事件名稱對應的數組里可以有多個listener， 就像我們之前講觀察者模式時Subject類中的observers數組一樣，只不過Laravel比那個復雜一些，它的listener數組里會記錄多個Subject和對應觀察者的對應關系。

可以用事件名或者事件類來觸發事件，觸發事件時用的是Event::fire(new OrdershipmentNotification)， 同樣它也來自events服務

public function fire($event, $payload = [], $halt = false)
{
    return $this->dispatch($event, $payload, $halt);
}

public function dispatch($event, $payload = [], $halt = false)
{
    //如果參數$event事件對象，那么就將對象的類名作為事件名稱，對象本身作為攜帶數據的荷載通過`listener`方法
    //的$payload參數的實參傳遞給listener
    list($event, $payload) = $this->parseEventAndPayload(
        $event, $payload
    );

    if ($this->shouldBroadcast($payload)) {
        $this->broadcastEvent($payload[0]);
    }

    $responses = [];

    foreach ($this->getListeners($event) as $listener) {
        $response = $listener($event, $payload);

        //如果觸發事件時傳遞了halt參數，并且listener返回了值，那么就不會再去調用事件剩下的listener
        //否則就將返回值加入到返回值列表中，等所有listener執行完了一并返回
        if ($halt && ! is_null($response)) {
            return $response;
        }
        //如果一個listener返回了false, 那么將不會再調用事件剩下的listener
        if ($response === false) {
            break;
        }

        $responses[] = $response;
    }

    return $halt ? null : $responses;
}

protected function parseEventAndPayload($event, $payload)
{
    if (is_object($event)) {
        list($payload, $event) = [[$event], get_class($event)];
    }

    return [$event, Arr::wrap($payload)];
}

//獲取事件名對應的所有listener
public function getListeners($eventName)
{
    $listeners = isset($this->listeners[$eventName]) ? $this->listeners[$eventName] : [];

    $listeners = array_merge(
        $listeners, $this->getWildcardListeners($eventName)
    );

    return class_exists($eventName, false)
                ? $this->addInterfaceListeners($eventName, $listeners)
                : $listeners;
}

事件觸發后，會從之前注冊事件生成的listeners中找到事件名稱對應的所有listener閉包，然后調用這些閉包來執行監聽器中的任務，需要注意的是:

如果事件名參數事件對象，那么會用事件對象的類名作為事件名，其本身會作為時間參數傳遞給listener。

如果觸發事件時傳遞了halt參數，在listener返回非false后那么事件就不會往下繼續傳播給剩余的listener了，否則所有listener的返回值會在所有listener執行往后作為一個數組統一返回。

如果一個listener返回了布爾值false那么事件會立即停止向剩余的listener傳播。

Laravel的事件系統原理還是跟之前講的觀察者模式一樣，不過框架的作者功力深厚，巧妙的結合應用了閉包來實現了事件系統，還有針對需要隊列處理的事件，應用事件在一些比較復雜的業務場景中能利用關注點分散原則有效地解耦應用中的代碼邏輯，當然也不是什么情況下都能適合應用事件來編寫代碼，我之前寫過一篇文章事件驅動編程來說明事件的應用場景，感興趣的可以去看看。

本文已經收錄在系列文章Laravel源碼學習里，歡迎訪問閱讀。