跳到内容

Laravel Scout

简介

Laravel Scout 提供了一个简单的、基于驱动的解决方案，用于向您的 Eloquent 模型添加全文搜索。使用模型观察器，Scout 将自动使您的搜索索引与您的 Eloquent 记录保持同步。

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

安装

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

1composer require laravel/scout

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

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

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11}

队列

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

配置队列驱动程序后，将 config/scout.php 配置文件中 queue 选项的值设置为 true

1'queue' => true,

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

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

1'queue' => [
2    'connection' => 'redis',
3    'queue' => 'scout'
4],

当然，如果您自定义 Scout 作业使用的连接和队列，则应运行队列工作进程以处理该连接和队列上的作业

1php artisan queue:work redis --queue=scout

驱动预requisites

Algolia

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

1composer require algolia/algoliasearch-client-php

Meilisearch

Meilisearch 是一个极速且开源的搜索引擎。如果您不确定如何在本地计算机上安装 Meilisearch，可以使用 Laravel Sail，Laravel 官方支持的 Docker 开发环境。

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

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

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

1SCOUT_DRIVER=meilisearch
2MEILISEARCH_HOST=http://127.0.0.1:7700
3MEILISEARCH_KEY=masterKey

有关 Meilisearch 的更多信息，请参阅 Meilisearch 文档。

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

在升级使用 Meilisearch 的应用程序上的 Scout 时，您应始终 查看 Meilisearch 服务本身的任何其他重大更改。

Typesense

Typesense 是一个闪电般快速的开源搜索引擎，支持关键字搜索、语义搜索、地理搜索和向量搜索。

您可以自托管 Typesense 或使用 Typesense Cloud。

要开始将 Typesense 与 Scout 结合使用，请通过 Composer 包管理器安装 Typesense PHP SDK

1composer require typesense/typesense-php

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

1SCOUT_DRIVER=typesense
2TYPESENSE_API_KEY=masterKey
3TYPESENSE_HOST=localhost

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

1TYPESENSE_PORT=8108
2TYPESENSE_PATH=
3TYPESENSE_PROTOCOL=http

有关 Typesense 集合的其他设置和架构定义，可以在应用程序的 config/scout.php 配置文件中找到。有关 Typesense 的更多信息，请参阅 Typesense 文档。

准备在 Typesense 中存储的数据

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

 1/**
 2 * Get the indexable data array for the model.
 3 *
 4 * @return array<string, mixed>
 5 */
 6public function toSearchableArray()
 7{
 8    return array_merge($this->toArray(),[
 9        'id' => (string) $this->id,
10        'created_at' => $this->created_at->timestamp,
11    ]);
12}

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

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

如果您的可搜索模型是软删除的，则应在应用程序的 config/scout.php 配置文件中模型对应的 Typesense 架构中定义 __soft_deleted 字段

 1User::class => [
 2    'collection-schema' => [
 3        'fields' => [
 4            // ...
 5            [
 6                'name' => '__soft_deleted',
 7                'type' => 'int32',
 8                'optional' => true,
 9            ],
10        ],
11    ],
12],

动态搜索参数

Typesense 允许您在通过 options 方法执行搜索操作时动态修改您的 搜索参数

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

配置

配置模型索引

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the name of the index associated with the model.
14     */
15    public function searchableAs(): string
16    {
17        return 'posts_index';
18    }
19}

配置可搜索数据

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the indexable data array for the model.
14     *
15     * @return array<string, mixed>
16     */
17    public function toSearchableArray(): array
18    {
19        $array = $this->toArray();
20 
21        // Customize the data array...
22 
23        return $array;
24    }
25}

某些搜索引擎（如 Meilisearch）仅对正确类型的数据执行筛选操作 (>, <, 等)。因此，当使用这些搜索引擎并自定义可搜索数据时，您应确保将数值转换为其正确的类型

1public function toSearchableArray()
2{
3    return [
4        'id' => (int) $this->id,
5        'name' => $this->name,
6        'price' => (float) $this->price,
7    ];
8}

配置索引设置 (Algolia)

有时您可能希望在 Algolia 索引上配置其他设置。虽然您可以通过 Algolia UI 管理这些设置，但有时直接从应用程序的 config/scout.php 配置文件管理索引配置的所需状态会更有效。

这种方法允许您通过应用程序的自动部署管道部署这些设置，从而避免手动配置并确保跨多个环境的一致性。您可以配置可筛选属性、排名、分面或 任何其他支持的设置。

要开始使用，请在应用程序的 config/scout.php 配置文件中为每个索引添加设置

 1use App\Models\User;
 2use App\Models\Flight;
 3 
 4'algolia' => [
 5    'id' => env('ALGOLIA_APP_ID', ''),
 6    'secret' => env('ALGOLIA_SECRET', ''),
 7    'index-settings' => [
 8        User::class => [
 9            'searchableAttributes' => ['id', 'name', 'email'],
10            'attributesForFaceting'=> ['filterOnly(email)'],
11            // Other settings fields...
12        ],
13        Flight::class => [
14            'searchableAttributes'=> ['id', 'destination'],
15        ],
16    ],
17],

如果给定索引的基础模型是软删除的，并且包含在 index-settings 数组中，Scout 将自动包含对该索引上软删除模型的分面支持。如果您没有其他分面属性要为软删除模型索引定义，您可以简单地为该模型在 index-settings 数组中添加一个空条目

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

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

1php artisan scout:sync-index-settings

配置可筛选数据和索引设置 (Meilisearch)

与 Scout 的其他驱动程序不同，Meilisearch 要求您预定义索引搜索设置，例如可筛选属性、可排序属性和 其他支持的设置字段。

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

 1use App\Models\User;
 2use App\Models\Flight;
 3 
 4'meilisearch' => [
 5    'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
 6    'key' => env('MEILISEARCH_KEY', null),
 7    'index-settings' => [
 8        User::class => [
 9            'filterableAttributes'=> ['id', 'name', 'email'],
10            'sortableAttributes' => ['created_at'],
11            // Other settings fields...
12        ],
13        Flight::class => [
14            'filterableAttributes'=> ['id', 'destination'],
15            'sortableAttributes' => ['updated_at'],
16        ],
17    ],
18],

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

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

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

1php artisan scout:sync-index-settings

配置模型 ID

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class User extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the value used to index the model.
14     */
15    public function getScoutKey(): mixed
16    {
17        return $this->email;
18    }
19 
20    /**
21     * Get the key name used to index the model.
22     */
23    public function getScoutKeyName(): mixed
24    {
25        return 'email';
26    }
27}

为每个模型配置搜索引擎

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Engines\Engine;
 7use Laravel\Scout\EngineManager;
 8use Laravel\Scout\Searchable;
 9 
10class User extends Model
11{
12    use Searchable;
13 
14    /**
15     * Get the engine used to index the model.
16     */
17    public function searchableUsing(): Engine
18    {
19        return app(EngineManager::class)->engine('meilisearch');
20    }
21}

识别用户

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

1SCOUT_IDENTIFY=true

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

数据库 / 集合引擎

数据库引擎

数据库引擎目前支持 MySQL 和 PostgreSQL。

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

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

1SCOUT_DRIVER=database

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

自定义数据库搜索策略

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

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

 1use Laravel\Scout\Attributes\SearchUsingFullText;
 2use Laravel\Scout\Attributes\SearchUsingPrefix;
 3 
 4/**
 5 * Get the indexable data array for the model.
 6 *
 7 * @return array<string, mixed>
 8 */
 9#[SearchUsingPrefix(['id', 'email'])]
10#[SearchUsingFullText(['bio'])]
11public function toSearchableArray(): array
12{
13    return [
14        'id' => $this->id,
15        'name' => $this->name,
16        'email' => $this->email,
17        'bio' => $this->bio,
18    ];
19}

在指定列应使用全文查询约束之前，请确保该列已被分配全文索引。

集合引擎

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

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

1SCOUT_DRIVER=collection

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

与数据库引擎的区别

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

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

索引

批量导入

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

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

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

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

修改导入查询

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

1use Illuminate\Database\Eloquent\Builder;
2 
3/**
4 * Modify the query used to retrieve models when making all of the models searchable.
5 */
6protected function makeAllSearchableUsing(Builder $query): Builder
7{
8    return $query->with('author');
9}

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

添加记录

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

1use App\Models\Order;
2 
3$order = new Order;
4 
5// ...
6 
7$order->save();

通过查询添加记录

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

1use App\Models\Order;
2 
3Order::where('price', '>', 100)->searchable();

您也可以在 Eloquent 关系实例上调用 searchable 方法。

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

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

1$orders->searchable();

searchable 方法可以被认为是“upsert”操作。换句话说，如果模型记录已在您的索引中，它将被更新。如果它在搜索索引中不存在，它将被添加到索引中。

更新记录

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

1use App\Models\Order;
2 
3$order = Order::find(1);
4 
5// Update the order...
6 
7$order->save();

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

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

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

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

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

1$orders->searchable();

在导入之前修改记录

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

1use Illuminate\Database\Eloquent\Collection;
2 
3/**
4 * Modify the collection of models being made searchable.
5 */
6public function makeSearchableUsing(Collection $models): Collection
7{
8    return $models->load('author');
9}

删除记录

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

1use App\Models\Order;
2 
3$order = Order::find(1);
4 
5$order->delete();

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

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

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

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

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

1$orders->unsearchable();

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

1Order::removeAllFromSearch();

暂停索引

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

1use App\Models\Order;
2 
3Order::withoutSyncingToSearch(function () {
4    // Perform model actions...
5});

有条件地搜索模型实例

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

1/**
2 * Determine if the model should be searchable.
3 */
4public function shouldBeSearchable(): bool
5{
6    return $this->isPublished();
7}

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

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

搜索

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

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->get();

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

1use App\Models\Order;
2use Illuminate\Http\Request;
3 
4Route::get('/search', function (Request $request) {
5    return Order::search($request->search)->get();
6});

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

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

自定义索引

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

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

Where 子句

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

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->where('user_id', 1)->get();

此外，whereIn 方法可用于验证给定列的值是否包含在给定的数组中。

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

whereNotIn 方法验证给定的列的值是否未包含在给定的数组中。

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

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

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

分页

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

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->paginate();

您可以通过将数量作为第一个参数传递给 paginate 方法来指定每页检索多少模型。

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

一旦您检索到结果，您可以使用 Blade 显示结果并呈现页面链接，就像您分页传统的 Eloquent 查询一样。

1<div class="container">
2    @foreach ($orders as $order)
3        {{ $order->price }}
4    @endforeach
5</div>
6 
7{{ $orders->links() }}

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

1use App\Models\Order;
2use Illuminate\Http\Request;
3 
4Route::get('/orders', function (Request $request) {
5    return Order::search($request->input('query'))->paginate(15);
6});

由于搜索引擎不知道您的 Eloquent 模型的全局作用域定义，因此您不应在使用 Scout 分页的应用程序中使用全局作用域。或者，您应该在使用 Scout 搜索时重新创建全局作用域的约束。

软删除

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

1'soft_delete' => true,

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

1use App\Models\Order;
2 
3// Include trashed records when retrieving results...
4$orders = Order::search('Star Trek')->withTrashed()->get();
5 
6// Only include trashed records when retrieving results...
7$orders = Order::search('Star Trek')->onlyTrashed()->get();

当使用 forceDelete 永久删除软删除模型时，Scout 将自动将其从搜索索引中删除。

自定义引擎搜索

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

 1use Algolia\AlgoliaSearch\SearchIndex;
 2use App\Models\Order;
 3 
 4Order::search(
 5    'Star Trek',
 6    function (SearchIndex $algolia, string $query, array $options) {
 7        $options['body']['query']['bool']['filter']['geo_distance'] = [
 8            'distance' => '1000km',
 9            'location' => ['lat' => 36, 'lon' => 111],
10        ];
11 
12        return $algolia->search($query, $options);
13    }
14)->get();

自定义 Eloquent 结果查询

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

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

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

自定义引擎

编写引擎

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

 1use Laravel\Scout\Builder;
 2 
 3abstract public function update($models);
 4abstract public function delete($models);
 5abstract public function search(Builder $builder);
 6abstract public function paginate(Builder $builder, $perPage, $page);
 7abstract public function mapIds($results);
 8abstract public function map(Builder $builder, $results, $model);
 9abstract public function getTotalCount($results);
10abstract public function flush($model);

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

注册引擎

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

 1use App\ScoutExtensions\MySqlSearchEngine;
 2use Laravel\Scout\EngineManager;
 3 
 4/**
 5 * Bootstrap any application services.
 6 */
 7public function boot(): void
 8{
 9    resolve(EngineManager::class)->extend('mysql', function () {
10        return new MySqlSearchEngine;
11    });
12}

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

1'driver' => 'mysql',

Laravel 是构建最高效的方式，用于
构建、部署和监控软件。

产品

扩展包

资源