Eloquent 模型观察者:在 Laravel 中优雅地处理模型事件
如果你之前在中大型项目中使用过 Eloquent,你可能遇到过需要在模型发生变化时采取行动的情况。Eloquent 提供了一种方便的方法来做到这一点。
观察者模式是一种软件设计模式,其中一个对象(称为主题)维护其依赖项(称为观察者)的列表,并在任何状态更改时自动通知它们,通常是通过调用它们的方法之一。 – 维基百科
在我们的例子中,Eloquent 模型可以通知我们关于给定模型的更改。
Eloquent 提供了一些有用的事件来监控模型状态:creating
,created
,updating
,updated
,deleting
,deleted
,saving
,saved
,restoring
,restored
。
注意“ing/ed”的区别:
creating
:保存新成员之前调用。created
:保存成员之后调用。Eloquent 还触发了我们可以监听的类似事件。下面的例子将监听器附加到 Member
模型的 creating
事件上。
<code class="language-php">Event::listen("eloquent.creating: App\Member", function(Member $member) { // 执行某些操作 });</code>
让我们从在 App\Observers
命名空间下创建一个新类开始,并开始定义我们的方法。
<code class="language-php">// app/Observers/MemberObserver.php namespace App\Observers; use App\Member; class MemberObserver { public function deleting(Member $member) { // 执行某些操作 } }</code>
我们可以使用事件名称作为每个方法的名称。我们不必定义所有方法,只需定义我们想要使用的方法即可。
每个成员可以订阅多个服务,每个服务包含许多成员。让我们假设我们没有为关联的 members_services
表设置级联删除,我们需要在成员删除时删除关联的服务,以避免在访问服务的已订阅成员时出现错误。
<code class="language-php">// app/Observers/MemberObserver.php namespace App\Observers; use App\Member; class MemberObserver { public function deleting(Member $member) { $member->services()->delete(); } }</code>
现在,最后一步是将此观察者附加到相应的模型。我们可以在任何我们想要的地方这样做,但是实际放置它的位置是在 app\Providers\AppProvider.php
文件中的 boot
方法内。
<code class="language-php">class AppServiceProvider extends ServiceProvider { /** * 引导任何应用程序服务。 * * @return void */ public function boot() { Member::observe(MemberObserver::class); // 使用类名注册观察者 } }</code>
我知道级联删除的例子很简单,可以在控制器中或直接通过 MySQL 完成,但这只是一个概念证明。
Eloquent 观察者的优点是我们可以通过从回调方法返回 false
值来中止当前操作:
<code class="language-php">class MemberObserver { public function deleting(Member $member) { $member->deleted_at = Carbon::now(); $member->save(); return false; } }</code>
在上面的例子中,我们正在软删除成员并返回 false
以中止实际的删除操作。
Eloquent 有许多隐藏的功能,而这是其中之一。你会看到这在大型应用程序和 CMS 中被大量使用。如果你对 Eloquent 有任何问题或评论,请务必在下面发表!
Laravel 中的 Eloquent 观察者用于处理需要在特定数据库操作之前或之后发生的业务逻辑,例如创建、更新、删除或恢复模型实例。它们提供了一种简单、有组织的方法来管理这些事件,而不是将它们分散在整个应用程序中。这使得你的代码更简洁、更易于管理和维护。
要在 Laravel 中创建 Eloquent 观察者,你首先需要创建一个观察者类。此类将包含表示你希望挂钩的 Eloquent 事件的方法。这些方法中的每一个都将模型作为其唯一参数接收。Laravel 不包含用于生成观察者的命令,因此你需要手动在你的 app/Observers
目录中创建此类。
创建观察者类后,你需要将其注册到它应该观察的模型。这通常在你的一个服务提供者的 boot
方法中完成。在此方法中,你应该调用你希望观察的模型上的 observe
方法,并传入观察者的类名。
是的,你可以使用单个观察者观察多个模型。但是,通常建议为每个模型创建一个单独的观察者,以保持代码井然有序且易于维护。如果你确实选择使用单个观察者观察多个模型,你需要确保观察者方法可以正确处理所有模型。
Laravel 的 Eloquent ORM 触发多个事件,允许你挂钩到模型生命周期的各个点。这些事件包括 retrieved
、creating
、created
、updating
、updated
、saving
、saved
、deleting
、deleted
、restoring
和 restored
。每个事件都在适当的时间触发,你的观察者方法可以监听这些事件中的任何一个或所有事件。
是的,你可以阻止 Eloquent 事件在观察者中传播。如果观察者的方法返回 false
,则不会执行该事件的其余事件监听器。如果你需要在特定条件下阻止保存或删除模型,这将非常有用。
Eloquent 观察者可用于通过监听 creating
或 updating
事件进行验证。在这些事件的观察者方法中,你可以执行任何需要的验证检查。如果验证失败,你可以返回 false
以阻止保存模型。
是的,Eloquent 观察者可以与软删除一起使用。当软删除模型正在恢复时,会触发 restoring
和 restored
事件。类似地,当模型正在软删除时,会触发 deleting
事件,当模型已软删除后,会触发 deleted
事件。
你可以使用模型上的 getOriginal
方法在观察者中访问模型的旧值。此方法返回模型属性的原始值,允许你将它们与模型的当前值进行比较。
是的,Eloquent 观察者是记录模型更改的好方法。你可以监听 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中文网其他相关文章!