Laravel 的 Events(事件) 及 Observers(观察者)

转载

mb5ff9812a47cf3 2018-03-29 09:29:00

文章标签 php ide laravel 生命周期单一职责原则 文章分类 代码人生

你是否听说过单一职责原则(single responsibility principle)？我希望是的。它是程序设计的基本原则之一，它基本上的意思就是，一个类有且只有一个职责。换句话说，一个类必须且只能做一件事，而不做其他任何事。

通常，当你构建软件的第一个版本时，一切都好说。但总会发生下面的情况。你的老板会说：是时候推出一些新的功能了。尤其是当更新意味着在这里插入一些额外的行为的时候，你的代码库会变得笨重和马虎。然后你不得不与期限、测试、 Q&A 抗争，这不是一种好的做法，对吗？

现在，在软件开发的世界中，你可以找到许多技术和方法，以优雅的方式为您的软件添加新的功能。你很可能听说过编程中的事件（Event）。

简言之，它的逻辑就像是这样：当 X 做这种行为的时候，那么 Y 必须做那种行为。

想象一下，在你的应用程序中类似的情况：当你完成了你的应用时，你说：“哦，我忘了给新用户发邮件”。

在 Eloquent 中，你有两种方式来处理这种情况。第一种方式通过模型事件 (Event) ，第二种方式基于一种更先进的概念：模型观察者 (Observers)。

在本章中，首先你会了解 Eloquent 模型中有关事件的一切，然后会介绍：什么是事件，以及何时使用它们。然后我们对模型观察者也是按这样的顺序做介绍。你会了解到所以的差异、优点及缺点。对于这两种概念，我们都将用一个实际的例子来说明在现实世界中如何使用它们。

你准备好了吗？下面就让我们开始吧。

一、何时使用事件

什么是事件？如果你在谷歌中搜索这个词，你会得到多个结果。例如，它会被定义为已经发生或被视为发生的一些事；一次事故，尤其是特别重大的。它也可以定义为发生在一段特定时期内特定地点的事。

我喜欢这两个定义，因为它们与我们的内容很符合。事实上，在某种意义上，你可以把这段特定的时期看作模型的生命周期。

你可以创建一个新的实例，更新现有实例，或删除它。你可以做的每个操作都涉及到两个事件。

从基础上来说：我刚刚创建了一条记录，我删除了那条记录，我正在更新那条记录，听起来很自然，对吗？

在当模型的生命周期中，当发生一些事的时候，Eloquent 会触发一些事件：

creating
created
updating
updated
saving
saved
deleting
deleted
restoring
restored

对于每一个操作，都对应两个独立的事件。正如你可能想象的，它们指的是单独的时刻。我们已创建操作作为实例：

你有一个 creating 事件，可以理解为“创建操作即将发生”，而 created 表示“事件已经发生了”。

科学家可能会说：

creating：是表示 t – 1 时刻
created：是与 t + 1 时刻相关

所以，对于下面三个基本操作，都有两个对应的事件：创建 (create)、更新 (update) 和删除 (delete)。

此外，你还可以看到另外两个操作：保存 (save) 和恢复 (restore)。但是，请不要担心，他们并不复杂：

Save：你只需要知道，save 操作是与 create 和 update 相关的。我们假设你需要添加一个行为，应用程序是创建一条新的记录还是更新一条已有的记录。难道对相同的事情还要声明两次吗？只需一个普通的 save 操作即可。
Restroe：当你的某个模型用到了软删除，并执行撤销操作的时候，就会用到 restore 操作。

好吧，我知道你在想什么：这个概念更深一层的含义是什么呢？我们通过实例来解答。

二、模型事件

首先我们来看看这个被称为 模型事件(model events) 的技术。它的基本概念非常简单：

在 EventServiceProvider 中你可以添加一个特定的事件监听器，并绑定一个闭包函数
在闭包函数中，你不需要接触模型代码就可以添加新的行为
绑定操作必须放在类的 boot() 方法中

这是一个把创建 (created) 用户事件与闭包函数进行绑定的简单示例。闭包的 $user 参数包含了指定用户的实例：

1. 

2.   public function boot(DispatcherContract $events)
3.   {
4.       parent::boot($events);
5.  
6.       User::created(function($user)
7.       {
8.           // doing something here, after User creation...
9.       });
10.   }
11.

正如你想象的，每一个模型都有这些方法，所以，如果你想为 saved 事件绑定一个操作的话，你必须：

1. 

2.     User::saved(function($user)
3.     {
4.         // doing something here, after User save operation (both create and update)...
5.     });
6.

另外一个有趣的功能是可以通过预方法停止当前操作。事实上，你可能会用到下面的方法：

creating
updating
saving
restoring
deleting

如果你想退出操作的话，可以返回一个布尔类型的 false 值。

假设用户邮箱以 @deniedprovider.com 结尾的话，我们就退出 create 操作，可以这么做：

1. 

2.     User::creating(function($user)
3.     {
4.       if(ends_with($user->email, '@deniedprovider.com'))
5.       {
6.         return false;
7.       }
8.     });
9.

很明显，对于 created, updated, saved, restored, 和 deleted 事件则不能这么做，这些事件已经发生了，不能返回。

三、模型事件的实例

首先我们来看看这个被称为 模型事件(model events) 的技术。它的基本概念非常简单：

在 EventServiceProvider 中你可以添加一个特定的事件监听器，并绑定一个闭包函数
在闭包函数中，你不需要接触模型代码就可以添加新的行为
绑定操作必须放在类的 boot() 方法中

这是一个把创建 (created) 用户事件与闭包函数进行绑定的简单示例。闭包的 $user 参数包含了指定用户的实例：

1. 

2.   public function boot(DispatcherContract $events)
3.   {
4.       parent::boot($events);
5.  
6.       User::created(function($user)
7.       {
8.           // doing something here, after User creation...
9.       });
10.   }
11.

正如你想象的，每一个模型都有这些方法，所以，如果你想为 saved 事件绑定一个操作的话，你必须：

1. 

2.     User::saved(function($user)
3.     {
4.         // doing something here, after User save operation (both create and update)...
5.     });
6.

另外一个有趣的功能是可以通过预方法停止当前操作。事实上，你可能会用到下面的方法：

creating
updating
saving
restoring
deleting

如果你想退出操作的话，可以返回一个布尔类型的 false 值。

假设用户邮箱以 @deniedprovider.com 结尾的话，我们就退出 create 操作，可以这么做：

1. 

2.     User::creating(function($user)
3.     {
4.       if(ends_with($user->email, '@deniedprovider.com'))
5.       {
6.         return false;
7.       }
8.     });
9.

很明显，对于 created, updated, saved, restored, 和 deleted 事件则不能这么做，这些事件已经发生了，不能返回。

四、模型观察者

我同意，模型事件非常酷，然而，有时候，你需要一些更高级的东西。

当你使用 Laravel 的时候，你基本上就是在使用面向对象编程，你可能需要做一些与模型事件相同的事，那就是模型观察者 — 一个模型事件的高级版本。

要使用它，你需要做的就是像下面这样声明一个新的类（可以放在一个叫做 observers 的专用文件夹中）：

1. 

2.   class BookObserver {
3.  
4.     public function creating($book)
5.     {
6.       // I want to create the $book book, but first...
7.     }
8.  
9.       public function saving($book)
10.       {
11.           // I want to save the $book book, but first...
12.       }
13.  
14.       public function saved($book)
15.       {
16.           // I just saved the $book book, so....
17.       }
18.  
19.   }
20.

然后在 EventServiceProvider 类的 boot() 方法中这样注册它：

1.   Book::observe(new BookObserver);

这个理的概念和前面都是相同的，没什么新的东西。通过观察者，你也可以使用前面模型事件中学到的每一个单独的概念。你可以声明任何你想要的方法，然后只需要使用事件标示符绑定一个特定的事件。因此，creating 事件是与 creating() 方法相关的，以此类推。

很明显，你可以在前置方法中终止该操作，比如说 createing() 和 updating() ：

1. 

2.   class BookObserver {
3.  
4.     public function creating($book)
5.     {
6.       $somethingGoesWrong = true;
7.  
8.       if($somethingGoesWrong)
9.       {
10.         return false;
11.       }
12.     }
13.  
14.   }
15.

好了，下面我们来看一些模型观察者的例子。

五、模型观察者的实例

首先，我们为你展示如何通过模型观察者实现前面模式事件中的第一个例子。

在 app/Observers 文件夹中创建 WelcomeUserObserver.php 文件，并加入下面的代码：

1. 

2.   <?php
3.  
4.   namespace App\Observers;
5.  
6.   class WelcomeUserObserver {
7.  
8.     public function created($user){
9.  
10.       Mail::send('emails.welcome', ['user' => $user], function($message) use ($user)
11.       {
12.           $message->to($user->email, $user->first_name . ' ' . $user->last_name)->subject('Welcome to My Awesome App, '.$user->first_name.'!');
13.       });
14.  
15.     }
16.  
17.   }
18.

然后在 EventServiceProvider 的 boot() 方法中注册该观察者：

1. 

2.   /**
3.    * Register any other events for your application.
4.    *
5.    * @param  \Illuminate\Contracts\Events\Dispatcher  $events
6.    * @return void
7.    */
8.   public function boot(DispatcherContract $events)
9.   {
10.       parent::boot($events);
11.  
12.       User::observe(new WelcomeUserObserver);
13.   }
14.

这样就 OK 了！现在你的观察者已经与模型关联起来了。

下面我们假设另一种情况。图书管理员对代码提出了一些新的需求：

当添加一个新的作者的时候，每一个用户都收到一条通知
每次添加/删除作者的时候，都发送一封邮件
最后，每次删除一本书的时候，图书管理员都要知道数据库中有多少作者是没有与相关的图书的

好了，下面我们就开始吧。我们需要三个单独的类（请记住我们的单一职责原则）：CustomerNewAuthorObserver、LibrarianAuthorObserver、AuthorsWithoutBooksObservers。

注意：你可以按自己喜欢的方式命名这些类，我们这里只是选择比较容易与所选行为关联起来的名称。

下面我们分别来创建三个类：

1. 

2. <?php
3.  
4.   // file: app/Observers/CustomerNewAuthorObserver
5.  
6.   namespace App\Observers;
7.  
8.   class CustomerNewAuthorObserver {
9.  
10.     public function created($author)
11.     {
12.  
13.     }
14.  
15.   }
16.  
17. <?php
18.  
19.   // file: app/Observers/LibrarianAuthorObserver
20.  
21.   namespace App\Observers;
22.  
23.   class LibrarianAuthorObserver {
24.  
25.     public function created($author)
26.     {
27.  
28.     }
29.  
30.     public function deleted($author)
31.     {
32.  
33.     }
34.  
35.   }
36.  
37. <?php
38.  
39.   // file: app/Observers/AuthorsWithoutBooksObservers
40.  
41.   namespace App\Observers;
42.  
43.   class AuthorsWithoutBooksObservers {
44.  
45.     public function deleted($author)
46.     {
47.  
48.     }
49.  
50.   }
51.

好了，现在应该添加一些逻辑了，首先为 CustomerNewAuthorObserver 添加：

1. 

2.   <?php
3.  
4.   // file: app/Observers/CustomerNewAuthorObserver
5.  
6.   namespace App\Observers;
7.  
8.   class CustomerNewAuthorObserver {
9.  
10.     public function created($author)
11.     {
12.       // getting all users...
13.       $users = \App\User::all();
14.  
15.       foreach($users as $user)
16.       {
17.         Mail::send('emails.created_author_customer', ['author' => $author], function($message) use ($user)
18.         {
19.             $message->to($user->email, $user->first_name . ' ' . $user->last_name)->subject('New Author Added!');
20.         });
21.       }
22.     }
23.  
24.   }
25.

注意：我知道这是一种非常简单粗暴的方法，这里只是为了实现上面的目的。实际情况中可以使用邮件队列。

1. 

2.   <?php
3.  
4.   // file: app/Observers/LibrarianAuthorObserver
5.  
6.   namespace App\Observers;
7.  
8.   class LibrarianAuthorObserver {
9.  
10.     public function created($author) {
11.       Mail::send('emails.created_author_librarian', ['author' => $author], function($message) use ($author)
12.       {
13.           $message->to('librarian@awesomelibrary.com', 'The Librarian')->subject('New Author: ' . $author->first_name . ' ' . $author->last_name);
14.       });
15.     }
16.  
17.     public function deleted($author) {
18.       Mail::send('emails.deleted_author_librarian', ['author' => $author], function($message) use ($author)
19.       {
20.           $message->to('librarian@awesomelibrary.com', 'The Librarian')->subject('New Author: ' . $author->first_name . ' ' . $author->last_name);
21.       });
22.     }
23.  
24.   }
25.

最后：

1. 

2.   <?php
3.  
4.   // file: app/Observers/AuthorsWithoutBooksObservers
5.  
6.   namespace App\Observers;
7.  
8.   class AuthorsWithoutBooksObservers {
9.  
10.     public function deleted($author) {
11.       $authorsWithoutBooks = \App\Author::has('books', '=', 0)->get();
12.  
13.       if(count($authorsWithoutBooks) > 0){
14.         Mail::send('emails.author_without_books_librarian', ['authorsWithoutBooks' => $authorsWithoutBooks], function($message)
15.         {
16.             $message->to('librarian@awesomelibrary.com', 'The Librarian')->subject('Authors without Books! A check is required!');
17.         });
18.       }
19.     }
20.  
21.   }
22.