Laravel Scout结合Meilisearch：如何检查模型索引是否存在？

针对你遇到的「数据库无数据时执行scout:import不会创建索引，导致搜索报错」的问题，提供以下几种方案：

方案1：直接通过Meilisearch客户端检查索引存在性 #

Laravel Scout的Meilisearch驱动基于官方PHP客户端，你可以直接初始化客户端并调用indexExists方法：

use Meilisearch\Client;
use App\Models\Task;

// 获取模型对应的索引名（默认是表名，也可通过模型的searchableAs()自定义）
$indexName = (new Task)->searchableAs();

// 用配置文件中的Meilisearch参数初始化客户端
$client = new Client(
    config('scout.meilisearch.host'),
    config('scout.meilisearch.key')
);

// 检查索引是否存在
$indexExists = $client->indexExists($indexName);

// 结合你的业务逻辑
$tasks = $indexExists
    ? Task::search(trim($query) ?? '')
        ->take(self::NUMBER_OF_SEARCHRESULTS_PER_MODEL)
        ->get()
    : collect();

方案2：扩展Scout Builder类，添加indexExists方法 #

如果你希望像示例代码那样直接通过Scout Builder调用indexExists，可以自定义Builder类：

1. 创建自定义Builder：

namespace App\Search;

use Laravel\Scout\Builder;
use Meilisearch\Client;

class CustomMeilisearchBuilder extends Builder
{
    public function indexExists(): bool
    {
        $client = new Client(
            config('scout.meilisearch.host'),
            config('scout.meilisearch.key')
        );

        return $client->indexExists($this->model->searchableAs());
    }
}

2. 在Task模型中重写search方法，返回自定义Builder：

namespace App\Models;

use App\Search\CustomMeilisearchBuilder;
use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Task extends Model
{
    use Searchable;

    public static function search($query = ''): CustomMeilisearchBuilder
    {
        return new CustomMeilisearchBuilder(new static, $query);
    }
}

3. 现在你可以直接使用最初设想的代码：

$tasksScoutBuilder = Task::search(trim($query) ?? '');

$tasks = $tasksScoutBuilder->indexExists()
    ? $tasksScoutBuilder->take(self::NUMBER_OF_SEARCHRESULTS_PER_MODEL)->get()
    : collect();

方案3：捕获索引不存在的异常 #

考虑到检查索引和执行搜索之间可能存在竞态（比如索引被意外删除），捕获异常是更稳妥的方式：

use MeiliSearch\Exceptions\ApiException;
use App\Models\Task;

try {
    $tasks = Task::search(trim($query) ?? '')
        ->take(self::NUMBER_OF_SEARCHRESULTS_PER_MODEL)
        ->get();
} catch (ApiException $e) {
    // 判断是否为索引不存在的错误
    if (str_contains($e->getMessage(), 'Index not found')) {
        $tasks = collect();
    } else {
        // 其他异常重新抛出
        throw $e;
    }
}

额外说明：空数据集不创建索引的原因 #

Meilisearch的设计逻辑是：当导入空数据集时，不会创建对应索引（因为没有可存储的文档）。如果需要强制创建空索引，可以在检查到索引不存在时手动创建：

if (!$client->indexExists($indexName)) {
    $client->createIndex($indexName);
}

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