Laravel Eloquent 条件预加载优化技巧

问题背景：$with 属性的局限性

在 Laravel 应用开发中，Eloquent ORM 提供了强大的关系映射功能，并通过预加载（Eager Loading）机制有效解决了 N+1 查询问题。通常，我们可以在模型中定义 protected $with 属性，让指定的关联关系在模型被检索时自动加载。例如，在一个 User 模型中，如果所有用户都需要加载其 domain 和 BusinessUnits 关系，可以这样定义：

// app/Models/User.php

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);
  }
}

然而，这种方法在某些场景下会引发性能问题。例如，如果只有特定类型的用户（如 domain_id 不为空的“客户”）才拥有 domain 和 BusinessUnits 关联，而其他用户（如 domain_id 为空的“员工”）则没有这些关联，那么无差别地使用 $with 将导致即使对于不需要这些关联的用户，系统也会执行额外的查询，造成资源浪费和性能下降。

尝试在 $with 数组中使用动态表达式（例如 (!$this->domain_id) ? 'domain' : null）来根据模型实例的属性进行条件判断是不可行的。protected $with 属性是一个静态数组，它在模型类加载时即被确定，无法包含基于模型实例的运行时逻辑。这种尝试会导致 PHP 编译错误：“Constant expression contains invalid operations.”，因为 $with 期望的是常量或字面量。

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

为了实现按需加载关联关系，我们可以巧妙地利用 Laravel Eloquent 提供的模型事件机制。特别是 retrieved 事件，它在模型从数据库中检索出来并被完全填充数据之后触发。这意味着我们可以在模型实例被完全填充后，根据其实际属性值来决定是否加载特定的关联。

以下是实现条件性预加载的步骤：

1. 移除 $with 属性中的条件关联

首先，将那些并非所有模型实例都需要的关联（例如 domain 和 BusinessUnits）从 protected $with 数组中移除。$with 属性应仅保留那些对所有模型实例都通用的、默认需要预加载的关联。

// app/Models/User.php

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

  protected $with = [
    // 'domain',        // 移除此行
    // 'BusinessUnits'  // 移除此行
  ];

  // ...
}

2. 在 boot 方法中监听 retrieved 事件

在模型类的 boot 静态方法中，我们可以注册一个 retrieved 事件监听器。当每个模型实例从数据库中加载完成时，该监听器会被触发。在回调函数中，我们可以访问到 $model 实例，并根据其属性（如 domain_id）进行条件判断。如果条件满足，则使用 $model->load() 方法加载所需的关联关系。

// app/Models/User.php

namespace App\Models;

use Laravel\Sanctum\HasApiTokens;
use Spatie\MediaLibrary\HasMedia;
use Illuminate\Notifications\Notifiable;
use Lab404\Impersonate\Models\Impersonate;
use Spatie\MediaLibrary\InteractsWithMedia;
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements HasMedia
{
  use Traits\BaseModelTrait; // 假设存在
  use Traits\ActiveTrait;   // 假设存在

  use InteractsWithMedia;
  use Impersonate;
  use HasApiTokens;
  use Notifiable;
  use HasFactory;

  protected $hidden = [
    'password', 'remember_token',
  ];

  protected $fillable = [
    'name', 'email', 'password', 'avatar',
  ];

  protected $casts = [
    'settings' => AsArrayObject::class,
    'is_admin' => 'boolean',
  ];

  // 移除 'domain' 和 'BusinessUnits'，仅保留通用预加载
  protected $with = [
    // 'other_universal_relations_if_any',
  ];

  /**
   * The "booted" method of the model.
   *
   * @return void
   */
  protected static function boot()
  {
    parent::boot();

    // 监听 retrieved 事件，在模型从数据库检索后触发
    static::retrieved(function ($model) {
      // 如果 domain_id 不为空，则加载 domain 和 BusinessUnits 关系
      if ($model->domain_id !== null) {
        $model->load('domain', 'BusinessUnits');
      }
    });
  }

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

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

  // 其他 Scope 定义 (保持不变)
  public function scopeAdmin($query)
  {
    return $query->where('is_admin', true);
  }

  public function scopeEmployee($query)
  {
    return $query->whereNull('domain_id');
  }

  public function scopeClient($query)
  {
    return $query->whereNotNull('domain_id');
  }
}

这种方法的优势

采用模型事件进行条件性预加载提供了以下显著优势：

• 性能优化： 只有当 domain_id 确实存在时，才会执行加载 domain 和 BusinessUnits 的额外查询。对于没有 domain_id 的用户（如“员工”），这些查询将完全被跳过，从而显著减少数据库负载和响应时间。
• 代码清晰与维护性： 将条件逻辑封装在模型内部，使得模型对自身行为的控制更加集中。$with 属性保持其作为“默认预加载”的语义，而动态加载则通过事件机制实现，职责分离清晰。
• 灵活性： retrieved 事件的回调函数中可以包含任意复杂的条件逻辑，不仅限于简单的空值检查，可以根据多个属性、甚至其他业务规则来决定是否加载特定关系。

注意事项

• load() 方法的特性： load() 方法会在模型实例上加载指定的关联。如果该关联已经被加载过（例如，通过在查询时手动调用 with() 方法），load() 方法会重新加载它，这通常不是问题，因为 Eloquent 内部会优化避免重复的数据库查询。
• 与手动 with() 的结合： 这种方法主要适用于你希望模型在被检索后“自动”根据自身状态决定加载哪些关系，而不是你每次查询都手动指定 with() 的场景。如果你在查询时显式地调用 User::with('domain')->find(1)，那么 domain 关系会通过 with() 方法预加载一次，然后 retrieved 事件中的 load('domain') 会再次尝试加载。
• 替代方案： 如果条件可以在查询构建阶段（即在获取模型实例之前）就确定，那么可以考虑使用局部作用域（Local Scopes）或自定义查询构建器方法来有条件地应用 with()。例如，可以定义一个 scopeClientWithRelations()：

  public function scopeClientWithRelations($query)
  {
      return $query->client()->with('domain', 'BusinessUnits');
  }
  // 使用时：User::clientWithRelations()->get();

  但对于已获取的单个模型实例，或者条件依赖于模型实例内部属性的复杂场景，retrieved 事件仍然是更直接和优雅的解决方案。

总结

通过巧妙地利用 Laravel Eloquent 的模型事件，特别是 retrieved 事件，我们能够实现高度灵活且性能优化的条件性预加载。这种方法避免了 $with 属性的局限性，确保只有在真正需要时才加载关联数据，从而有效提升了应用程序的效率和响应速度。在设计复杂的、具有多种类型数据关联的模型时，采用这种策略是实现高效数据管理的关键。