如何在Laravel Scout中使用Typesense预设？

以下是针对预设未生效问题的排查和解决步骤：

• 先验证Typesense预设本身的有效性
  先抛开Laravel Scout，直接在Typesense控制台或通过API调用预设，确认预设的搜索结果符合预期。比如用curl请求：

  curl -H "X-TYPESENSE-API-KEY: your_api_key" \
    "https://your-typesense-host.com/collections/products/documents/search?preset=main_search&q=$searchTerm"
  

  如果这个请求的结果也不符合预期，那问题出在预设本身，先调整预设配置。

• 确保Laravel Scout Typesense驱动版本正确
  老版本的驱动可能存在预设参数传递的bug，执行以下命令更新到最新版本：

  composer update laravel/scout typesense/laravel-scout-typesense-driver
  

• 排查代码中的参数覆盖问题
  如果你在调用search()之后又添加了where()、orderBy()、select()等方法，这些参数会覆盖Typesense预设中的对应配置，导致预设不生效。比如：

  // 错误示例：where条件覆盖了预设的过滤规则
  $products = Product::search($searchTerm)
      ->options(['preset' => 'main_search'])
      ->where('status', 'active') // 这会覆盖预设里的过滤配置
      ->paginate(12);
  

  确保除了options(['preset' => '...'])和paginate()之外，没有额外的查询约束。

• 调试实际发送给Typesense的请求
  可以在代码中添加日志，查看Scout实际发送的请求参数。比如在AppServiceProvider的boot方法中监听Scout的Searching事件：

  use Laravel\Scout\Events\Searching;
  
  Event::listen(Searching::class, function (Searching $event) {
      \Log::info('Scout Search Request:', [
          'query' => $event->query,
          'options' => $event->options,
          'model' => get_class($event->model)
      ]);
  });
  

  查看日志中的options是否包含preset参数且值正确。如果没有，说明参数没有被正确传递，检查代码写法。

• 检查全局配置与模型配置的冲突
  查看config/scout.php中的Typesense配置，以及模型中定义的searchableFields、toSearchableArray()方法，确保这些配置没有和预设中的字段权重、过滤规则等冲突。比如模型中如果指定了searchableFields，会覆盖预设里的字段配置。

修正后的示例代码 #

确保代码中只传递预设参数，没有额外约束：

$products = Product::search($searchTerm)
    ->options(['preset' => 'main_search'])
    ->paginate(env('SEARCH_ITEMS_PER_PAGE', 12))
    ->appends($request->all());

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