简介

Laravel Scout (opens in a new tab) 为您的 Eloquent 模型提供了一个基于驱动程序的简单解决方案，用于添加全文搜索功能。通过使用模型观察者，Scout 将自动使您的搜索索引与 Eloquent 记录保持同步。

目前，Scout 附带了 Algolia (opens in a new tab)、Meilisearch (opens in a new tab)、Typesense (opens in a new tab) 以及 MySQL / PostgreSQL（database）驱动程序。此外，Scout 还包括一个“集合”驱动程序，专为本地开发使用而设计，不需要任何外部依赖项或第三方服务。此外，编写自定义驱动程序很简单，您可以自由地使用自己的搜索实现来扩展 Scout。

安装

首先，通过 Composer 包管理器安装 Scout：

composer require laravel/scout

安装 Scout 后，您应该使用 vendor:publish Artisan 命令发布 Scout 配置文件。此命令将把 scout.php 配置文件发布到您的应用程序的 config 目录中：

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"

最后，将 Laravel\Scout\Searchable 特征添加到您想要使其可搜索的模型中。此特征将注册一个模型观察者，该观察者将自动使模型与您的搜索驱动程序保持同步：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;
}

队列处理

虽然使用 Scout 并非严格要求使用队列，但在使用该库之前，您应该强烈考虑配置一个 队列驱动程序。运行队列工作器将允许 Scout 将所有同步模型信息到搜索索引的操作排入队列，为您的应用程序的 Web 界面提供更好的响应时间。

一旦您配置了队列驱动程序，在您的 config/scout.php 配置文件中将 queue 选项的值设置为 true：

'queue' => true,

即使 queue 选项设置为 false，重要的是要记住，像 Algolia 和 Meilisearch 这样的一些 Scout 驱动程序总是异步索引记录。这意味着，即使在您的 Laravel 应用程序中索引操作已完成，搜索引擎本身可能不会立即反映新的和更新的记录。

要指定您的 Scout 作业使用的连接和队列，您可以将 queue 配置选项定义为一个数组：

'queue' => [
    'connection' => 'redis',
    'queue' => 'scout'
],

当然，如果您自定义了 Scout 作业使用的连接和队列，您应该运行一个队列工作器来处理该连接和队列上的作业：

php artisan queue:work redis --queue=scout

驱动程序前提条件

Algolia

当使用 Algolia 驱动程序时，您应该在 config/scout.php 配置文件中配置您的 Algolia id 和 secret 凭据。一旦您的凭据配置完成，您还需要通过 Composer 包管理器安装 Algolia PHP SDK：

composer require algolia/algoliasearch-client-php

Meilisearch

Meilisearch (opens in a new tab) 是一个极其快速的开源搜索引擎。如果您不确定如何在本地机器上安装 Meilisearch，您可以使用 Laravel Sail，这是 Laravel 官方支持的 Docker 开发环境。

当使用 Meilisearch 驱动程序时，您需要通过 Composer 包管理器安装 Meilisearch PHP SDK：

composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle

然后，在您的应用程序的 .env 文件中设置 SCOUT_DRIVER 环境变量以及您的 Meilisearch host 和 key 凭据：

SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey

有关 Meilisearch 的更多信息，请查阅 Meilisearch 文档 (opens in a new tab)。

此外，您应该通过查看 Meilisearch 关于二进制兼容性的文档 (opens in a new tab)，确保您安装的 meilisearch/meilisearch-php 版本与您的 Meilisearch 二进制版本兼容。

[!警告]
在使用 Meilisearch 的应用程序上升级 Scout 时，您应该始终 查看 Meilisearch 服务本身的任何其他破坏性更改 (opens in a new tab)。

Typesense

Typesense (opens in a new tab) 是一个快速的开源搜索引擎，支持关键字搜索、语义搜索、地理搜索和向量搜索。

您可以 自行托管 (opens in a new tab) Typesense 或使用 Typesense Cloud (opens in a new tab)。

要开始在 Scout 中使用 Typesense，通过 Composer 包管理器安装 Typesense PHP SDK：

composer require typesense/typesense-php

然后，在您的应用程序的 .env 文件中设置 SCOUT_DRIVER 环境变量以及您的 Typesense 主机和 API 密钥凭据：

SCOUT_DRIVER=typesense
TYPESENSE_API_KEY=masterKey
TYPESENSE_HOST=localhost

如果您使用 Laravel Sail，您可能需要调整 TYPESENSE_HOST 环境变量以匹配 Docker 容器名称。您还可以可选地指定您的安装的端口、路径和协议：

TYPESENSE_PORT=8108
TYPESENSE_PATH=
TYPESENSE_PROTOCOL=http

您的 Typesense 集合的其他设置和模式定义可以在您的应用程序的 config/scout.php 配置文件中找到。有关 Typesense 的更多信息，请查阅 Typesense 文档 (opens in a new tab)。

为在 Typesense 中存储准备数据

当使用 Typesense 时，您的可搜索模型必须定义一个 toSearchableArray 方法，该方法将您的模型的主键转换为字符串，并将创建日期转换为 UNIX 时间戳：

/**
 * 获取模型的可索引数据数组。
 *
 * @return array<string, mixed>
 */
public function toSearchableArray()
{
    return array_merge($this->toArray(),[
        'id' => (string) $this->id,
        'created_at' => $this->created_at->timestamp,
    ]);
}

您还应该在您的应用程序的 config/scout.php 文件中定义您的 Typesense 集合模式。集合模式描述了通过 Typesense 可搜索的每个字段的数据类型。有关所有可用模式选项的更多信息，请查阅 Typesense 文档 (opens in a new tab)。

如果您需要在定义 Typesense 集合的模式后进行更改，您可以运行 scout:flush 和 scout:import，这将删除所有现有的索引数据并重新创建模式。或者，您可以使用 Typesense 的 API 来修改集合的模式，而无需删除任何索引数据。

如果您的可搜索模型是软删除的，您应该在您的应用程序的 config/scout.php 配置文件中，在模型的相应 Typesense 模式中定义一个 __soft_deleted 字段：

User::class => [
    'collection-schema' => [
        'fields' => [
            //...
            [
                'name' => '__soft_deleted',
                'type' => 'int32',
                'optional' => true,
            ],
        ],
    ],
],

动态搜索参数

Typesense 允许您在通过 options 方法执行搜索操作时动态修改您的 搜索参数 (opens in a new tab)：

use App\Models\Todo;
 
Todo::search('Groceries')->options([
    'query_by' => 'title, description'
])->get();

配置

配置模型索引

每个 Eloquent 模型都与一个给定的搜索“索引”同步，该索引包含该模型的所有可搜索记录。换句话说，您可以将每个索引视为一个 MySQL 表。默认情况下，每个模型将被持久化到与模型的典型“表”名称匹配的索引中。通常，这是模型名称的复数形式；但是，您可以通过在模型上重写 searchableAs 方法来自定义模型的索引：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    /**
     * 获取与模型相关联的索引的名称。
     */
    public function searchableAs(): string
    {
        return 'posts_index';
    }
}

配置可搜索数据

默认情况下，给定模型的整个 toArray 形式将被持久化到其搜索索引中。如果您想自定义同步到搜索索引的数据，您可以在模型上重写 toSearchableArray 方法：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    /**
     * 获取模型的可索引数据数组。
     *
     * @return array<string, mixed>
     */
    public function toSearchableArray(): array
    {
        $array = $this->toArray();

        // 自定义数据数组...

        return $array;
    }
}

一些搜索引擎，如 Meilisearch，只会对正确类型的数据执行过滤操作（>，< 等）。因此，当使用这些搜索引擎并自定义您的可搜索数据时，您应该确保将数值转换为其正确的类型：

public function toSearchableArray()
{
    return [
        'id' => (int) $this->id,
        'name' => $this->name,
        'price' => (float) $this->price,
    ];
}

配置可过滤数据和索引设置（Meilisearch）

与 Scout 的其他驱动程序不同，Meilisearch 要求您预先定义索引搜索设置，例如可过滤属性、可排序属性以及其他支持的设置字段 (opens in a new tab)。

可过滤属性是您在调用 Scout 的 where 方法时计划进行过滤的任何属性，而可排序属性是您在调用 Scout 的 orderBy 方法时计划进行排序的任何属性。要定义您的索引设置，请在应用程序的 scout 配置文件中调整 meilisearch 配置项的 index-settings 部分：

use App\Models\User;
use App\Models\Flight;
 
'meilisearch' => [
    'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
    'key' => env('MEILISEARCH_KEY', null),
    'index-settings' => [
        User::class => [
            'filterableAttributes'=> ['id', 'name', 'email'],
            'sortableAttributes' => ['created_at'],
            // 其他设置字段...
        ],
        Flight::class => [
            'filterableAttributes'=> ['id', 'destination'],
            'sortableAttributes' => ['updated_at'],
        ],
    ],
],

如果给定索引所基于的模型是软删除的，并且包含在 index-settings 数组中，Scout 将自动为该索引上的软删除模型的过滤提供支持。如果对于软删除模型索引，您没有其他可过滤或可排序的属性要定义，则可以仅为该模型在 index-settings 数组中添加一个空条目：

'index-settings' => [
    Flight::class => []
],

配置应用程序的索引设置后，您必须调用 scout:sync-index-settings Artisan 命令。此命令将向 Meilisearch 通知您当前配置的索引设置。为了方便起见，您可能希望将此命令作为部署过程的一部分：

php artisan scout:sync-index-settings

配置模型 ID

默认情况下，Scout 将使用模型的主键作为存储在搜索索引中的模型的唯一 ID / 键。如果您需要自定义此行为，可以在模型上覆盖 getScoutKey 和 getScoutKeyName 方法：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class User extends Model
{
    use Searchable;

    /**
     * 获取用于索引模型的值。
     */
    public function getScoutKey(): mixed
    {
        return $this->email;
    }

    /**
     * 获取用于索引模型的键名。
     */
    public function getScoutKeyName(): mixed
    {
        return 'email';
    }
}

为每个模型配置搜索引擎

在搜索时，Scout 通常会使用应用程序的 scout 配置文件中指定的默认搜索引擎。但是，可以通过在模型上覆盖 searchableUsing 方法来更改特定模型的搜索引擎：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Engines\Engine;
use Laravel\Scout\EngineManager;
use Laravel\Scout\Searchable;

class User extends Model
{
    use Searchable;

    /**
     * 获取用于索引模型的引擎。
     */
    public function searchableUsing(): Engine
    {
        return app(EngineManager::class)->engine('meilisearch');
    }
}

识别用户

当使用Algolia (opens in a new tab)时，Scout 还允许您自动识别用户。在 Algolia 的仪表板中查看搜索分析时，将经过身份验证的用户与搜索操作相关联可能会有所帮助。您可以通过在应用程序的 .env 文件中将 SCOUT_IDENTIFY 环境变量定义为 true 来启用用户识别：

SCOUT_IDENTIFY=true

启用此功能还会将请求的 IP 地址和经过身份验证的用户的主要标识符传递给 Algolia，以便将此数据与用户进行的任何搜索请求相关联。

数据库/集合引擎

数据库引擎

[!警告]
数据库引擎目前支持 MySQL 和 PostgreSQL。

如果您的应用程序与中小型数据库进行交互或工作负载较轻，您可能会发现使用 Scout 的“数据库”引擎更方便。当从现有数据库中过滤结果以确定查询的适用搜索结果时，数据库引擎将使用“where like”子句和全文索引。

要使用数据库引擎，您可以简单地将 SCOUT_DRIVER 环境变量的值设置为 database，或者在应用程序的 scout 配置文件中直接指定 database 驱动程序：

SCOUT_DRIVER=database

一旦将数据库引擎指定为首选驱动程序，您必须配置可搜索数据。然后，您可以开始对模型执行搜索查询。使用数据库引擎时，不需要为搜索引擎索引，例如为 Algolia、Meilisearch 或 Typesense 索引播种所需的索引。

自定义数据库搜索策略

默认情况下，数据库引擎将针对您已配置为可搜索的每个模型属性执行“where like”查询。但是，在某些情况下，这可能会导致性能不佳。因此，可以配置数据库引擎的搜索策略，以便某些指定的列使用全文搜索查询或仅使用“where like”约束来搜索字符串的前缀（example%），而不是在整个字符串中搜索（%example%）。

要定义此行为，您可以为模型的 toSearchableArray 方法分配 PHP 属性。任何未分配其他搜索策略行为的列将继续使用默认的“where like”策略：

use Laravel\Scout\Attributes\SearchUsingFullText;
use Laravel\Scout\Attributes\SearchUsingPrefix;
 
/**
 * 获取模型的可索引数据数组。
 *
 * @return array<string, mixed>
 */
#[SearchUsingPrefix(['id', 'email'])]
#[SearchUsingFullText(['bio'])]
public function toSearchableArray(): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'bio' => $this->bio,
    ];
}

[!警告]
在指定应使用全文查询约束的列之前，请确保该列已分配了全文索引。

集合引擎

虽然在本地开发期间您可以自由使用 Algolia、Meilisearch 或 Typesense 搜索引擎，但您可能会发现使用“集合”引擎更方便。集合引擎将使用“where”子句和对现有数据库结果的集合过滤来确定查询的适用搜索结果。使用此引擎时，不需要为可搜索模型“索引”，因为它们将直接从本地数据库中检索。

要使用集合引擎，您可以简单地将 SCOUT_DRIVER 环境变量的值设置为 collection，或者在应用程序的 scout 配置文件中直接指定 collection 驱动程序：

SCOUT_DRIVER=collection

一旦将集合驱动程序指定为首选驱动程序，您就可以开始对模型执行搜索查询。使用集合引擎时，不需要为搜索引擎索引，例如为 Algolia、Meilisearch 或 Typesense 索引播种所需的索引。

与数据库引擎的区别

乍一看，“数据库”和“集合”引擎非常相似。它们都直接与您的数据库进行交互以检索搜索结果。但是，集合引擎不使用全文索引或 LIKE 子句来查找匹配的记录。相反，它会提取所有可能的记录，并使用 Laravel 的 Str::is 助手来确定搜索字符串是否存在于模型属性值中。

集合引擎是最便携的搜索引擎，因为它适用于 Laravel 支持的所有关系数据库（包括 SQLite 和 SQL Server）；但是，它的效率低于 Scout 的数据库引擎。

索引

批量导入

如果您将 Scout 安装到现有项目中，您可能已经有需要导入到索引中的数据库记录。Scout 提供了一个 scout:import Artisan 命令，您可以使用该命令将所有现有记录导入到搜索索引中：

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

flush 命令可用于从搜索索引中删除模型的所有记录：

php artisan scout:flush "App\Models\Post"

修改导入查询

如果您想修改用于批量导入时检索所有模型的查询，可以在模型上定义一个 makeAllSearchableUsing 方法。这是一个添加在导入模型之前可能需要的任何急切关系加载的好地方：

use Illuminate\Database\Eloquent\Builder;

/**
 * 修改在使所有模型可搜索时用于检索模型的查询。
 */
protected function makeAllSearchableUsing(Builder $query): Builder
{
    return $query->with('author');
}

[!警告]
当使用队列批量导入模型时，makeAllSearchableUsing 方法可能不适用。当作业处理模型集合时，关系不会恢复。

添加记录

一旦将 Laravel\Scout\Searchable 特征添加到模型中，您只需要 save 或 create 一个模型实例，它将自动添加到您的搜索索引中。如果您已将 Scout 配置为使用队列，则此操作将由您的队列工作者在后台执行：

use App\Models\Order;

$order = new Order;

//...

$order->save();

通过查询添加记录

如果您想通过 Eloquent 查询将模型集合添加到搜索索引中，可以将 searchable 方法链接到 Eloquent 查询上。searchable 方法将对查询结果进行分块并将记录添加到您的搜索索引中。同样，如果您已将 Scout 配置为使用队列，则所有块都将由您的队列工作者在后台导入：

use App\Models\Order;

Order::where('price', '>', 100)->searchable();

您还可以在 Eloquent 关系实例上调用 searchable 方法：

$user->orders()->searchable();

或者，如果您已经在内存中有一个 Eloquent 模型集合，则可以在集合实例上调用 searchable 方法，将模型实例添加到其相应的索引中：

$orders->searchable();

[!注意]
searchable 方法可以被视为“更新插入”操作。换句话说，如果模型记录已经在您的索引中，它将被更新。如果它不在搜索索引中，它将被添加到索引中。

更新记录

要更新可搜索模型，您只需要更新模型实例的属性并将模型保存到数据库中。Scout 将自动将更改持久化到您的搜索索引中：

use App\Models\Order;

$order = Order::find(1);

// 更新订单...

$order->save();

您还可以在 Eloquent 查询实例上调用 searchable 方法来更新模型集合。如果模型不在您的搜索索引中，它们将被创建：

Order::where('price', '>', 100)->searchable();

如果您想为关系中的所有模型更新搜索索引记录，可以在关系实例上调用 searchable 方法：

$user->orders()->searchable();

或者，如果您已经在内存中有一个 Eloquent 模型集合，则可以在集合实例上调用 searchable 方法，以更新其相应索引中的模型实例：

$orders->searchable();

在导入前修改记录

有时，您可能需要在模型可被搜索之前对模型集合进行准备。例如，您可能希望急切加载一个关系，以便可以有效地将关系数据添加到您的搜索索引中。要实现此目的，请在相应的模型上定义一个 makeSearchableUsing 方法：

use Illuminate\Database\Eloquent\Collection;

/**
 * 修改正在被设置为可搜索的模型集合。
 */
public function makeSearchableUsing(Collection $models): Collection
{
    return $models->load('author');
}

删除记录

要从您的索引中删除一条记录，您可以简单地从数据库中 删除 该模型。即使您正在使用软删除模型，也可以这样做：

use App\Models\Order;

$order = Order::find(1);

$order->delete();

如果您不想在删除记录之前检索模型，您可以在 Eloquent 查询实例上使用 unsearchable 方法：

Order::where('price', '>', 100)->unsearchable();

如果您想删除关系中所有模型的搜索索引记录，您可以在关系实例上调用 unsearchable：

$user->orders()->unsearchable();

或者，如果您已经在内存中有一个 Eloquent 模型集合，您可以在集合实例上调用 unsearchable 方法，以从其相应的索引中删除模型实例：

$orders->unsearchable();

要从其相应的索引中删除所有模型记录，您可以调用 removeAllFromSearch 方法：

Order::removeAllFromSearch();

暂停索引

有时，您可能需要在模型上执行一批 Eloquent 操作，而无需将模型数据同步到您的搜索索引。您可以使用 withoutSyncingToSearch 方法来实现此操作。此方法接受一个闭包，该闭包将立即执行。在闭包内发生的任何模型操作都不会同步到模型的索引：

use App\Models\Order;

Order::withoutSyncingToSearch(function () {
    // 执行模型操作...
});

有条件可搜索的模型实例

有时，您可能只需要在某些条件下使模型可搜索。例如，假设您有 App\Models\Post 模型，它可能处于两种状态之一："草稿"和"已发布"。您可能只希望允许"已发布"的帖子可被搜索。要实现此目的，您可以在您的模型上定义一个 shouldBeSearchable 方法：

/**
 * 确定模型是否应该可被搜索。
 */
public function shouldBeSearchable(): bool
{
    return $this->isPublished();
}

shouldBeSearchable 方法仅在通过 save 和 create 方法、查询或关系操作模型时应用。直接使用 searchable 方法使模型或集合可搜索将覆盖 shouldBeSearchable 方法的结果。

[!WARNING]
当使用 Scout 的"数据库"引擎时，shouldBeSearchable 方法不适用，因为所有可搜索数据始终存储在数据库中。当使用数据库引擎时，要实现类似的行为，您应该使用where 子句代替。

搜索

您可以使用 search 方法开始搜索模型。search 方法接受一个字符串，该字符串将用于搜索您的模型。然后，您应该将 get 方法链接到搜索查询上，以检索与给定搜索查询匹配的 Eloquent 模型：

use App\Models\Order;

$orders = Order::search('Star Trek')->get();

由于 Scout 搜索返回的是 Eloquent 模型的集合，您甚至可以直接从路由或控制器中返回结果，它们将自动转换为 JSON：

use App\Models\Order;
use Illuminate\Http\Request;

Route::get('/search', function (Request $request) {
    return Order::search($request->search)->get();
});

如果您想在将搜索结果转换为 Eloquent 模型之前获取原始搜索结果，您可以使用 raw 方法：

$orders = Order::search('Star Trek')->raw();

自定义索引

搜索查询通常将在模型的 searchableAs 方法指定的索引上执行。但是，您可以使用 within 方法指定应搜索的自定义索引：

$orders = Order::search('Star Trek')
    ->within('tv_shows_popularity_desc')
    ->get();

Where 子句

Scout 允许您向搜索查询添加简单的"where"子句。目前，这些子句仅支持基本的数字相等检查，主要用于按所有者 ID 范围搜索查询：

use App\Models\Order;

$orders = Order::search('Star Trek')->where('user_id', 1)->get();

此外，可以使用 whereIn 方法来验证给定列的值是否包含在给定的数组中：

$orders = Order::search('Star Trek')->whereIn(
    'status', ['open', 'paid']
)->get();

whereNotIn 方法验证给定列的值不包含在给定的数组中：

$orders = Order::search('Star Trek')->whereNotIn(
    'status', ['closed']
)->get();

由于搜索索引不是关系数据库，目前不支持更高级的"where"子句。

[!WARNING]
如果您的应用程序正在使用 Meilisearch，您必须在使用 Scout 的"where"子句之前配置您的应用程序的可过滤属性。

分页

除了检索模型集合外，您还可以使用 paginate 方法对搜索结果进行分页。此方法将返回一个 Illuminate\Pagination\LengthAwarePaginator 实例，就像您对传统的 Eloquent 查询进行分页一样：

use App\Models\Order;

$orders = Order::search('Star Trek')->paginate();

您可以通过将每页要检索的模型数量作为 paginate 方法的第一个参数来指定：

$orders = Order::search('Star Trek')->paginate(15);

一旦您检索到结果，您可以像对传统的 Eloquent 查询进行分页一样，使用 Blade 显示结果并渲染页面链接：

<div class="container">
    @foreach ($orders as $order)
        {{ $order->price }}
    @endforeach
</div>
 
{{ $orders->links() }}

当然，如果您想以 JSON 形式检索分页结果，您可以直接从路由或控制器中返回分页器实例：

use App\Models\Order;
use Illuminate\Http\Request;

Route::get('/orders', function (Request $request) {
    return Order::search($request->input('query'))->paginate(15);
});

[!WARNING]
由于搜索引擎不知道您的 Eloquent 模型的全局范围定义，因此在使用 Scout 分页的应用程序中，您不应使用全局范围。或者，您应该在通过 Scout 进行搜索时重新创建全局范围的约束。

软删除

如果您的索引模型是软删除的，并且您需要搜索您的软删除模型，请将 config/scout.php 配置文件的 soft_delete 选项设置为 true：

'soft_delete' => true,

当此配置选项为 true 时，Scout 不会从搜索索引中删除软删除的模型。相反，它将在索引记录上设置一个隐藏的 __soft_deleted 属性。然后，您可以在搜索时使用 withTrashed 或 onlyTrashed 方法来检索软删除的记录：

use App\Models\Order;

// 在检索结果时包括已删除的记录...
$orders = Order::search('Star Trek')->withTrashed()->get();

// 仅在检索结果时包括已删除的记录...
$orders = Order::search('Star Trek')->onlyTrashed()->get();

[!NOTE]
当使用 forceDelete 永久删除软删除的模型时，Scout 将自动从搜索索引中删除它。

自定义引擎搜索

如果您需要对引擎的搜索行为进行高级自定义，您可以将一个闭包作为 search 方法的第二个参数传递。例如，您可以使用此回调在将搜索查询传递给 Algolia 之前向您的搜索选项添加地理位置数据：

use Algolia\AlgoliaSearch\SearchIndex;
use App\Models\Order;

Order::search(
    'Star Trek',
    function (SearchIndex $algolia, string $query, array $options) {
        $options['body']['query']['bool']['filter']['geo_distance'] = [
            'distance' => '1000km',
            'location' => ['lat' => 36, 'lon' => 111],
        ];

        return $algolia->search($query, $options);
    }
)->get();

自定义 Eloquent 结果查询

在 Scout 从您的应用程序的搜索引擎中检索到匹配的 Eloquent 模型列表后，Eloquent 将用于通过其主键检索所有匹配的模型。您可以通过调用 query 方法来自定义此查询。query 方法接受一个闭包，该闭包将接收 Eloquent 查询构建器实例作为参数：

use App\Models\Order;
use Illuminate\Database\Eloquent\Builder;
 
$orders = Order::search('Star Trek')
    ->query(fn (Builder $query) => $query->with('invoices'))
    ->get();

由于此回调是在从您的应用程序的搜索引擎中已经检索到相关模型之后调用的，因此 query 方法不应用于"过滤"结果。相反，您应该使用Scout 的 where 子句。

自定义引擎

编写引擎

如果内置的 Scout 搜索引擎不符合您的需求，您可以编写自己的自定义引擎并将其注册到 Scout 中。您的引擎应该扩展 Laravel\Scout\Engines\Engine 抽象类。这个抽象类包含您的自定义引擎必须实现的八个方法：

use Laravel\Scout\Builder;

abstract public function update($models);
abstract public function delete($models);
abstract public function search(Builder $builder);
abstract public function paginate(Builder $builder, $perPage, $page);
abstract public function mapIds($results);
abstract public function map(Builder $builder, $results, $model);
abstract public function getTotalCount($results);
abstract public function flush($model);

您可能会发现查看 Laravel\Scout\Engines\AlgoliaEngine 类上这些方法的实现会有所帮助。这个类将为您提供一个很好的起点，了解如何在您自己的引擎中实现这些方法。

注册引擎

一旦您编写了自定义引擎，您可以使用 Scout 引擎管理器的 extend 方法将其注册到 Scout 中。Scout 的引擎管理器可以从 Laravel 服务容器中解析。您应该从您的 App\Providers\AppServiceProvider 类的 boot 方法或您的应用程序使用的任何其他服务提供者中调用 extend 方法：

use App\ScoutExtensions\MySqlSearchEngine;
use Laravel\Scout\EngineManager;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    resolve(EngineManager::class)->extend('mysql', function () {
        return new MySqlSearchEngine;
    });
}

一旦您的引擎已注册，您可以在您的应用程序的 config/scout.php 配置文件中将其指定为您的默认 Scout driver：

'driver' => 'mysql',