laravel综合话题——事件系统

最新推荐文章于 2024-07-06 17:22:41 发布
最新推荐文章于 2024-07-06 17:22:41 发布
阅读量298 收藏
点赞数
分类专栏： laravel 文章标签： php
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/szuaudi/article/details/107002259
版权

简介

Laravel 的事件提供了一个简单的观察者实现，能够订阅和监听应用中发生的各种事件。事件类保存在 app/Events 目录中，而这些事件的监听器则被保存在 app/Listeners 目录下。这些目录只有当你使用 Artisan 命令来生成事件和监听器时才会被自动创建。

观察者模式的核心是将客户端组件（观察者）从中心类（主体）中分离出来。

  • 意图：定义对象间的一种一对多的依赖关系，当一个对象的状态发生改变时，所有依赖于它的对象都得到通知并被自动更新。

  • 主要解决：一个对象状态改变给其他对象通知的问题，而且要考虑到易用和低耦合，保证高度的协作。

  • 何时使用：一个对象（目标对象）的状态发生改变，所有的依赖对象（观察者对象）都将得到通知，进行广播通知。

  • 如何解决：使用面向对象技术，可以将这种依赖关系弱化。

  • 关键代码：在抽象类里有一个 ArrayList 存放观察者们。

  • 应用实例： 1、拍卖的时候，拍卖师观察最高标价，然后通知给其他竞价者竞价。 2、西游记里面悟空请求菩萨降服红孩儿，菩萨洒了一地水招来一个老乌龟，这个乌龟就是观察者，他观察菩萨洒水这个动作。

事件系统的执行过程大致为：

  1. 定义事件和监听者；
  2. 关联事件和监听者；
  3. 客户端程序中分发事件；
  4. 监听者程序被调用；

注册事件和监听器

Laravel 应用中的 EventServiceProvider 有个 listen 数组包含所有的事件（键）以及事件对应的监听器（值）来注册所有的事件监听器，可以灵活地根据需求来添加事件。例如，让我们增加一个 OrderShipped 事件：

/**
 * 应用程序的事件监听器映射。
 *
 * @var array
 */
protected $listen = [
    'App\Events\OrderShipped' => [
        'App\Listeners\SendShipmentNotification',
    ],
];

EventServiceProvider为服务提供者类，在config/app.php文件中作为providers数组的元素被使用，laravel启动过程中，在Illuminate\Foundation\Application::registerConfiguredProviders方法中被加载。
在EventServiceProvider父类Illuminate\Foundation\Support\Providers\EventServiceProvider方法boot中，读取listen数组加载到laravel的事件系统中：

    /**
     * Register the application's event listeners.
     *
     * @return void
     */
    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);
        }
    }

Illuminate\Support\Facades\Event通过魔术方法把调用Illuminate\Events\Dispatcher的相应方法；Illuminate\Events\Dispatcher对象中保存者事件与监听者的关联关系；

手动注册事件

事件通常是在 EventServiceProvider 类的 $listen 数组中注册，但是，你也可以在 EventServiceProvider 类的boot 方法中注册基于事件的闭包。

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

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

listen方法中将会以事件名为键名、一个闭包函数（监听器）为键值添加到listeners属性数组中。

通配符事件监听器

你可以在注册监听器时使用 * 通配符参数，这样能够在同一个监听器上捕获多个事件。通配符监听器接受事件名称作为其第一个参数，并将整个事件数据数组作为其第二个参数：

Event::listen('event.*', function ($eventName, array $data) {
    //
});

使用事件名中含有通配符的事件将会被添加到$wildcards属性数组中。

定义事件

事件类其实就只是一个保存与事件相关的信息的数据容器。例如，假设我们生成的 OrderShipped 事件接收一个 Eloquent ORM 对象：

<?php

namespace App\Events;

use App\Order;
use Illuminate\Queue\SerializesModels;

class OrderShipped
{
    use SerializesModels;

    public $order;

    /**
     * 创建一个事件实例。
     *
     * @param  Order  $order
     * @return void
     */
    public function __construct(Order $order)
    {
        $this->order = $order;
    }
}

自定义的事件需要添加到EventServiceProvider的listen数组中，在laravel启动中自动被加载到Illuminate\Events\Dispatcher中。
在客户端代码中使用Event::listen方式进行注册，以fpm模式运行的laravel工程，仅在当前请求过程中有效。
下次请求会重新创建Illuminate\Events\Dispatcher类和重新从EventServiceProvider的listen数组中加载注册事件。

定义监听器

接下来，让我们看一下例子中事件的监听器。事件监听器在 handle 方法中接收事件实例。 event:generate 命令会自动加载正确的事件类和在 handle加入的类型提示。在 handle 方法中，你可以执行任何必要的响应事件的操作：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;

class SendShipmentNotification
{
    /**
     * 创建事件监听器。
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * 处理事件
     *
     * @param  OrderShipped  $event
     * @return void
     */
    public function handle(OrderShipped $event)
    {
        // 使用 $event->order 来访问 order ...
    }
}

Dispatcher的makeListener会根据监听器类型（类还是闭包函数）包装监听器：

    /**
     * Register an event listener with the dispatcher.
     *
     * @param  \Closure|string  $listener
     * @param  bool  $wildcard
     * @return \Closure
     */
    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);
            }

            return $listener(...array_values($payload));
        };
    }

如果listen方法参数中的监听器是类，将会执行createClassListener方法包装成一个闭包函数：

    /**
     * Create a class based listener using the IoC container.
     *
     * @param  string  $listener
     * @param  bool  $wildcard
     * @return \Closure
     */
    public function createClassListener($listener, $wildcard = false)
    {
        return function ($event, $payload) use ($listener, $wildcard) {
            if ($wildcard) {
                return call_user_func($this->createClassCallable($listener), $event, $payload);
            }

            return call_user_func_array(
                $this->createClassCallable($listener), $payload
            );
        };
    }

    /**
     * Create the class based event callable.
     *
     * @param  string  $listener
     * @return callable
     */
    protected function createClassCallable($listener)
    {
        list($class, $method) = $this->parseClassCallable($listener);

        if ($this->handlerShouldBeQueued($class)) {
            return $this->createQueuedHandlerCallable($class, $method);
        }

        return [$this->container->make($class), $method];
    }

    /**
     * Parse the class listener into class and method.
     *
     * @param  string  $listener
     * @return array
     */
    protected function parseClassCallable($listener)
    {
        return Str::parseCallback($listener, 'handle');
    }

createClassCallable方法会区分监听器是否应该被放入队列中执行。
parseClassCallable方法解析监听器字符串。如果只有类名，将使用handle方法作为该监听器类的回调方法。可以通过@分割类名和方法名，指定要回调的方法名称。

停止事件传播

你可以通过在监听器的 handle 方法中返回 false 来阻止事件被其他的监听器获取。

事件监听器队列

如果你的监听器中要执行诸如发送邮件或者进行 HTTP 请求等比较慢的任务，你可以选择将其丢给队列处理。在开始使用监听器队列之前，请确保在你的服务器或本地开发环境中能够配置并启动 队列 监听器。

要指定监听器启动队列，只需将 ShouldQueue 接口添加到监听器类。由 Artisan 命令 event:generate 生成的监听器已经将此接口导入到当前命名空间中，因此你可以直接使用它：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    //
}

在使用createClassCallable方法创建类回调方法时，通过handlerShouldBeQueued方法检测该类是否实现了ShouldQueue接口，从而判断是否应该放入队列中执行。

    /**
     * Determine if the event handler class should be queued.
     *
     * @param  string  $class
     * @return bool
     */
    protected function handlerShouldBeQueued($class)
    {
        try {
            return (new ReflectionClass($class))->implementsInterface(
                ShouldQueue::class
            );
        } catch (Exception $e) {
            return false;
        }
    }

createQueuedHandlerCallable将会返回一个基于队列执行的回调函数：

    /**
     * Create a callable for putting an event handler on the queue.
     *
     * @param  string  $class
     * @param  string  $method
     * @return \Closure
     */
    protected function createQueuedHandlerCallable($class, $method)
    {
        return function () use ($class, $method) {
            $arguments = array_map(function ($a) {
                return is_object($a) ? clone $a : $a;
            }, func_get_args());

            if ($this->handlerWantsToBeQueued($class, $arguments)) {
                $this->queueHandler($class, $method, $arguments);
            }
        };
    }

队列执行是一个比较复杂的过程。

分发事件

如果要分发事件，你可以将事件实例传递给辅助函数 event。这个函数将会把事件分发到所有已经注册的监听器上。因为辅助函数 event 是全局可访问的，所以你可以在应用中的任何地方调用它：

<?php

namespace App\Http\Controllers;

use App\Order;
use App\Events\OrderShipped;
use App\Http\Controllers\Controller;

class OrderController extends Controller
{
    /**
     * 将传递过来的订单发货。
     *
     * @param  int  $orderId
     * @return Response
     */
    public function ship($orderId)
    {
        $order = Order::findOrFail($orderId);

        // 订单的发货逻辑...

        event(new OrderShipped($order));
    }
}

下面是辅助方法event的定义：

if (! function_exists('event')) {
    /**
     * Dispatch an event and call the listeners.
     *
     * @param  string|object  $event
     * @param  mixed  $payload
     * @param  bool  $halt
     * @return array|null
     */
    function event(...$args)
    {
        return app('events')->dispatch(...$args);
    }
}

event方法内调用了Dispatcher的dispatch方法，下面是dispatch方法的源代码：

    /**
     * Fire an event and call the listeners.
     *
     * @param  string|object  $event
     * @param  mixed  $payload
     * @param  bool  $halt
     * @return array|null
     */
    public function dispatch($event, $payload = [], $halt = false)
    {
        // When the given "event" is actually an object we will assume it is an event
        // object and use the class as the event name and this event itself as the
        // payload to the handler, which makes object based events quite simple.
        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);

            // If a response is returned from the listener and event halting is enabled
            // we will just return this response, and not call the rest of the event
            // listeners. Otherwise we will add the response on the response list.
            if ($halt && ! is_null($response)) {
                return $response;
            }

            // If a boolean false is returned from a listener, we will stop propagating
            // the event to any further listeners down in the chain, else we keep on
            // looping through the listeners and firing every one in our sequence.
            if ($response === false) {
                break;
            }

            $responses[] = $response;
        }

        return $halt ? null : $responses;
    }

dispatch主要功能是遍历执行该事件关联的监听器。
可以发现当事件监听器回调方法返回false时，将跳出循环，不再触发之后的监听器。
getListener方法将从listeners和wildcards数组中取出包括使用通配符事件名的监听器：

    /**
     * Get all of the listeners for a given event name.
     *
     * @param  string  $eventName
     * @return array
     */
    public function getListeners($eventName)
    {
        $listeners = $this->listeners[$eventName] ?? [];

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

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

事件订阅者

编写事件订阅者

事件订阅者是一个可以在自身内部订阅多个事件的类，即能够在单个类中定义多个事件处理器。订阅者应该定义一个 subscribe 方法，这个方法接受一个事件分发器的实例。你可以调用给定的事件分发器上的 listen 方法来注册事件监听器：

<?php

namespace App\Listeners;

class UserEventSubscriber
{
    /**
     * 处理用户登录事件。
     */
    public function onUserLogin($event) {}

    /**
     * 处理用户注销事件。
     */
    public function onUserLogout($event) {}

    /**
     * 为订阅者注册监听器。
     *
     * @param  Illuminate\Events\Dispatcher  $events
     */
    public function subscribe($events)
    {
        $events->listen(
            'Illuminate\Auth\Events\Login',
            'App\Listeners\UserEventSubscriber@onUserLogin'
        );

        $events->listen(
            'Illuminate\Auth\Events\Logout',
            'App\Listeners\UserEventSubscriber@onUserLogout'
        );
    }

}

事件订阅者的主要方法是subscribe。Dispatcher类中并没有专门存储订阅者的数组，要在subscribe中使用Dispacher::listen方法一个个进行事件注册。

注册事件订阅者

订阅者写好后，就将其注册到事件分发器中。你可以在 EventServiceProvider 类的 $subscribe 属性中注册订阅者。例如，将 UserEventSubscriber 添加到数组列表中：

<?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;

class EventServiceProvider extends ServiceProvider
{
    /**
     * 应用中事件监听器的映射。
     *
     * @var array
     */
    protected $listen = [
        //
    ];

    /**
     * 需要注册的订阅者类。
     *
     * @var array
     */
    protected $subscribe = [
        'App\Listeners\UserEventSubscriber',
    ];
}

EventServiceProvider的父类的方法中，把定义的该数组传递给Dispatcher：

    /**
     * Register the application's event listeners.
     *
     * @return void
     */
    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);
        }
    }

Dispatcher的subscribe方法调用了订阅者的subscribe方法：

    /**
     * Register an event subscriber with the dispatcher.
     *
     * @param  object|string  $subscriber
     * @return void
     */
    public function subscribe($subscriber)
    {
        $subscriber = $this->resolveSubscriber($subscriber);

        $subscriber->subscribe($this);
    }

    /**
     * Resolve the subscriber instance.
     *
     * @param  object|string  $subscriber
     * @return mixed
     */
    protected function resolveSubscriber($subscriber)
    {
        if (is_string($subscriber)) {
            return $this->container->make($subscriber);
        }

        return $subscriber;
    }

最终执行的还是Dispatcher的listen方法。

szuaudi
关注
专栏目录
laravel综合话题：队列——异步消息的分发
szuaudi的博客
04-28 2855
laravel综合话题队列——异步消息的定义任务的分发DispatcherQueueManagerQueue/RedisQueue结论 由上篇laravel综合话题：队列——异步消息的定义_队列,php_szuaudi的博客-CSDN博客 我们知道，laravel通过调用dispatch方法分发任务，但实际上整个过程只是做异步消息的定义工作。在本篇中，我们探究任务类对象是怎么被持久化的。 任务的分...
laravel - 事件系统案例
qq_42872677的博客
06-11 571
laravel - 事件系统案例事件监听 - 同步操作小案例事件监听 - 异步操作小案例事件订阅 - 订阅者的使用 理解 : 通过订阅者模式实现对应用中事件的监听和订阅。是一种很好的功能或应用间的解耦方式。 相关目录 : 注册监听事件和订阅事件的文件: App\Providers\EventServiceProvider 事件所在目录 ：App\Events 监听订阅事件的动作所在目录 : App\Listeners 事件监听 - 同步操作小案例 1. 创建一个叫Demo的事件，对应App\Eve
laravel5.5事件系统
weixin_30536513的博客
02-09 164
目录 1 注册事件和监听器 2 定义事件 3 定义监听器 4 分发事件 更多使用方法 1. 可以手动注册事件 2. 事件监听器中调用队列 3.事件订阅者 1 注册事件和监听器 1、修改E...
【Laravel系列7.5】事件系统
硬核项目经理
06-09 379
事件系统说到事件，你会想到什么？JS 中的回调函数，按扭的回调事件？没错，这些都是事件的应用。不过在 Laravel 中，事件是一种解耦机制，是 观察者 模式的一种体现。它能够允许你订阅和监听在你的应用中发生的各种事件。最典型的例子，当你操作完订单后，需要发送短信、邮件或者应用内通知的时候，我们一般就会使用观察者模式来实现。而事件，则是对这一操作的封装，非常方便好用。注册...
laravel 事件系统 与 观察者模式
adf1256的博客
04-15 424
事件系统拥有多个互不依赖的监听器; 就是说你有多少的业务事件 可以开辟多少个事件与监听者的组合去处理;这样就可以有效的避免冲突 首先 我们需要注册一个时间类 比如订单的 orderEvent 在该App\Providers\EventServiceProvider文件中注册应用的事件类 orderListen 是监听该事件类的观察者类文件 框架默认没有events文件夹...
Laravel学习记录--Laravel事件系统
Sumshine12.5
01-31 1711
Laravel的事件提供了一个简单的观察者实现，能够订阅和监听应用中发生的各种事件，事件类保存在app\Events目录中，这些事件的监听器被保存在app\Listeners当然这些目录只有使用Artisan命令来生成事件和监听器时才会被自动创建。 注册事件和监听器 Larave中的app\Providers\EventServiceProvider 的listen数组 键为事件 值为事件对应的监...
laravel 使用事件系统统计浏览量的实现
01-03
最近有一个商城项目中有统计商品点击量和艺术家访问量的需求，但又不想改动太多原来的代码，而点击与访问这两个动作是有明确触发点的，正好可以用laravel中的事件系统来做，在点击和访问对应的函数中产生这俩事件，...
在此期间我被分配的任务重新创建信息系统研究所用于多年来使用以下技术:•Laravel在后面——结束•Vue.js + Ajax +引导在前面我已经创建了一个基于web的应用程序中的每一个任务相关的整个研究所和访问任何地方。- khaireddines /工业
01-27
pfe AdminDashbord Crud created and implemented implement all the old work into the admindashbord fixing some bugs about the controle and the lag was happening while refreshing the page. ...
第一个laravel项目——实现增删查改
08-20
本项目适用于初学laravel项目的人进行参考学习，我基本都注释了，配置到自己的电脑可以参考我的另一篇博客https://blog.csdn.net/weixin_44382179/article/details/119823394
PHP拍卖程序
09-20
非常好的PHP拍卖程序，需要mysql支持，酷 ！&nbsp;
php-event 文档,【laravel7.x中文文档】事件系统
weixin_32673065的博客
03-19 215
事件系统[TOC]简介Laravel 的事件提供了一个简单的观察者实现，允许你在应用中订阅和监听各种发生的事件。事件类通常放在 app/Events 目录下，而这些事件类的监听器则放在 app/Listeners 目录下。如果在你的应用中你没有看到这些目录，不用担心，它们会在你使用 Artisan 控制台命令生成事件与监听器的时候自动创建。事件系统为应用各个方面的解耦提供了非常棒的方法，因为单个事...
深入Laravel事件系统：创建与使用事件的指南
最新发布
2402_85762143的博客
07-06 548
Laravel的事件系统基于观察者模式，它允许你订阅事件并响应事件的触发。事件可以是任何类型的PHP对象，通常表示应用程序中发生的特定行为或状态变化。
Laravel 模型事件实现原理
cangqiong_xiamen的博客
08-19 400
Laravel 的 ORM 模型在一些特定的情况下，会触发一系列的事件，目前支持的事件有这些：creating, created, updating, updated, saving, saved, deleting, deleted, restoring, restored，那么在底层是如何实现这个功能的呢？ 1. 如何使用模型事件 先来看看如何使用模型事件，文档里面写了两种方法，实际上总共有三种方式可以定义一个模型事件，这里以 saved 事件来做例子，其他事件都一样。 events 属性 直接
Laravel 框架的事件机制
逍遥侯之水流云的博客
01-22 5764
Laravel 框架的事件处理机制是通过类EventServiceProvider来实现的. 建立事件 首先我需要将自己的事件和监听者注册到app\Providers目录下的EventServiceProvider类中的$listen数组中 然后运行php  artisan event:generate 命令会自动生成相应的事件类和监听者类。然后在相应的类中编写事件的逻辑和监听者的逻
laravel 事件
qq_27084325的博客
09-17 272
事件 生成一个事件类 php artisan make:event UserLogin 定义监听器 // 在 EventServiceProvider 的 $listen 中可以定义事件和监听器 protected $listen = [ 'App\Events\UserLogin' => [ 'App\Lisenter\DoSomet...
Laravel核心解读 -- 事件系统
kevin_tech的博客，微信搜「网管叨bi叨」
06-10 232
事件系统 Laravel 的事件提供了一个简单的观察者实现，能够订阅和监听应用中发生的各种事件。事件机制是一种很好的应用解耦方式，因为一个事件可以拥有多个互不依赖的监听器。laravel中事件系统由两部分构成，一个是事件的名称，事件的名称可以是个字符串，例如event.email，也可以是一个事件类，例如App\Events...
php队列
xiaonanhaijing的博客
03-14 784
// 设置超时任务 dispatch(new OrderUnpaidTimeEndJob($userId, $order->id)); 延迟5秒 <?php namespace App\Jobs; use App\Exceptions\BusinessException; use App\Services\Order\OrderServices; use App\Services\SystemServices; use Illuminate\Bus\Queueab...
Laravel事件系统驱动的登录日志记录详析
在 Laravel 开发中，利用事件系统实现登录日志记录是一种强大的功能，它可以帮助开发者在系统行为发生时执行特定操作，如数据更新或通知发送。本文将详细介绍如何通过事件系统记录登录活动，包括收集必要的信息、...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值