Laravel Scout toSearchableArray映射关联字段报null错误问题

toSearchableArray 原生支持映射关联模型字段，你遇到的报错与Scout本身能力无关，是代码未兼容关联为空的场景导致的。

• 报错根因
  拼接索引数组时直接读取$this->account->zip，但部分User记录没有对应的HasOne关联Member数据，此时$this->account返回值为null，读取null对象的属性就会触发Attempt to read property "zip" on null错误。

• 修复字段映射逻辑
  访问关联属性时增加空值兼容，避免关联不存在时抛出错误，示例代码如下：

  // User模型内的toSearchableArray方法定义
  public function toSearchableArray()
  {
      return [
          'name' => $this->name,
          // PHP8+可使用空安全操作符，关联为空时plz字段自动赋值为null
          'plz' => $this->account?->zip,
          // 其余需要加入搜索索引的自身字段
      ];
  }
  

  PHP7.x环境可使用框架自带的optional()辅助函数实现相同兼容效果：'plz' => optional($this->account)->zip

• 批量导入性能优化
  执行Scout全量索引导入时，默认不会自动加载关联数据，会产生大量N+1查询。可在User模型中重写makeAllSearchableUsing方法预加载关联，大幅提升导入效率：

  protected function makeAllSearchableUsing($query)
  {
      return $query->with('account');
  }
  

• 关联数据索引同步配置
  Scout默认仅在当前模型自身数据增删改时触发索引更新，由于你的索引中存储了关联Member模型的zip字段，需要在Member模型的生命周期事件中手动触发关联User的索引更新，避免索引数据与实际数据不一致，示例代码如下：

  // Member模型内注册事件回调
  protected static function booted()
  {
      static::saved(function (Member $member) {
          $member->user?->searchable();
      });
  
      static::deleted(function (Member $member) {
          $member->user?->searchable();
      });
  }
  

  注意这里需要提前在Member模型中定义好对应的User关联方法。

• 存量索引修复
  代码修改完成后，先清空原有错误索引，再重新导入全量数据即可生效：

  php artisan scout:flush "App\Models\User"
  php artisan scout:import "App\Models\User"
  

内容的提问来源于stack exchange，提问作者fefe