Laravel Scout 提供了一个简单、基于驱动的解决方案,用于为您的 Eloquent 模型 添加全文搜索。利用模型观察器,Scout 将自动使您的搜索索引与您的 Eloquent 记录保持同步。
当前, Scout 附带 Algolia, Meilisearch, Typesense, 以及 MySQL / PostgreSQL (database) 驱动程序. 此外, Scout 还包含一个“collection”驱动程序, 专为本地开发用途设计, 并且不需要任何外部依赖或第三方服务. 此外, 编写自定义驱动程序很简单, 你可以自由地用自己的搜索实现来扩展 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;
}当使用的引擎不是database或collection引擎时,您应该强烈考虑在使用该库之前配置一个[队列驱动](/zh-cn/docs/laravel/12.x/queues)。运行队列工作器将允许 Scout 将所有同步模型信息到搜索索引的操作排队,提供 更好的响应时间 为 您的 应用程序的 Web 界面 。
一旦你配置了一个队列驱动程序,在你的 config/scout.php 配置文件中将 queue 选项的值设置为 true:
'queue' => true,即使 queue 选项设置为 false,仍需记住,某些 Scout 驱动如 Algolia 和 Meilisearch 总是异步索引记录。这意味着,即使索引操作已在你的 Laravel 应用程序中完成,搜索引擎本身也可能不会立即反映出新增和更新的记录。
要指定您的 Scout 作业所使用的连接和队列,您可以将 queue 配置选项定义为一个数组:
'queue' => [
'connection' => 'redis',
'queue' => 'scout'
],当然,如果您自定义了供 Scout 作业使用的连接和队列,您应该运行一个队列工作器来处理该连接和队列上的作业:
php artisan queue:work redis --queue=scout使用 Algolia 驱动时,您应该在您的 config/scout.php 配置文件中配置您的 Algolia id 和 secret 凭据。凭据配置完成后,您还需要通过 Composer 包管理器安装 Algolia PHP SDK:
composer require algolia/algoliasearch-client-phpMeilisearch 是一个疾速的开源搜索引擎。如果您不确定如何在本地机器上安装 Meilisearch,您可以使用 Laravel Sail,Laravel 官方支持的 Docker 开发环境。
当使用 Meilisearch 驱动时,您需要通过 Composer 包管理器安装 Meilisearch PHP SDK:
composer require meilisearch/meilisearch-php http-interop/http-factory-guzzleThen, set the SCOUT_DRIVER environment variable as well as your Meilisearch host and key credentials within your application's .env file:
SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey有关 Meilisearch 的更多信息,请查阅 Meilisearch 文档.
此外,您应确保安装与您的 Meilisearch 二进制版本兼容的 meilisearch/meilisearch-php 版本,通过查阅 Meilisearch 关于二进制兼容性的文档。
[!WARNING]
当在利用 Meilisearch 的应用程序上升级 Scout 时,您应该始终 查阅任何额外的重大变更 对 Meilisearch 服务本身的。
Typesense 是一个闪电般快速的开源搜索引擎,支持关键词搜索、语义搜索、地理搜索和向量搜索。
您可以 自托管 Typesense 或使用 Typesense 云。
要开始将 Typesense 与 Scout 配合使用,请通过 Composer 包管理器安装 Typesense PHP SDK:
composer require typesense/typesense-php然后,设置 SCOUT_DRIVER 环境变量以及你的 Typesense 主机和 API 密钥凭据在你的应用程序的 .env 文件中:
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 文档。
当使用 Typesense 时,您的可搜索模型必须定义一个 toSearchableArray 方法,该方法将您的模型的主键转换为字符串并且将创建日期转换为 UNIX 时间戳:
/**
* Get the indexable data array for the model.
*
* @return array<string, mixed>
*/
public function toSearchableArray(): array
{
return array_merge($this->toArray(),[
'id' => (string) $this->id,
'created_at' => $this->created_at->timestamp,
]);
}您还应该在您应用的 config/scout.php 文件中定义您的 Typesense 集合 schema。集合 schema 描述了可通过 Typesense 搜索的每个字段的数据类型。有关所有可用 schema 选项的更多信息,请参阅 Typesense 文档。
如果你需要在 Typesense 集合的 schema 被定义后更改它,你可以运行 scout:flush 和 scout:import,这将删除所有现有的已索引数据并重新创建 schema。或者,你可以使用 Typesense 的 API 来修改集合的 schema,而不删除任何已索引数据。
如果你的可搜索模型支持软删除,你应该在你的应用程序的 config/scout.php 配置文件中模型对应的 Typesense schema 内定义一个 __soft_deleted 字段:
User::class => [
'collection-schema' => [
'fields' => [
// ...
[
'name' => '__soft_deleted',
'type' => 'int32',
'optional' => true,
],
],
],
],Typesense 允许您在执行搜索操作时,通过 options 方法动态地修改您的 搜索参数:
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;
/**
* Get the name of the index associated with the model.
*/
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;
/**
* Get the indexable data array for the model.
*
* @return array<string, mixed>
*/
public function toSearchableArray(): array
{
$array = $this->toArray();
// Customize the data array...
return $array;
}
}一些搜索引擎例如 Meilisearch 将只会对正确类型的数据执行过滤操作 (>, <, 等))。
因此,在使用这些搜索引擎并自定义可搜索数据时,您应确保数值被转换为正确的类型:
public function toSearchableArray()
{
return [
'id' => (int) $this->id,
'name' => $this->name,
'price' => (float) $this->price,
];
}有时,您可能希望在您的 Algolia 索引上配置额外设置。尽管您可以通过 Algolia UI 管理这些设置,但有时,直接从您的应用程序的 config/scout.php 配置文件中管理索引配置的所需状态会更高效。
这种方法使您能够通过应用程序的自动化部署管道部署这些设置,避免手动配置并确保多个环境之间的一致性。您可以配置可筛选属性、排名、分面,或任何其他支持的设置。
要开始,在您应用程序的 config/scout.php 配置文件中为每个索引添加设置:
use App\Models\User;
use App\Models\Flight;
'algolia' => [
'id' => env('ALGOLIA_APP_ID', ''),
'secret' => env('ALGOLIA_SECRET', ''),
'index-settings' => [
User::class => [
'searchableAttributes' => ['id', 'name', 'email'],
'attributesForFaceting'=> ['filterOnly(email)'],
// Other settings fields...
],
Flight::class => [
'searchableAttributes'=> ['id', 'destination'],
],
],
],如果给定索引底层的模型是可软删除的,并包含在 index-settings 数组中,Scout 将自动支持在该索引上对软删除模型进行分面。如果您没有其他需要为可软删除模型索引定义的分面属性,您只需将一个空条目添加到该模型的 index-settings 数组中即可:
'index-settings' => [
Flight::class => []
],配置完应用的索引设置后,您必须调用 scout:sync-index-settings Artisan 命令。此命令将通知 Algolia 您当前配置的索引设置。为方便起见,您可能希望将此命令作为部署流程的一部分:
php artisan scout:sync-index-settings与其他 Scout 驱动不同,Meilisearch 要求您预先定义索引搜索设置,例如可筛选属性、可排序属性,以及其他支持的设置字段。
可筛选属性是您在调用 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'],
// Other settings fields...
],
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默认情况下,Scout 将使用模型的主键作为模型在搜索索引中存储的唯一 ID / 键。如果您需要自定义此行为,您可以重写模型上的 getScoutKey 和 getScoutKeyName 方法:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;
class User extends Model
{
use Searchable;
/**
* Get the value used to index the model.
*/
public function getScoutKey(): mixed
{
return $this->email;
}
/**
* Get the key name used to index the model.
*/
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\Scout;
use Laravel\Scout\Searchable;
class User extends Model
{
use Searchable;
/**
* Get the engine used to index the model.
*/
public function searchableUsing(): Engine
{
return Scout::engine('meilisearch');
}
}Scout 还允许您在使用 Algolia 时自动识别用户。将已认证用户与搜索操作关联起来,在 Algolia 的仪表盘中查看您的搜索分析时可能会很有帮助。您可以通过在应用程序的 .env 文件中将 SCOUT_IDENTIFY 环境变量定义为 true 来启用用户识别:
SCOUT_IDENTIFY=true启用此功能还会将请求的 IP 地址和您已认证用户的主标识符传递给 Algolia 以便此数据与用户发出的任何搜索请求相关联。
[!WARNING]
数据库引擎目前支持 MySQL 和 PostgreSQL。
database 引擎是开始使用 Laravel Scout 最快的方式,并使用 MySQL / PostgreSQL 全文索引和 “where like” 子句,在从现有数据库筛选结果时,确定适用于你的查询的搜索结果。
要使用数据库引擎,你只需将 SCOUT_DRIVER 环境变量的值设置为 database,或者直接在你应用的 scout 配置文件中指定 database 驱动:
SCOUT_DRIVER=database一旦您已将数据库引擎指定为首选驱动程序,您必须配置您的可搜索数据。然后,您可以开始针对您的模型执行搜索查询。搜索引擎索引,例如为Algolia、Meilisearch或Typesense索引播种所需的索引,在使用数据库引擎时是不必要的。
默认情况下,数据库引擎将针对你已配置为可搜索的每个模型属性执行一个“where like”查询。然而,在某些情况下,这可能会导致性能不佳。因此,可以配置数据库引擎的搜索策略,以便某些指定的列利用全文搜索查询,或仅使用“where like”约束来搜索字符串的前缀 (example%) 而不是在整个字符串中搜索 (%example%)。
要定义此行为,您可以将 PHP 属性分配给模型的 toSearchableArray 方法。任何未分配额外搜索策略行为的列将继续使用默认的 "where like" 策略:
use Laravel\Scout\Attributes\SearchUsingFullText;
use Laravel\Scout\Attributes\SearchUsingPrefix;
/**
* Get the indexable data array for the model.
*
* @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 搜索引擎,但你可能会觉得从“collection”引擎开始更方便。collection 引擎将对来自你现有数据库的结果使用“where”子句和集合过滤,以确定与你的查询相符的搜索结果。使用此引擎时,无需“索引”你的可搜索模型,因为它们将直接从你的本地数据库中检索。
要使用 collection 引擎,您只需将 SCOUT_DRIVER 环境变量的值设置为 collection,或者直接在您应用程序的 scout 配置文件中指定 collection 驱动程序:
SCOUT_DRIVER=collection一旦您将集合驱动指定为首选驱动,您就可以开始 执行搜索查询 针对您的模型。搜索引擎索引,例如为 Algolia、Meilisearch 或 Typesense 索引建立种子所需的索引,在使用集合引擎时是不必要的。
乍一看,"database" 和 "collections" 引擎相当相似。它们都直接与您的数据库交互以检索搜索结果。然而,collection 引擎不使用全文索引或 LIKE 子句来查找匹配记录。相反,它拉取所有可能的记录并使用 Laravel 的 Str::is 辅助函数来确定搜索字符串是否存在于模型属性值中。
集合引擎是最便携的搜索引擎因为它支持 Laravel 所支持的所有关系型数据库(包括 SQLite 和 SQL Server);然而,它的效率远低于 Scout 的数据库引擎。
如果你正在将 Scout 安装到一个现有项目中,你可能已经有需要导入到你的索引中的数据库记录。Scout 提供了一个 scout:import Artisan 命令,你可以使用它将所有现有记录导入到你的搜索索引中:
php artisan scout:import "App\Models\Post"该 scout:queue-import 命令可用于使用队列作业导入您所有现有记录:
php artisan scout:queue-import "App\Models\Post" --chunk=500可使用 flush 命令来从您的搜索索引中移除模型的所有记录:
php artisan scout:flush "App\Models\Post"如果你想修改用于批量导入时检索所有模型的查询,你可以在你的模型上定义一个 makeAllSearchableUsing 方法。这是一个很好的地方,可以在导入模型之前添加任何可能需要的急切关系加载:
use Illuminate\Database\Eloquent\Builder;
/**
* Modify the query used to retrieve models when making all of the models searchable.
*/
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();你还可以调用 searchable 方法,作用于 Eloquent 关系实例上:
$user->orders()->searchable();或者,如果你已经在内存中拥有一个 Eloquent 模型集合,你可以调用该集合实例上的 searchable 方法来将模型实例添加到它们对应的索引中:
$orders->searchable();[!NOTE]
该searchable方法可被视为一个“upsert”操作。换句话说,如果模型记录已存在于您的索引中,它将被更新。如果它不存在于搜索索引中,它将被添加到索引中。
要更新一个可搜索模型,您只需更新模型实例的属性,并save模型到您的数据库。Scout将自动把这些更改持久化到您的搜索索引:
use App\Models\Order;
$order = Order::find(1);
// Update the order...
$order->save();您还可以调用 searchable 方法在一个 Eloquent 查询实例上以更新模型集合. 如果这些模型在您的搜索索引中不存在, 它们将被创建:
Order::where('price', `>`, 100)->searchable();如果您想要更新关系中所有模型的搜索索引记录,您可以调用 searchable 在关系实例上:
$user->orders()->searchable();或者,如果你已经在内存中拥有一个 Eloquent 模型集合,你可以调用该集合实例上的 searchable 方法,来更新模型实例到它们对应的索引中:
$orders->searchable();有时,在模型集合可搜索之前,您可能需要对其进行准备。例如,您可能希望预加载一个关系,以便关系数据可以高效地添加到您的搜索索引中。为此,请在相应的模型上定义一个 makeSearchableUsing 方法:
use Illuminate\Database\Eloquent\Collection;
/**
* Modify the collection of models being made searchable.
*/
public function makeSearchableUsing(Collection $models): Collection
{
return $models->load('author');
}要从索引中删除记录,您可以简单地 delete 数据库中的模型。即使您正在使用 软删除 模型:
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 () {
// Perform model actions...
});有时,您可能需要仅在特定条件下使模型可搜索。例如,假设您有一个 App\Models\Post 模型,它可能处于以下两种状态之一:“草稿”和“已发布”。您可能只想允许“已发布”的帖子可搜索。为此,您可以在模型上定义一个 shouldBeSearchable 方法:
/**
* Determine if the model should be searchable.
*/
public function shouldBeSearchable(): bool
{
return $this->isPublished();
}The shouldBeSearchable 方法仅在通过 save 和 create 方法、查询或关系操作模型时应用。直接使用 searchable 方法使模型或集合可搜索,将覆盖 shouldBeSearchable 方法的结果。
[!警告]
shouldBeSearchable方法在使用 Scout 的 "database" 引擎时不适用,因为所有可搜索数据始终存储在数据库中。为了在使用数据库引擎时实现类似的行为,您应该使用 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();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);一旦你获取到结果,你就可以显示结果并渲染页面链接 使用 Blade 就像你对传统的 Eloquent 查询进行了分页一样:
<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;
// Include trashed records when retrieving results...
$orders = Order::search('Star Trek')->withTrashed()->get();
// Only include trashed records when retrieving results...
$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();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;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
resolve(EngineManager::class)->extend('mysql', function () {
return new MySqlSearchEngine;
});
}一旦你的引擎已注册, 你就可以将其指定为你的默认 Scout driver 在你的应用程序的 config/scout.php 配置文件中:
'driver' => 'mysql',