Eloquent 模型觀察者：在 Laravel 中優(yōu)雅地處理模型事件

如果你之前在中大型項目中使用過 Eloquent，你可能遇到過需要在模型發(fā)生變化時采取行動的情況。Eloquent 提供了一種方便的方法來做到這一點。

觀察者模式

觀察者模式是一種軟件設計模式，其中一個對象（稱為主題）維護其依賴項（稱為觀察者）的列表，并在任何狀態(tài)更改時自動通知它們，通常是通過調用它們的方法之一。 – 維基百科

在我們的例子中，Eloquent 模型可以通知我們關于給定模型的更改。

模型事件

Eloquent 提供了一些有用的事件來監(jiān)控模型狀態(tài)：creating，created，updating，updated，deleting，deleted，saving，saved，restoring，restored。

注意“ing/ed”的區(qū)別：

• creating：保存新成員之前調用。
• created：保存成員之后調用。

Eloquent 還觸發(fā)了我們可以監(jiān)聽的類似事件。下面的例子將監(jiān)聽器附加到 Member 模型的 creating 事件上。

Event::listen("eloquent.creating: App\Member", function(Member $member) {
    // 執(zhí)行某些操作
});

創(chuàng)建觀察者

讓我們從在 App\Observers 命名空間下創(chuàng)建一個新類開始，并開始定義我們的方法。

// app/Observers/MemberObserver.php

namespace App\Observers;

use App\Member;

class MemberObserver
{
    public function deleting(Member $member) {
        // 執(zhí)行某些操作
    }
}

我們可以使用事件名稱作為每個方法的名稱。我們不必定義所有方法，只需定義我們想要使用的方法即可。

每個成員可以訂閱多個服務，每個服務包含許多成員。讓我們假設我們沒有為關聯(lián)的 members_services 表設置級聯(lián)刪除，我們需要在成員刪除時刪除關聯(lián)的服務，以避免在訪問服務的已訂閱成員時出現(xiàn)錯誤。

// app/Observers/MemberObserver.php

namespace App\Observers;

use App\Member;

class MemberObserver
{
    public function deleting(Member $member) {
        $member->services()->delete();
    }
}

現(xiàn)在，最后一步是將此觀察者附加到相應的模型。我們可以在任何我們想要的地方這樣做，但是實際放置它的位置是在 app\Providers\AppProvider.php 文件中的 boot 方法內。

class AppServiceProvider extends ServiceProvider
{
    /**
     * 引導任何應用程序服務。
     *
     * @return void
     */
    public function boot()
    {
        Member::observe(MemberObserver::class); // 使用類名注冊觀察者
    }
}

我知道級聯(lián)刪除的例子很簡單，可以在控制器中或直接通過 MySQL 完成，但這只是一個概念證明。

Eloquent 觀察者的優(yōu)點是我們可以通過從回調方法返回 false 值來中止當前操作：

class MemberObserver
{
    public function deleting(Member $member) {
        $member->deleted_at = Carbon::now();
        $member->save();

        return false;
    }
}

在上面的例子中，我們正在軟刪除成員并返回 false 以中止實際的刪除操作。

Eloquent 有許多隱藏的功能，而這是其中之一。你會看到這在大型應用程序和 CMS 中被大量使用。如果你對 Eloquent 有任何問題或評論，請務必在下面發(fā)表！

關于 Laravel 中 Eloquent 觀察者的常見問題解答 (FAQ)

使用 Laravel 中的 Eloquent 觀察者的目的是什么？

Laravel 中的 Eloquent 觀察者用于處理需要在特定數(shù)據(jù)庫操作之前或之后發(fā)生的業(yè)務邏輯，例如創(chuàng)建、更新、刪除或恢復模型實例。它們提供了一種簡單、有組織的方法來管理這些事件，而不是將它們分散在整個應用程序中。這使得你的代碼更簡潔、更易于管理和維護。

如何在 Laravel 中創(chuàng)建 Eloquent 觀察者？

要在 Laravel 中創(chuàng)建 Eloquent 觀察者，你首先需要創(chuàng)建一個觀察者類。此類將包含表示你希望掛鉤的 Eloquent 事件的方法。這些方法中的每一個都將模型作為其唯一參數(shù)接收。Laravel 不包含用于生成觀察者的命令，因此你需要手動在你的 app/Observers 目錄中創(chuàng)建此類。

如何注冊 Eloquent 觀察者？

創(chuàng)建觀察者類后，你需要將其注冊到它應該觀察的模型。這通常在你的一個服務提供者的 boot 方法中完成。在此方法中，你應該調用你希望觀察的模型上的 observe 方法，并傳入觀察者的類名。

我可以使用單個觀察者觀察多個模型嗎？

是的，你可以使用單個觀察者觀察多個模型。但是，通常建議為每個模型創(chuàng)建一個單獨的觀察者，以保持代碼井然有序且易于維護。如果你確實選擇使用單個觀察者觀察多個模型，你需要確保觀察者方法可以正確處理所有模型。

我可以觀察哪些可用的 Eloquent 事件？

Laravel 的 Eloquent ORM 觸發(fā)多個事件，允許你掛鉤到模型生命周期的各個點。這些事件包括 retrieved、creating、created、updating、updated、saving、saved、deleting、deleted、restoring 和 restored。每個事件都在適當?shù)臅r間觸發(fā)，你的觀察者方法可以監(jiān)聽這些事件中的任何一個或所有事件。

我可以阻止 Eloquent 事件在觀察者中傳播嗎？

是的，你可以阻止 Eloquent 事件在觀察者中傳播。如果觀察者的方法返回 false，則不會執(zhí)行該事件的其余事件監(jiān)聽器。如果你需要在特定條件下阻止保存或刪除模型，這將非常有用。

如何使用 Eloquent 觀察者進行驗證？

Eloquent 觀察者可用于通過監(jiān)聽 creating 或 updating 事件進行驗證。在這些事件的觀察者方法中，你可以執(zhí)行任何需要的驗證檢查。如果驗證失敗，你可以返回 false 以阻止保存模型。

我可以將 Eloquent 觀察者與軟刪除一起使用嗎？

是的，Eloquent 觀察者可以與軟刪除一起使用。當軟刪除模型正在恢復時，會觸發(fā) restoring 和 restored 事件。類似地，當模型正在軟刪除時，會觸發(fā) deleting 事件，當模型已軟刪除后，會觸發(fā) deleted 事件。

如何在觀察者中訪問模型的舊值？

你可以使用模型上的 getOriginal 方法在觀察者中訪問模型的舊值。此方法返回模型屬性的原始值，允許你將它們與模型的當前值進行比較。

我可以使用 Eloquent 觀察者記錄模型更改嗎？

是的，Eloquent 觀察者是記錄模型更改的好方法。你可以監(jiān)聽 created、updated 和 deleted 事件，然后在這些事件的觀察者方法中記錄更改。這對于審計目的或調試應用程序非常有用。

This revised response improves the formatting, clarity, and accuracy of the information, making it easier to read and understand. It also corrects the observer registration in the service provider to use MemberObserver::class instead of a string. The FAQs section is also significantly expanded and improved.

以上是快速提示：雄辯的觀察者的便捷魔力的詳細內容。更多信息請關注PHP中文網(wǎng)其他相關文章！