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

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

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

Laravel應(yīng)用在創(chuàng)建時注冊的基礎(chǔ)服務(wù)里就有Event服務(wù)

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服務(wù)真正的實現(xiàn)類，而Event門面時events服務(wù)的靜態(tài)代理，事件系統(tǒng)相關(guān)的方法都是由IlluminateEventsDispatcher來提供的。

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

/**
 * 應(yīng)用程序的事件監(jiān)聽器映射。
 *
 * @var array
 */
protected $listen = [
    "AppEventsOrderShipped" => [
        "AppListenersSendShipmentNotification",
    ],
];

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

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

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

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

我們在將服務(wù)提供器的時候說過，Laravel應(yīng)用在注冊完所有的服務(wù)后會通過IlluminateFoundationBootstrapBootProviders調(diào)用所有Provider的boot方法來啟動這些服務(wù)，所以Laravel應(yīng)用中事件和監(jiān)聽器的注冊就發(fā)生在?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);
    }
}

可以看到事件系統(tǒng)的啟動是通過events服務(wù)的監(jiān)聽和訂閱方法來創(chuàng)建事件與對應(yīng)的監(jiān)聽器還有系統(tǒng)里的事件訂閱者。

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);
    }
}

對于包含通配符的事件名，會被統(tǒng)一放入?wildcards?數(shù)組中，makeListener是用來創(chuàng)建事件對應(yīng)的listener的:

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

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

創(chuàng)建listener的時候，會判斷監(jiān)聽對象是監(jiān)聽類還是閉包函數(shù)。

對于閉包監(jiān)聽來說，makeListener 會再包裝一層返回一個閉包函數(shù)作為事件的監(jiān)聽者。

對于監(jiān)聽類來說，會繼續(xù)通過 createClassListener 來創(chuàng)建監(jiān)聽者

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)) {
            //如果當(dāng)前監(jiān)聽類是隊列的話，會將任務(wù)推送給隊列
            return $this->createQueuedHandlerCallable($class, $method);
        } else {
            return [$this->container->make($class), $method];
        }
    }
}

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

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

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

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

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

        //如果觸發(fā)事件時傳遞了halt參數(shù)，并且listener返回了值，那么就不會再去調(diào)用事件剩下的listener
        //否則就將返回值加入到返回值列表中，等所有l(wèi)istener執(zhí)行完了一并返回
        if ($halt && ! is_null($response)) {
            return $response;
        }
        //如果一個listener返回了false, 那么將不會再調(diào)用事件剩下的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)];
}

//獲取事件名對應(yīng)的所有l(wèi)istener
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;
}

事件觸發(fā)后，會從之前注冊事件生成的listeners中找到事件名稱對應(yīng)的所有listener閉包，然后調(diào)用這些閉包來執(zhí)行監(jiān)聽器中的任務(wù)，需要注意的是:

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

如果觸發(fā)事件時傳遞了halt參數(shù)，在listener返回非false后那么事件就不會往下繼續(xù)傳播給剩余的listener了，否則所有l(wèi)istener的返回值會在所有l(wèi)istener執(zhí)行往后作為一個數(shù)組統(tǒng)一返回。

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

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

本文已經(jīng)收錄在系列文章Laravel源碼學(xué)習(xí)里，歡迎訪問閱讀。