Laravel 模型事件入门

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 知识社区 一块儿成长。