Laravel 이벤트 시스템 해석

이 글은 주로 참조 가치가 있는 Laravel 이벤트 시스템의 해석을 소개합니다. 이제 모든 사람과 공유합니다. 도움이 필요한 친구들이 참조할 수 있습니다.

이벤트 시스템

Laravel 이벤트는 간단한 관찰자 구현을 제공합니다. 그리고 어플리케이션에서 발생하는 다양한 이벤트를 들어보세요. 이벤트 메커니즘은 애플리케이션을 분리하는 좋은 방법입니다. 이벤트에는 서로 독립적인 여러 리스너가 있을 수 있기 때문입니다. laravel의 이벤트 시스템은 두 부분으로 구성됩니다. 하나는 이벤트 이름이며, event.email과 같은 문자열일 수 있습니다. AppEventsOrderShipped와 같은 이벤트 클래스일 수 있으며, 다른 하나는 AppListenersSendShipmentNotification과 같은 클로저 또는 수신 클래스일 수 있는 이벤트 리스너 <code>listener입니다. 코드>. laravel 中事件系统由两部分构成，一个是事件的名称，事件的名称可以是个字符串，例如 event.email，也可以是一个事件类，例如 AppEventsOrderShipped；另一个是事件的 监听器listener，可以是一个闭包，还可以是监听类，例如 AppListenersSendShipmentNotification。

我们还是通过官方文档里给出的这个例子来向下分析事件系统的源码实现，不过在应用注册事件和监听器之前，Laravel在应用启动时会先注册处理事件用的events服务。

Laravel注册事件服务

Laravel应用在创建时注册的基础服务里就有Event服务

namespace Illuminate\Foundation;

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 = [
    'App\Events\OrderShipped' => [
        'App\Listeners\SendShipmentNotification',
    ],
];

也可以在 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 Illuminate\Events;
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

우리는 이벤트 시스템의 소스 코드 구현을 분석하기 위해 여전히 공식 문서에 제공된 예제를 사용합니다. 그러나 애플리케이션이 이벤트와 리스너를 등록하기 전에 Laravel은 애플리케이션이 시작될 때 이벤트 처리를 위해 먼저 events서비스. 🎜<h3 id="Laravel-등록-이벤트-서비스">Laravel 등록 이벤트 서비스</h3>🎜<code>Event 서비스는 Laravel 애플리케이션 생성 시 등록되는 기본 서비스 중 하나입니다.🎜rrreee🎜EventServiceProvider는 입니다. >/Illuminate/Events/EventServiceProvider🎜rrreee🎜IlluminateEventsDispatcher는 events 서비스의 실제 구현 클래스인 반면, Event는 Facade events 서비스의 정적 프록시와 이벤트 시스템 관련 메소드는 IlluminateEventsDispatcher에서 제공됩니다. 🎜

애플리케이션에서 이벤트 등록 및 수신

🎜 공식 문서에 제공된 예제를 통해 이벤트 시스템의 소스 코드 구현을 분석해 보겠습니다. 이벤트 및 리스너를 등록하는 방법에는 AppProvidersEventServiceProvider code> 모든 이벤트 리스너를 등록하기 위해 모든 이벤트(키)와 이벤트에 해당하는 리스너(값)를 포함하는 <code>listen 배열이 있으며, 필요에 따라 유연하게 이벤트를 추가할 수 있습니다. 🎜rrreee🎜AppProvidersEventServiceProvider 클래스의 boot 메서드에서 이벤트 기반 클로저를 등록할 수도 있습니다. 🎜rrreee🎜AppProvidersEventProvider 클래스의 주요 작업은 애플리케이션에 이벤트를 등록하는 것임을 알 수 있습니다. 이 등록 클래스의 주요 기능은 이벤트 시스템을 시작하는 것입니다. IlluminateFoundationSupportProvidersEventServiceProvide. 🎜🎜우리는 서비스 제공자를 추가할 때 모든 서비스를 등록한 후 Laravel 애플리케이션이 IlluminateFoundationBootstrapBootProviders를 통해 모든 제공자의 boot 메소드를 호출하여 이러한 서비스를 시작한다고 말했습니다. Laravel 애플리케이션의 이벤트 및 리스너 등록은 IlluminateFoundationSupportProvidersEventServiceProvide 클래스의 boot 메서드에서 발생합니다. 살펴보겠습니다. 🎜rrreee🎜이벤트 시스템이 시작되는 것을 볼 수 있습니다. 이벤트 서비스의 수신 및 구독 방법을 통해 시스템에서 이벤트, 해당 리스너 및 이벤트 구독자를 생성합니다. 🎜rrreee🎜와일드카드가 포함된 이벤트 이름은 wildcards 배열에 균일하게 배치됩니다. makeListener는 이벤트에 해당하는 listener를 생성하는 데 사용됩니다. 🎜rrreee🎜 리스너를 생성할 때 청취 객체가 청취 클래스인지 클로저 함수인지 결정합니다. 🎜🎜클로저 수신의 경우 makeListener는 다른 레이어를 래핑하고 이벤트 리스너로 클로저 함수를 반환합니다. 🎜🎜청취 클래스의 경우 createClassListener를 통해 리스너가 계속 생성됩니다.🎜rrreee🎜청취 클래스의 문자열을 통해 리스너를 생성하는 경우 현재 청취 클래스가 다음인 경우 클로저가 반환됩니다. 큐 작업이 실행되면 반환된 클로저는 실행 후 작업을 큐에 푸시합니다. 일반 청취 클래스에서 반환된 클로저인 경우 청취 객체가 생성되고 handle 메서드가 실행됩니다. 개체가 실행됩니다. 따라서 리스너는 이벤트가 등록될 때 컨텍스트를 래핑하기 위해 클로저를 반환하고, 이벤트가 트리거될 때까지 기다릴 때 작업을 수행하기 위해 클로저를 호출합니다. 🎜🎜리스너를 생성한 후 리스너 배열의 키로 해당 이벤트 이름을 사용하고 리스너의 이벤트 이름에 해당하는 배열에 배치됩니다. code> 배열 이전에 관찰자 패턴에 대해 이야기했을 때 Subject 클래스의 observers 배열과 마찬가지로 여러 listener가 있을 수 있지만 Laravel 그보다 낫습니다. listener 배열은 여러 Subject와 해당 Observer 간의 대응을 기록합니다. 🎜

이벤트 발생

🎜이벤트 이름이나 이벤트 클래스를 사용하여 이벤트를 발생시킬 수 있으며, 이 이벤트도 함께 제공되는 Event::fire(new OrdershipmentNotification)를 사용하세요. from events 서비스 🎜rrreee🎜 이벤트가 트리거된 후, 에 의해 생성된 listeners의 이벤트 이름에 해당하는 모든 listener 클로저를 찾습니다. 이전에 등록된 이벤트를 호출한 다음 이러한 클로저를 호출하여 리스너에서 작업을 수행합니다. 참고: 🎜

• 이벤트 이름 매개변수가 이벤트 객체인 경우 이벤트 객체의 클래스 이름이 이벤트 이름으로 사용되며 그 자체는 시간 매개변수로 리스너에게 전달됩니다.

• 이벤트가 트리거될 때 정지 매개변수가 전달되면 리스너가 false가 아닌 값을 반환한 후 이벤트는 나머지 리스너에게 계속 전파되지 않습니다. 그렇지 않으면 반환 값이 ​​​​of all 리스너는 모두 리스너가 실행된 후 배열로 균일하게 반환됩니다. false后那么事件就不会往下继续传播给剩余的listener了，否则所有listener的返回值会在所有listener执行往后作为一个数组统一返回。

• 如果一个listener返回了布尔值false

리스너가 부울 값 false를 반환하면 이벤트는 즉시 나머지 리스너에게 전파되는 것을 중지합니다.

Laravel의 이벤트 시스템의 원리는 이전에 언급한 관찰자 패턴과 여전히 동일하지만, 프레임워크 작성자는 매우 숙련되어 있고 영리하게 클로저를 사용하여 이벤트 시스템을 구현하고, 대기열에 있어야 하는 이벤트에 대해 애플리케이션을 이벤트 좀 더 복잡한 비즈니스 시나리오에서는 우려 분산 원칙을 사용하여 애플리케이션의 코드 논리를 효과적으로 분리할 수 있습니다. 물론 모든 상황에서 이벤트를 사용하여 코드를 작성하는 것은 적합하지 않습니다. 이벤트 중심 프로그래밍에 관심이 있다면 살펴보세요.

위 내용은 이 글의 전체 내용입니다. 모든 분들의 학습에 도움이 되었으면 좋겠습니다. 더 많은 관련 내용은 PHP 중국어 홈페이지를 주목해주세요!

관련 추천:

Laravel 사용자 인증 시스템(기본 소개)

🎜Laravel5.5 이상 다중 환경 .env 구성 읽기🎜🎜

위 내용은 Laravel 이벤트 시스템 해석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!