Laravel模型脏属性？脏数据如何检查获取？-Laravel-PHP中文网

Laravel模型脏属性指自加载或上次保存后被修改的属性，通过isDirty()、getDirty()、getOriginal()和getChanges()方法可检测和获取变更，用于审计、条件更新等场景；其生命周期始于模型加载时original数组的创建，属性赋值时触发脏状态，保存或刷新后重置为干净状态；关联模型的变更不会自动标记主模型为脏，需单独检查或监听中间表事件；结合观察者模式可实现精细化业务逻辑与审计日志。

laravel模型脏属性？脏数据如何检查获取？

Laravel模型中的“脏属性”指的是那些在模型实例被加载或上次保存后，其值发生了变化的属性。简单来说，就是你从数据库取出来一个用户对象，然后修改了他的名字，那么这个名字属性就“脏”了。检查和获取这些脏数据，是Laravel提供的一套机制，让你能清晰地知道模型哪些地方被动了手脚，这对于审计、条件更新或触发特定业务逻辑至关重要。

解决方案

要检查和获取Laravel模型中的脏属性，我们主要依赖模型实例自带的几个方法。

当你从数据库中获取一个模型实例：

$user = App\Models\User::find(1);

登录后复制

然后你修改了它的一些属性：

$user->name = 'Jane Doe';
$user->email = 'jane.doe@example.com';

登录后复制

此刻，

name

登录后复制

和

email

登录后复制

就是脏属性。

```
isDirty()
```
登录后复制
: 这个方法可以判断模型是否有任何属性被修改。
```
$user->isDirty(); // 返回 true
$user->isDirty('name'); // 判断特定属性是否脏，返回 true
$user->isDirty(['name', 'address']); // 判断多个属性中是否有脏的，返回 true
```
登录后复制
这个方法挺好用的，尤其是在你只需要知道“有没有变化”而不需要知道“具体变了什么”的场景。
```
getDirty()
```
登录后复制
: 返回一个数组，其中包含所有被修改的属性及其新值。
```
$dirtyAttributes = $user->getDirty();
// $dirtyAttributes 会类似这样：
// [
//     'name' => 'Jane Doe',
//     'email' => 'jane.doe@example.com',
// ]
```
登录后复制
这简直是神器，直接把所有改动都给你列出来了。
```
getOriginal()
```
登录后复制
: 返回模型加载时（或上次保存后）所有属性的原始值。如果你想看某个属性的旧值，也可以传入属性名。
```
$originalName = $user->getOriginal('name'); // 获取 'name' 的原始值
$originalAttributes = $user->getOriginal(); // 获取所有原始属性
```
登录后复制
这在做变更对比时非常有用，比如要记录“从A变到B”。

getChanges()

登录后复制

: 这个方法会返回一个数组，包含所有被修改的属性，并且键是属性名，值是一个包含

original

登录后复制

和

current

登录后复制

键的数组。它其实是

getOriginal()

登录后复制

和

getDirty()

登录后复制

的一个巧妙结合。

$changes = $user->getChanges();
// $changes 会类似这样：
// [
//     'name' => [
//         'original' => 'John Doe', // 假设原始值是 John Doe
//         'current' => 'Jane Doe',
//     ],
//     'email' => [
//         'original' => 'john.doe@example.com',
//         'current' => 'jane.doe@example.com',
//     ],
// ]

登录后复制

我个人觉得

getChanges()

登录后复制

在需要详细记录变更历史时，比

getDirty()

登录后复制

配合

getOriginal()

登录后复制

更直接方便。

当你调用

$user->save()

登录后复制

方法后，模型的脏状态会被重置，所有当前属性值都会被视为“原始”值。

$user->save();
$user->isDirty(); // 返回 false

登录后复制

Laravel模型脏属性的生命周期与触发机制是什么？

理解脏属性的生命周期，其实就是理解Laravel Eloquent模型如何追踪其内部状态变化的。这并非什么魔法，它背后有一套相当直观的机制。

当一个模型实例从数据库中被检索出来时，Eloquent会悄悄地把所有属性的当前值复制一份，存储在一个内部的“原始属性”（

original

登录后复制

）数组里。这个

original

登录后复制

数组就成了模型的“基准线”。

触发机制：

属性赋值： 最常见的触发方式就是直接给模型属性赋值。比如
```
$user->name = '新名字';
```
登录后复制
。每当你这样做，Eloquent会比较新赋的值与
```
original
```
登录后复制
数组中对应属性的值。如果两者不同，那么这个属性就被标记为“脏”了。

盘古大模型
华为云推出的一系列高性能人工智能大模型

35

查看详情
```
fill()
```
登录后复制
或
update()
登录后复制
方法：当你使用
```
$user->fill($attributes)
```
登录后复制
或
```
$user->update($attributes)
```
登录后复制
批量赋值时，内部机制也是逐个属性进行比较，然后标记脏属性。
关系模型的保存： 这是一个比较容易混淆的地方。如果你修改了一个关联模型，比如
```
$user->posts()->first()->title = '新标题';
```
登录后复制
，并保存了这个
```
Post
```
登录后复制
模型，
```
Post
```
登录后复制
模型会是脏的，但
```
User
```
登录后复制
模型本身并不会自动被标记为脏。这是因为脏属性追踪的是当前模型实例自身的属性变化，而不是其关联对象的属性变化。如果你需要知道关联模型是否发生了变化，你需要单独检查那个关联模型。

生命周期：

诞生（Retrieve）： 模型从数据库加载，
```
original
```
登录后复制
属性被初始化。此时，模型是“干净”的（
```
isDirty()
```
登录后复制
返回
```
false
```
登录后复制
）。
变化（Modify）： 属性被赋值，与
```
original
```
登录后复制
比较，若不同则标记为“脏”。
查询（Inspect）： 你可以使用
```
isDirty()
```
登录后复制
,
```
getDirty()
```
登录后复制
,
```
getOriginal()
```
登录后复制
,
```
getChanges()
```
登录后复制
等方法查询脏状态和具体变更。
保存（Save）： 当你调用
```
$model->save()
```
登录后复制
或
```
$model->update()
```
登录后复制
方法成功将数据持久化到数据库后，Eloquent会更新模型的
```
original
```
登录后复制
数组，使其与当前属性值保持一致。此时，模型再次变为“干净”状态。
刷新（Refresh）： 如果你调用
```
$model->refresh()
```
登录后复制
，模型会从数据库重新加载其属性，
```
original
```
登录后复制
数组也会被更新，模型同样会变为“干净”状态。

理解这个生命周期对于编写可靠的业务逻辑非常关键，尤其是当你在模型事件监听器中处理数据时。知道什么时候模型是脏的，什么时候是干净的，可以帮助你避免很多意外情况。

如何利用脏属性实现高级的业务逻辑或审计功能？

脏属性不仅仅是用来调试的，它在实现复杂业务逻辑和审计功能时，简直是开发者的利器。

条件性业务逻辑： 想象一个场景，你有一个订单模型，只有当订单状态 (
```
status
```
登录后复制
) 从“待付款”变为“已付款”时，才需要发送支付成功通知。如果只是修改了其他无关属性，比如备注，就不需要发送。
```
use App\Models\Order;

// ...

$order = Order::find(123);
$order->status = 'paid';
$order->notes = '客户要求加急';

if ($order->isDirty('status') && $order->getOriginal('status') === 'pending' && $order->status === 'paid') {
    // 发送支付成功通知
    // Mail::to($order->user->email)->send(new PaymentSuccess($order));
    echo "发送支付成功通知！\n";
}

$order->save();
```
登录后复制
这里我们精准地利用
```
isDirty('status')
```
登录后复制
和
```
getOriginal('status')
```
登录后复制
来判断是否满足发送通知的条件。这比简单地每次保存都发送通知要智能得多。

详细的审计日志： 记录数据的每次变更，是很多业务系统的刚需。脏属性在这里能大放异彩。你可以在模型观察者 (Observer) 或模型事件 (Model Events) 中利用

getChanges()

登录后复制

来记录详细的变更日志。

假设我们有一个

UserObserver

登录后复制

：

// app/Observers/UserObserver.php
namespace App\Observers;

use App\Models\User;
use App\Models\AuditLog; // 假设有一个审计日志模型

class UserObserver
{
    public function updated(User $user)
    {
        if ($user->isDirty()) {
            $changes = $user->getChanges();

            // 记录到审计日志表
            AuditLog::create([
                'user_id' => auth()->id(), // 当前操作用户
                'model_type' => User::class,
                'model_id' => $user->id,
                'action' => 'updated',
                'changes' => json_encode($changes), // 存储变更详情
                'ip_address' => request()->ip(),
            ]);

            // 举个例子，如果密码被修改了，可能需要额外的安全操作
            if (isset($changes['password'])) {
                // Log out user from all devices, notify user etc.
                echo "用户密码被修改，执行安全操作！\n";
            }
        }
    }
}

登录后复制

然后在

AppServiceProvider

登录后复制

中注册这个观察者：

// app/Providers/AppServiceProvider.php
use App\Models\User;
use App\Observers\UserObserver;

public function boot()
{
    User::observe(UserObserver::class);
}

登录后复制

这样，每次

User

登录后复制

模型被更新时，只要有属性变脏，就会自动记录下是哪个属性从什么值变成了什么值，非常强大且自动化。

防止不必要的数据库写入： 在某些情况下，你可能希望只有当模型确实有变化时才执行
```
save()
```
登录后复制
操作，以减少不必要的数据库写入或触发不必要的副作用。
```
$user = User::find(1);
$user->name = 'John Doe'; // 假设 name 已经是 John Doe，但你不知道
$user->age = 30; // 假设 age 确实变了

if ($user->isDirty()) {
    $user->save();
    echo "模型有变化，已保存。\n";
} else {
    echo "模型无变化，无需保存。\n";
}
```
登录后复制
虽然 Eloquent 在
```
save()
```
登录后复制
内部已经做了类似优化，但这种显式检查可以让你在
```
save()
```
登录后复制
之前执行一些逻辑，例如在控制器层判断是否需要进行表单验证，或者在服务层判断是否需要调用外部API。

这些例子展示了脏属性如何在实际开发中提供精细的控制和强大的自动化能力，远超简单的CRUD操作。

处理关联模型的脏属性时有哪些常见陷阱和最佳实践？

处理关联模型（Relationships）的脏属性时，确实会遇到一些需要注意的“陷阱”，因为关联模型的状态追踪与主模型是相对独立的。理解这些，能帮助我们避免一些头疼的问题。

陷阱：关联模型变化不自动标记主模型为脏 这是最常见的误解。如果你有一个
```
User
```
登录后复制
模型和一个
```
Post
```
登录后复制
模型（
```
User
```
登录后复制
```
hasMany
```
登录后复制
```
Post
```
登录后复制
），当你修改
```
User
```
登录后复制
的某个
```
Post
```
登录后复制
的属性时，
```
User
```
登录后复制
模型本身并不会被标记为脏。
```
$user = User::find(1);
$post = $user->posts()->first();
$post->title = 'New Post Title';
$post->save(); // Post 模型被保存

$user->isDirty(); // 仍然返回 false
```
登录后复制
最佳实践： 如果你需要知道主模型关联的数据是否发生了变化，你需要明确地去检查关联模型。例如，在
```
User
```
登录后复制
模型更新时，你可能需要在其
```
updated
```
登录后复制
事件中遍历其
```
posts
```
登录后复制
集合，检查每个
```
Post
```
登录后复制
是否
```
isDirty()
```
登录后复制
。或者，如果关联关系是
```
belongsTo
```
登录后复制
，并且子模型的外键发生了变化，那么子模型的外键属性会是脏的。
陷阱：
```
sync()
```
登录后复制
和
attach()
登录后复制
/
detach()
登录后复制
对脏状态的影响对于多对多关系（
```
belongsToMany
```
登录后复制
），使用
```
sync()
```
登录后复制
、
```
attach()
```
登录后复制
或
```
detach()
```
登录后复制
方法修改中间表数据时，主模型（例如
```
User
```
登录后复制
与
```
Role
```
登录后复制
）的
```
isDirty()
```
登录后复制
方法并不会直接反映这些中间表的变化。
```
$user = User::find(1);
$user->roles()->sync([2, 3]); // 改变了用户角色

$user->isDirty(); // 仍然返回 false
```
登录后复制
最佳实践： 如果你需要追踪多对多关系的变更，你应该监听关联关系的方法调用，或者在
```
sync()
```
登录后复制
等操作前后，手动记录或比较关系状态。Laravel 提供了
```
pivot
```
登录后复制
模型的事件，你可以监听
```
pivot
```
登录后复制
模型的
```
creating
```
登录后复制
,
```
updated
```
登录后复制
,
```
deleting
```
登录后复制
等事件来追踪中间表的变更。例如，可以创建一个
```
RoleUserObserver
```
登录后复制
来监听
```
RoleUser
```
登录后复制
中间表的变动。
陷阱：集合操作后的脏状态 当你从数据库加载一个集合，例如
```
$user->posts
```
登录后复制
，并对集合中的模型进行操作时，这些操作同样不会影响
```
$user
```
登录后复制
的脏状态。
```
$user = User::find(1);
foreach ($user->posts as $post) {
    $post->content = 'Updated content';
    $post->save();
}
$user->isDirty(); // 还是 false
```
登录后复制
最佳实践： 再次强调，每个模型实例都有自己的脏属性追踪机制。如果你需要知道一个复杂操作（涉及多个关联模型）是否导致了整体数据的变化，你可能需要一个更宏观的策略，比如在服务层中，在执行操作前后对比相关数据的哈希值，或者在事务中统一处理所有变更的审计。
最佳实践：手动标记属性为脏 (
```
syncOriginalAttribute()
```
登录后复制
) 在某些高级场景下，你可能希望手动将某个属性标记为“干净”或“脏”，以影响后续的
```
isDirty()
```
登录后复制
判断。
- ```
$model->syncOriginal()
```
  登录后复制
  : 将所有当前属性值设置为原始值，使模型变为干净。这等同于
```
save()
```
  登录后复制
  后的效果。
- ```
$model->syncOriginalAttribute('attribute_name')
```
  登录后复制
  : 仅将指定属性的当前值设置为原始值。
- ```
$model->syncOriginalAttributes(['attr1', 'attr2'])
```
  登录后复制
  : 同上，针对多个属性。
- ```
$model->setOriginal(['attribute' => 'value'])
```
  登录后复制
  : 手动设置原始属性，这会影响后续
```
isDirty()
```
  登录后复制
  和
```
getChanges()
```
  登录后复制
  的结果。
例如，你可能在某个业务逻辑中，修改了一个属性，但又不希望它被
```
isDirty()
```
登录后复制
捕获，因为它只是一个临时的计算值，并不需要持久化。或者反过来，你想强制某个属性被视为脏的，即使它的值看起来没变（比如触发某个事件）。