Laravel 模型条件性预加载：优化 Eloquent 关系加载策略

问题分析：$with 属性的局限性

在 Laravel Eloquent 中，protected $with 属性提供了一种便捷的方式，可以在每次查询模型时自动加载指定的关系。例如，一个 User 模型可能定义了与 Domain 和 BusinessUnits 的关系：

class User extends Authenticatable
{
    // ... 其他属性和方法

    protected $with = [
        'domain',
        'BusinessUnits'
    ];

    public function BusinessUnits()
    {
        return $this->belongsToMany(BusinessUnit::class, 'users_business_units_pivot');
    }

    public function Domain()
    {
        return $this->belongsTo(Domain::class);
    }
}

这种设置的优点是简化了关系加载，无需在每次查询时手动调用 with() 方法。然而，其缺点在于，无论模型实例是否实际需要这些关系，它们都会被无条件加载。

考虑一个场景：只有 domain_id 不为空的“客户”用户才拥有 Domain 和 BusinessUnits 关系，而普通“员工”用户则没有。如果所有用户都被查询，即使是员工用户，Laravel 也会尝试为他们加载 domain 和 BusinessUnits，这会导致额外的、不必要的数据库查询（通常是 N+1 查询），从而降低应用性能。

开发者可能尝试通过在 $with 属性中使用条件逻辑来解决这个问题，例如：

protected $with = [
    (!$this->domain_id) ? 'domain' : null,
    (!$this->domain_id) ? 'BusinessUnits' : null
];

但这种做法是无效的，因为 $with 属性必须是一个常量表达式，不能包含动态的运行时逻辑，会导致“Constant expression contains invalid operations”错误。因此，我们需要一种在模型实例被检索后，根据其属性动态决定是否加载关系的方法。

解决方案：利用模型事件进行条件性预加载

Laravel Eloquent 模型提供了丰富的事件机制，允许我们在模型生命周期的不同阶段执行自定义逻辑。其中，retrieved 事件在模型从数据库中检索出来后触发。这正是我们实现条件性预加载的理想时机，因为此时模型实例的所有属性都已可用。

通过在模型的 boot 方法中监听 retrieved 事件，我们可以检查模型实例的特定属性（例如 domain_id），并根据条件动态加载所需的关系。

实现步骤与代码示例

1. 移除 $with 属性中的相关关系： 首先，从 User 模型的 protected $with 数组中移除 domain 和 BusinessUnits。这是至关重要的一步，因为我们希望通过事件来控制它们的加载，而不是通过 $with 的默认行为。

   class User extends Authenticatable
   {
       // ... 其他属性和方法
   
       // 移除或注释掉以下行
       // protected $with = [
       //   'domain',
       //   'BusinessUnits'
       // ];
   
       // ...
   }

   登录后复制

2. 在模型中添加 boot 方法并监听 retrieved 事件： 在 User 模型中，重写静态 boot 方法。在该方法内部，调用 parent::boot() 以确保父类的启动逻辑被执行，然后使用 self::retrieved 方法注册一个回调函数。

   namespace App\Models;
   
   use Illuminate\Database\Eloquent\Factories\HasFactory;
   use Illuminate\Foundation\Auth\User as Authenticatable;
   // ... 其他 use 声明
   
   class User extends Authenticatable
   {
       // ... 其他属性和方法
   
       /**
        * The "booting" method of the model.
        *
        * @return void
        */
       protected static function boot()
       {
           parent::boot();
   
           // 监听 retrieved 事件
           self::retrieved(function ($model) {
               // 检查 domain_id 是否不为 null
               if ($model->domain_id !== null) {
                   // 如果是客户用户，则加载 domain 和 BusinessUnits 关系
                   $model->load('domain', 'BusinessUnits');
               }
           });
       }
   
       // ... 其他关系和方法
   }

   登录后复制

工作原理

当 Laravel 从数据库中获取一个 User 模型实例时：

1. retrieved 事件会被触发。
2. 我们注册的回调函数被执行，并接收到当前的模型实例 $model。
3. 在回调函数内部，我们检查 $model->domain_id 的值。
4. 如果 domain_id 不为 null（表示这是一个客户用户），我们调用 $model->load('domain', 'BusinessUnits') 方法来动态地加载这两个关系。
5. 如果 domain_id 为 null（表示这是一个员工用户），则不会执行 load 方法，从而避免了不必要的查询。

注意事项

• 性能考量： 尽管 retrieved 事件会在每个被检索的模型实例上触发，但对于大多数应用而言，这种条件性加载的开销远小于无条件加载所有关系所带来的 N+1 查询问题。它有效地将不必要的数据库查询从每次模型检索中移除。
• 适用场景： 这种方法特别适用于那些模型关系只对模型子集有意义的场景，例如不同用户类型、不同商品状态等。
• 替代方案（按需加载）： 对于更灵活的按需加载，可以在控制器或服务层显式使用 with() 方法。但如果某个关系对于特定类型的模型实例是“总是需要”的，那么 retrieved 事件提供了一种更自动化、更集中的管理方式。
• 避免循环加载： 确保你的条件逻辑不会导致无限循环或不必要的复杂性。在这个例子中，domain_id 是一个简单的属性检查，不会引入复杂依赖。

总结

通过利用 Laravel Eloquent 的模型事件机制，特别是 retrieved 事件，我们能够优雅地实现模型关系的条件性预加载。这种方法避免了 $with 属性的局限性，解决了不必要的数据库查询问题，从而显著优化了 Laravel 应用的性能。它提供了一种强大且灵活的方式来根据模型实例的运行时状态动态管理其关联数据的加载，使得代码更高效、更具可维护性。

以上就是Laravel 模型条件性预加载：优化 Eloquent 关系加载策略的详细内容，更多请关注php中文网其它相关文章！