欢迎各位兄弟 发布技术文章

这里的技术是共享的

You are here

​Laravel 模型事件入门 简述 Laravel Model Events 的使用 有大用

Laravel 模型事件入门

96 
summerbluet 
 0.2 2018.03.28 10:41* 字数 1484 阅读 416评论 0
image.png

Laravel 模型事件允许你监听模型生命周期内的多个关键点,甚至可以在阻止一个模型的保存或者删除。 Laravel 模型事件文档 概述了如何使用钩子将对应事件与相关的事件类型关联起来,但是本文的主旨是事件与监听器的构建与设置,并额外补充一些细节的说明。

事件概述

Eloquent 有很多事件可以让你使用钩子将它们关联起来,并且增加自定义的功能到你的模型中。该模型起始时有以下事件:

  • retrieved

  • creating

  • created

  • updating

  • updated

  • saving

  • saved

  • deleting

  • deleted

  • restoring

  • restored

从文档这里我们可以了解它们都是如何实现的,你还可以进入 Model 的基类去看看它们到底是如何实现的:

当现有模型被数据库检索时, retrieved 事件将会触发。当一个新的模型被第一次保存时, creating 和 created 事件将会触发。如果对一个已经存在于数据库的模型调用 save 方法, updating / updated 事件将会触发。无论怎样,在这两种情况下, saving / saved 事件都会触发。

文档中对模型事件进行了很好的概述,同时解释了怎样使用钩子去关联事件,但是如果你是初学者,或者并不是熟悉怎样使用钩子将事件监听器与这些自定义模型事件相关联,请进一步阅读本文。

注册 事件

为了在你的模型中关联一个事件,你需要做的第一件事是使用 $dispatchesEvents 属性去注册事件对象,这最终将通过 HasEvents::fireCustomModelEvent() 方法触发, 该方法将通过 fireModelEvent() 方法被调用。 fireCustomModelEvent() 方法原始的时候大致是下面这样:

/**
 * 为给定的事件触发一个自定义模型。
 *
 * @param  string  $event
 * @param  string  $method
 * @return mixed|null
 */
protected function fireCustomModelEvent($event, $method)
{
    if (! isset($this->dispatchesEvents[$event])) {
        return;
    }

    $result = static::$dispatcher->$method(new $this->dispatchesEvents[$event]($this));

    if (! is_null($result)) {
        return $result;
    }
}

一些事件,比如 delete, 将进行检测判断是否这个事件会返回 false 然后退出操作。比如,你可以使用这个钩子去做一些检测,也可以防止一个用户被创建或删除。

使用 App\User 模型举例, 这里展示了如何配置你的模型事件:

protected $dispatchesEvents = [
    'saving' => \App\Events\UserSaving::class,
];

你可以使用 artisan make:event 命令来为你创建这个事件, 但基本上这将是你最后得到结果 :

<?php

namespace App\Events;

use App\User;
use Illuminate\Queue\SerializesModels;

class UserSaving
{
    use SerializesModels;

    public $user;

    /**
     *  创建一个新的事件实例
     *
     * @param \App\User $user
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }
}

我们的事件提供了一个公有的 $user 属性以便你能够在 saving事件期间访问 User模型实例。

为了让它工作起来下一步需要做的是为这个事件建立一个实际的监听器。我们设置好模型的触发时机,当 User模型触发 saving 事件,监听器就会被调。

创建一个事件监听器

现在,我们定义 User 模型并注册一个事件监听器来监听 saving 事件的触发。虽然,我能通过模型观察器快速实现,但是,我想引导你为单个事件触发配置事件监听器。

事件监听器就像 Laravel 其它事件监听一样,handle() 方法将接收App\Events\UserSaving 事件类的一个实例。

你可以手动创建它,也可以使用 php artisan make:listener 命令。 不管怎么样,你都将创建一个像下面这样子监听类:

<?php

namespace App\Listeners;

use App\Events\UserSaving as UserSavingEvent;

class UserSaving
{
    /**
     * 处理事件。
     *
     * @param  \App\Events\UserSavingEvent $event
     * @return mixed
     */
    public function handle(UserSavingEvent $event)
    {
        app('log')->info($event->user);
    }
}

我只是添加了一个日志记录调用,以便于检查传递给监听器的模型。为此,我们还需要在 EventServiceProvider::$listen 属性中注册监听器:

<?php

namespace App\Providers;

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

class EventServiceProvider extends ServiceProvider
{
    /**
     * 应用的事件监听器。
     * 
     * @var array
     */
    protected $listen = [
        \App\Events\UserSaving::class => [
            \App\Listeners\UserSaving::class,
        ],
    ];

    // ...
}

现在,当模型调用 saving 事件时,我们注册的事件监听器也会被触发并执行。

尝试事件监听

我们可以通过 tinker 会话快速生成事件监听代码:

php artisan tinker
>>> factory(\App\User::class)->create();
=> App\User {#794
     name: "Aiden Cremin",
     email: "josie05@example.com",
     updated_at: "2018-03-15 03:57:18",
     created_at: "2018-03-15 03:57:18",
     id: 2,
   }

如果你已正确注册了事件和监听器,则应该在 laravel.log 文件中可以看到该模型的 JSON 表达形式:

[2018-03-15 03:57:18] local.INFO: {"name":"Aiden Cremin","email":"josie05@example.com"}

要注意的一点,此时模型并没有 created_at 或 updated_at 属性。如果在模型上再次调用 save() ,日志上将会有一个带有时间戳的新记录,因为 saving 事件会在新创建的记录或现在有记录上触发:

>>> $u = factory(\App\User::class)->create();
=> App\User {#741
     name: "Eloisa Hirthe",
     email: "gottlieb.itzel@example.com",
     updated_at: "2018-03-15 03:59:37",
     created_at: "2018-03-15 03:59:37",
     id: 3,
   }
>>> $u->save();
=> true
>>>

停止一个保存操作

某些模型事件是允许你进行阻止操作的。举个荒谬的例子,假设我们不允许任何一个用户的模型保存其属性 $user->name 的内容为 Paul :

/**
 * 处理事件。
 *
 * @param  \App\Events\UserSaving $event
 * @return mixed
 */
public function handle(UserSaving $event)
{
    if (stripos($event->user->name, 'paul') !== false) {
        return false;
    }
}

在 Eloquent 的 Model::save() 方法中,会根据事件监听的返回结果判断是否进行停止保存操作:

public function save(array $options = [])
{
    $query = $this->newQueryWithoutScopes();

    // 如果 "saving" 事件返回 false ,我们将退出保存并返回
    // false,表示保存失败。这为服务监听者提供了一个机会,
    // 当验证失败或者出现其它任何情况,都可以取消保存操作。
    if ($this->fireModelEvent('saving') === false) {
        return false;
    }

这个 save() 是个很好的例子,它告诉了你如何在模型生命周期中自定义事件,以及被动执行日志数据记录或者任务调度。

使用观察者

如果你正在监听多个事件,那么你可能会发现使用观察者类来按类型分组存放事件会更加方便。这里是一个例子 Eloquent 观察者 :

<?php

namespace App\Observers;

use App\User;

class UserObserver
{
    /**
     * 监听 User 创建事件。
     *
     * @param  \App\User  $user
     * @return void
     */
    public function created(User $user)
    {
        //
    }

    /**
     * 监听 User 删除事件。
     *
     * @param  \App\User  $user
     * @return void
     */
    public function deleting(User $user)
    {
        //
    }
}

你可以在服务提供者 AppServiceProvider 中的 boot() 方法里注册观察者。

/**
 * 运行所有应用服务。
 *
 * @return void
 */
public function boot()
{
    User::observe(UserObserver::class);
}

了解更多

我建议你阅读 Laravel 事件文档 去了解有关事件和监听器在整个框架中如何工作。 Eloquent 事件文档 对于可用事件以及如何使用观察者是一个非常好的参考。最后,我建议浏览 Illuminate\Database\Eloquent\Model 类来查找 fireModelEvent() 方法调用的用法去了解事件如何与模型和 HasEvents trait 将这些事件联系在一起。

现代化 PHP 知识日新月异,尤其是 PHP7 出来以后,欢迎加入 PHP / Laravel 知识社区 一起成长。

小礼物走一走,来简书关注我

赞赏支持
     PHP / Laravel / 全栈
    Web note ad 1

    简述 Laravel Model Events 的使用

    3

    最近一直在思考如何利用 Laravel,更进一步做出一套较为不一样的开发框架出来。反复看了很多有关 Laravel 框架的资料和文档,最后还是落在 Laravel Model 层上来。

    发现 Model 还有很多值得学习的地方,其中 Events 让人眼前一亮。

    下面从「观察者模式」到「Laravel 事件系统」,再到 「Model Events」,简述 Model Events 的使用。

    观察者模式

    Define a one-to-many dependency between objects so that when one object changes state, all its dependents aer notified and updated automatically.

    定义对象间一种一对多的依赖关系,使得当一个对象改变状态,则所有依赖于它的对象都会得到通知并被自动更新。

    如上图所示(截取自《Head First Design Patterns》一书),主要包括四个部分:

    1. Subject 被观察者。是一个接口或者是抽象类,定义被观察者必须实现的职责,它必须能偶动态地增加、取消观察者,管理观察者并通知观察者。

    2. Observer 观察者。观察者接收到消息后,即进行 update 更新操作,对接收到的信息进行处理。

    3. ConcreteSubject 具体的被观察者。定义被观察者自己的业务逻辑,同时定义对哪些事件进行通知。

    4. ConcreteObserver 具体观察者。每个观察者在接收到信息后处理的方式不同,各个观察者有自己的处理逻辑。

    观察者模式优势

    观察者和被观察者之间是抽象耦合的,不管是增加观察者还是被观察者都非常容易扩展。

    根据单一职责原则,每个类的职责是单一的,那么怎么把各个单一的职责串联成真实的复杂的逻辑关系呢,观察者模式可以起到桥梁作用。

    观察者模式是松耦合的典型。

    Laravel 的事件系统

    在 Laravel 框架中,存在事件机制这种很好的应用解耦方式,因为一个事件可以拥有多个互不依赖的监听器。例如,如果你希望每次生成订单,或者订单状态由「未支付转为支付」时,向用户或者运营人员发送一个短信或者钉钉通知。你可以简单地发起一个 OrderSaving 事件,让监听器接收之后转化成一个短信或者钉钉通知,这样你就可以不用把「订单的业务代码」和「消息通知」的代码耦合在一起了,起到「解耦」的效果。

    Laravel 的事件提供了一个简单的观察者实现,能够订阅和监听应用中发生的各种事件。事件类保存在 app/Events 目录中,而这些事件的的监听器则被保存在 app/Listeners 目录下。这些目录可以使用 Artisan 命令来生成。

    根据 ServiceProvider 的作用,程序执行时,会自动加载,所以在 Laravel 的事件系统中,EventServiceProvider 充当 Events 和 Listeners 的桥接器,也就是说,利用 EventServiceProvider 可以将 Events 和 Listeners 的关联加载到系统中。

    从这也可以看出,一个 Event 对应着多个 Listeners,意味着可以被多个 Listeners 监听。

    同样的,也可以在 boot 方法中注册基于事件的闭包

    /**
     * 注册应用程序中的任何其他事件。
     *
     * @return void
     */
    public function boot()
    {
        parent::boot();
    
        Event::listen('event.name', function ($foo, $bar) {
            //
        });
    }

    下面拿 Model Event 来举例,因为 Model Event 基于 Laravel Event 系统之上。

    而且相比较 Laravel Event,在常规逻辑处理时,主要是利用全局函数 event() 来触发事件,属于手动触发机制。

    在 Model Event,则可以自定义在 Model 生命周期节点上「自动」触发事件。

    Model Events

    一个 Model 操作主要包含以下这几个生命节点:

    节点节点节点
    retrievedcreatingcreated
    updatingupdatedsaving
    saveddeletingdeleted
    restoringrestored
    The retrieved event will fire when an existing model is retrieved from the database. When a new model is saved for the first time, the creating and created events will fire. If a model already existed in the database and the save method is called, the updating / updated events will fire. However, in both cases, the saving / saved events will fire.

    相信这个比较好理解,但数据库中不存在,第一次 save 时,creating 和 created 两个事件被调用;同理,如果数据库中存在,执行 save 方法时,updating 和 updated 两个事件被调用。

    下面通过创建 Order Model 来举例说明,怎么使用 Laravel Event。

    php artisan make:model Order -m

    事件和监听器

    1. 注册 Event 和 Listener

    同样的,在 EventServiceProvider 注册关联:

    <?php
    
    namespace App\Providers;
    
    use Illuminate\Support\Facades\Event;
    use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
    
    class EventServiceProvider extends ServiceProvider
    {
        /**
         * The event listener mappings for the application.
         *
         * @var array
         */
        protected $listen = [
            'App\Events\OrderSavingEvent' => [
                'App\Listeners\OrderSavingListener',
            ],
        ];
    
        /**
         * Register any events for your application.
         *
         * @return void
         */
        public function boot()
        {
            parent::boot();
    
            //
        }
    }
    

    2. 在 Order Model 分派 Saving Event

    <?php
    
    namespace App;
    
    use App\Events\OrderSavingEvent;
    use Illuminate\Database\Eloquent\Model;
    
    class Order extends Model
    {
        protected $dispatchesEvents = [
            'saving' => OrderSavingEvent::class,
        ];
    }

    3. 创建 Event 和 Listener 类

    php artisan event:generate

    在 Saving Event 中绑定 Order

    <?php
    
    namespace App\Events;
    
    use App\Order;
    use Illuminate\Broadcasting\Channel;
    use Illuminate\Queue\SerializesModels;
    use Illuminate\Broadcasting\PrivateChannel;
    use Illuminate\Broadcasting\PresenceChannel;
    use Illuminate\Foundation\Events\Dispatchable;
    use Illuminate\Broadcasting\InteractsWithSockets;
    use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
    
    class OrderSavingEvent
    {
        use Dispatchable, InteractsWithSockets, SerializesModels;
    
        public $order;
        /**
         * Create a new event instance.
         *
         * @return void
         */
        public function __construct(Order $order) {
            $this->order = $order;
        }
    
        /**
         * Get the channels the event should broadcast on.
         *
         * @return \Illuminate\Broadcasting\Channel|array
         */
        public function broadcastOn()
        {
            return new PrivateChannel('channel-name');
        }
    }
    

    4. 编写 Listener 类,处理监听逻辑

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

    5. 测试

    $order = new Order();
    $order->name = 'good_name_2';
    
    $order->save();

    运行结果:

    [2018-03-29 12:30:24] testing.INFO: {"name":"good_name_2"}

    观察者模式

    如果在同一个 Model 下监听多个 Events,总不能每个 Event 都需要创建对应的 Listener 类吧。Laravel 提供了一个便捷的方法:创建 observer 类,把所有 Events 聚合到这个类中,然后还在 AppServiceProvider 的 boot 中,注册这个观察类:

    <?php
    
    namespace App\Providers;
    
    use App\Observers\OrderObserver;
    use App\Order;
    use Illuminate\Support\ServiceProvider;
    
    class AppServiceProvider extends ServiceProvider
    {
        /**
         * Bootstrap any application services.
         *
         * @return void
         */
        public function boot()
        {
            Order::observe(OrderObserver::class);
        }
    
        /**
         * Register any application services.
         *
         * @return void
         */
        public function register()
        {
            //
        }
    }
    

    具体 observer 类:

    <?php
    
    namespace App\Observers;
    
    
    use App\Order;
    
    class OrderObserver {
    
        /**
         * 监听订单创建事件
         * @param Order $order
         */
        public function creating(Order $order) {
            info('creating');
            info($order);
        }
    
        public function created(Order $order) {
            info('created');
            info($order);
        }
    
        /**
         * 监听订单保存事件
         * @param Order $order
         */
        public function saving(Order $order) {
            info('saving');
            info($order);
        }
    
        public function saved(Order $order) {
            info('saved');
            info($order);
        }
    }

    测试:

    $order = new Order();
    $order->name = 'good_name';
    
    $order->save();

    运行效果:

    [2018-03-27 15:04:02] testing.INFO: saving
    [2018-03-27 15:04:02] testing.INFO: {"name":"good_name"}  
    [2018-03-27 15:04:02] testing.INFO: creating  
    [2018-03-27 15:04:02] testing.INFO: {"name":"good_name"}  
    [2018-03-27 15:04:02] testing.INFO: created  
    [2018-03-27 15:04:02] testing.INFO: {"name":"good_name","updated_at":"2018-03-27 15:04:02","created_at":"2018-03-27 15:04:02","id":1}  
    [2018-03-27 15:04:02] testing.INFO: saved  
    [2018-03-27 15:04:02] testing.INFO: {"name":"good_name","updated_at":"2018-03-27 15:04:02","created_at":"2018-03-27 15:04:02","id":1}

    再次更新 order:

    $order = Order::find(1);
    $order->name = 'good_name3';
    
    $order->save();

    这时候,就不会触发 creating 和 created 事件了。运行效果:

    [2018-03-27 15:11:11] testing.INFO: saving  
    [2018-03-27 15:11:11] testing.INFO: {"id":1,"name":"good_name3","created_at":"2018-03-27 15:04:02","updated_at":"2018-03-27 15:04:02"}  
    [2018-03-27 15:11:11] testing.INFO: saved  
    [2018-03-27 15:11:11] testing.INFO: {"id":1,"name":"good_name3","created_at":"2018-03-27 15:04:02","updated_at":"2018-03-27 15:11:11"}  

    总结

    观察者模式的作用在于:观察者和被观察者之间是抽象耦合的,当一个对象改变状态,则所有依赖于它的观察者们都会得到通知并做对应的逻辑处理。Laravel 的事件系统是一个值得研究的案例。

    下一步让我们来扒一扒这背后的代码实现原理。


    来自  https://segmentfault.com/a/1190000014082263?utm_source=tag-newest


    普通分类: