Laravel Scout Meilisearch导入后Role、Creator、Updater属性缺失

环境 #

• Laravel: 12.0
• Scout: 10.13
• Scout驱动: Meilisearch
• 权限管理：spatie/laravel-permissions
• 数据表格：展示用户列表，包含role、creator、updater列

Meilisearch配置（config/scout.php） #

'meilisearch' => [
    'host' => env('MEILISEARCH_HOST', 'localhost:7700'),
    'key' => env('MEILISEARCH_KEY'),
    'index-settings' => [
        'users' => [
            'filterableAttributes' => User::getFilterableAttributes(),
            'sortableAttributes' => User::getSortableAttributes(),
        ],
    ],
],

User模型 #

class User extends Authenticatable
{
    /** @use HasFactory<\Database\Factories\UserFactory> */
    use HasApiTokens, HasFactory, Notifiable, HasRoles, SoftDeletes, HasUserStamps, Searchable, BelongsToTenant;

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

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

    protected $with = [
        'roles',
        'creator',
        'updater'
    ];

    protected function casts(): array
    {
        return [
            'email_verified_at' => 'datetime',
            'password' => 'hashed',
            'status' => 'boolean',
        ];
    }

    public function employee(): HasOne
    {
        return $this->hasOne(Employee::class);
    }

    public function getRoleAttribute()
    {
        return $this->roles->first() ? $this->roles->first()->name : null;
    }

    public function makeSearchableUsing(Collection $models): Collection
    {
        return $models->load(['roles', 'creator', 'updater']);
    }

    public function toSearchableArray()
    {
        return [
            'id' => (string) $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'roles' => $this->roles->pluck('name')->toArray(),
            'role' => $this->roles->first() ? $this->roles->first()->name : null,
            'status' => $this->status ? 'Active' : 'Inactive',
            'created_at' => $this->created_at->timestamp,
            'created_by' => $this->creator ? $this->creator->name : null,
            'updated_at' => $this->updated_at->timestamp,
            'updated_by' => $this->updater ? $this->updater->name : null,
            'organization_id' => $this->organization_id,
        ];
    }

    public static function getFilterableAttributes(): array
    {
        return [
            'role',
            'status',
            'created_by',
            'updated_by',
            'organization_id',
        ];
    }

    public static function getSortableAttributes(): array
    {
        return [
            'id',
            'name',
            'email',
            'roles',
            'role',
            'status',
            'created_at',
            'updated_at',
        ];
    }
}

问题描述 #

• role属性由getRoleAttribute访问器生成；
• creator和updater属性来自HasUserStamps trait，包含created_by/updated_by字段及对应BelongsTo关联；
• 执行导入命令后：

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

用户数据成功导入，但role、creator、updater相关字段在Meilisearch中显示为null。

1. 优化关联预加载逻辑 #

Scout批量导入时，默认的Model::all()可能不会正确触发$with中的预加载，或出现N+1查询问题。重写searchableQuery()方法，强制预加载所需关联：

public function searchableQuery()
{
    // 若创建者/更新者可能被软删除，加入withTrashed()
    return static::query()->with([
        'roles',
        'creator' => fn($query) => $query->withTrashed(),
        'updater' => fn($query) => $query->withTrashed()
    ]);
}

2. 完善makeSearchableUsing的关联加载 #

使用loadMissing()替代load()，避免重复加载已有的关联数据，提升批量处理性能：

public function makeSearchableUsing(Collection $models): Collection
{
    return $models->loadMissing([
        'roles',
        'creator' => fn($query) => $query->withTrashed(),
        'updater' => fn($query) => $query->withTrashed()
    ]);
}

3. 验证关联数据完整性 #

• 检查数据库中users表的created_by和updated_by字段是否有非null值；
• 确认作为创建者/更新者的用户存在（未被硬删除，若使用软删除则需在关联中加入withTrashed()）；
• 验证spatie/laravel-permissions的roles关联正常，用户确实分配了角色。

4. 重新导入索引 #

修改完成后，先清空现有索引再重新导入，确保旧数据被替换：

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

5. 调试（可选） #

若问题仍存在，可在toSearchableArray中加入日志，打印导入时的关联数据状态：

public function toSearchableArray()
{
    \Illuminate\Support\Facades\Log::info(
        "User {$this->id} index data",
        [
            'roles' => $this->roles->pluck('name')->toArray(),
            'creator_name' => $this->creator?->name,
            'updater_name' => $this->updater?->name
        ]
    );

    return [
        // 原有数组内容
    ];
}

查看storage/logs/laravel.log中的日志，确认关联数据是否正确加载。

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