README

💥 介绍 Laravel 的新 Elasticsearch 生态系统。 💥

此包提供用于在 Elasticsearch 中搜索和过滤数据的先进功能。查看其功能！

内容

功能
需求
安装
配置
索引配置器
可搜索模型
用法
控制台命令
搜索规则
可用过滤器
零停机迁移
调试
替代方案

功能

一种简单的配置和创建 Elasticsearch 索引的方法。
为每个模型提供完全可配置的映射。
可以通过自动或使用 artisan 命令将新字段添加到现有的映射中。
有多种不同的方法来实现您的搜索算法：使用搜索规则或原始搜索。
提供各种过滤器类型，以便使搜索查询更加具体。
从旧索引到新索引的零停机迁移。
批量索引，请参阅配置部分。

需求

该包已在以下配置中进行测试

PHP 版本 >=7.1.3, <=7.3
Laravel 框架版本 >=5.8, <=6
Elasticsearch 版本 >=7

安装

使用 composer 安装包

composer require babenkoivan/scout-elasticsearch-driver

如果您正在使用 Laravel 版本 <= 5.4 或包发现已禁用，请将以下提供者在 config/app.php 中添加

'providers' => [
    Laravel\Scout\ScoutServiceProvider::class,
    ScoutElastic\ScoutElasticServiceProvider::class,
]

配置

要配置包，您需要首先发布设置

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

然后，在 config/scout.php 文件中将驱动设置设置为 elastic（或在 .env 中设置 SCOUT_DRIVER=elastic）并在 config/scout_elastic.php 文件中配置驱动本身。可用的选项包括

注意，如果您使用批量文档索引，可能需要更改块大小，您可以在 config/scout.php 文件中这样做。

索引配置器

使用以下 artisan 命令设置 Elasticsearch 索引的设置。要创建新的索引配置器，请使用以下 artisan 命令

php artisan make:index-configurator MyIndexConfigurator

它将在您的项目的 app 文件夹中创建 MyIndexConfigurator.php 文件。您可以在以下示例中指定索引名称和设置

<?php

namespace App;

use ScoutElastic\IndexConfigurator;

class MyIndexConfigurator extends IndexConfigurator
{
    // It's not obligatory to determine name. By default it'll be a snaked class name without `IndexConfigurator` part.
    protected $name = 'my_index';  
    
    // You can specify any settings you want, for example, analyzers. 
    protected $settings = [
        'analysis' => [
            'analyzer' => [
                'es_std' => [
                    'type' => 'standard',
                    'stopwords' => '_spanish_'
                ]
            ]    
        ]
    ];
}

有关索引设置的更多信息，请参阅 Elasticsearch 文档中的索引管理部分。

要创建索引，只需运行 artisan 命令

php artisan elastic:create-index "App\MyIndexConfigurator"

请注意，每个可搜索模型都需要自己的索引配置器。

在 Elasticsearch 6.0.0 或更高版本中创建的索引可能只包含一个映射类型。在 5.x 版本中创建的包含多个映射类型的索引将继续在 Elasticsearch 6.x 中按之前的方式运行。映射类型将在 Elasticsearch 7.0.0 中完全移除。

您可以在这里找到更多相关信息。

可搜索模型

要创建一个具有在 Elasticsearch 索引中执行搜索请求能力的模型，请使用以下命令

php artisan make:searchable-model MyModel --index-configurator=MyIndexConfigurator

执行命令后，您将在您的 app 文件夹中找到 MyModel.php 文件

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;

    protected $indexConfigurator = MyIndexConfigurator::class;

    protected $searchRules = [
        //
    ];

    // Here you can specify a mapping for model fields
    protected $mapping = [
        'properties' => [
            'title' => [
                'type' => 'text',
                // Also you can configure multi-fields, more details you can find here https://elastic.ac.cn/guide/en/elasticsearch/reference/current/multi-fields.html
                'fields' => [
                    'raw' => [
                        'type' => 'keyword',
                    ]
                ]
            ],
        ]
    ];
}

每个可搜索模型代表一个 Elasticsearch 类型。默认情况下，类型名称与表名称相同，但您可以通过 searchableAs 方法设置任何类型名称。您还可以通过 toSearchableArray 方法指定由驱动程序索引的字段。您可以在Scout 官方文档中找到有关这些选项的更多信息。

在 MyModel 类中您可以设置的最后一个重要选项是 $searchRules 属性。它允许您为模型设置不同的搜索算法。我们将在搜索规则部分更详细地讨论它。

在您的模型中设置映射后，您可以更新 Elasticsearch 类型映射

php artisan elastic:update-mapping "App\MyModel"

用法

一旦创建索引配置器、Elasticsearch 索引和可搜索模型，您就准备就绪了。现在您可以根据文档索引和搜索数据。

基本搜索使用示例

// set query string
App\MyModel::search('phone')
    // specify columns to select
    ->select(['title', 'price'])
    // filter 
    ->where('color', 'red')
    // sort
    ->orderBy('price', 'asc')
    // collapse by field
    ->collapse('brand')
    // set offset
    ->from(0)
    // set limit
    ->take(10)
    // get results
    ->get();

如果您只需要查询的匹配数，请使用 count 方法

App\MyModel::search('phone') 
    ->count();

如果您需要加载关系，请使用 with 方法

App\MyModel::search('phone') 
    ->with('makers')
    ->get();

除了标准功能外，该包还提供您可以在不指定查询字符串的情况下在 Elasticsearch 中过滤数据的功能

App\MyModel::search('*')
    ->where('id', 1)
    ->get();

您还可以覆盖模型的搜索规则

App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();

您可以使用多种 where 条件过滤

App\MyModel::search('*')
    ->whereRegexp('name.raw', 'A.+')
    ->where('age', '>=', 30)
    ->whereExists('unemployed')
    ->get();

您还可以过滤出得分低于 min_score 的结果

App\MyModel::search('sales')
    ->minScore(1.0)
    ->get();

您还可以添加更复杂的排序（例如 geo_distance）

$model = App\MyModel::search('sales')
    ->orderRaw([
       '_geo_distance' =>  [
           'coordinates' => [
               'lat'   =>  51.507351,
               'lon'   =>  -0.127758
           ],
           'order'     =>  'asc',
           'unit'      =>  'm'
       ]
    ])
    ->get();

// To retrieve sort result, use model `sortPayload` attribute:
$model->sortPayload;

最后，如果您想发送自定义请求，可以使用 searchRaw 方法

App\MyModel::searchRaw([
    'query' => [
        'bool' => [
            'must' => [
                'match' => [
                    '_all' => 'Brazil'
                ]
            ]
        ]
    ]
]);

此查询将返回原始响应。

控制台命令

以下列出了可用的 artisan 命令

要获取详细描述和所有可用选项，请在命令行中运行 php artisan help [command]

搜索规则

搜索规则是一个描述搜索查询如何执行的类。要创建搜索规则，请使用以下命令

php artisan make:search-rule MySearchRule

在文件 app/MySearchRule.php 中，您将找到一个类定义

<?php

namespace App;

use ScoutElastic\SearchRule;

class MySearch extends SearchRule
{
    // This method returns an array, describes how to highlight the results.
    // If null is returned, no highlighting will be used. 
    public function buildHighlightPayload()
    {
        return [
            'fields' => [
                'name' => [
                    'type' => 'plain'
                ]
            ]
        ];
    }
    
    // This method returns an array, that represents bool query.
    public function buildQueryPayload()
    {
        return [
            'must' => [
                'match' => [
                    'name' => $this->builder->query
                ]
            ]
        ];
    }
}

您可以在这里阅读有关 bool 查询的更多信息，以及有关高亮显示的这里。

默认搜索规则返回以下负载

return [
   'must' => [
       'query_string' => [
           'query' => $this->builder->query
       ]
   ]
];

这意味着默认情况下，当您在模型上调用 search 方法时，它会尝试在任意字段中查找查询字符串。

要确定模型的默认搜索规则，只需添加一个属性

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $searchRules = [
        MySearchRule::class
    ];
}

您也可以在查询构建器中设置搜索规则

// You can set either a SearchRule class
App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();
    
// or a callable
App\MyModel::search('Brazil')
    ->rule(function($builder) {
        return [
            'must' => [
                'match' => [
                    'Country' => $builder->query
                ]
            ]
        ];
    })
    ->get();

要检索高亮，请使用模型的 highlight 属性

// Let's say we highlight field `name` of `MyModel`.
$model = App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->first();

// Now you can get raw highlighted value:
$model->highlight->name;

// or string value:
 $model->highlight->nameAsString;

可用过滤器

您可以使用不同类型的过滤器

在大多数情况下，最好使用原始字段来过滤记录，即未分析的字段。

零停机迁移

正如您所知，在Elasticsearch中，您不能更改已创建字段的类型。在这种情况下，唯一的选项是创建一个新的索引，并带有必要的映射，然后将您的模型导入到新的索引中。
迁移可能需要相当长的时间，为了避免在迁移过程中出现停机时间，驱动程序从旧索引中读取并写入新索引。一旦迁移完成，它就开始从新索引中读取，并删除旧索引。这就是artisan elastic:migrate-model命令的工作方式。

在运行命令之前，请确保您的索引配置器使用ScoutElastic\Migratable特性。如果不是这样，请添加特性，并使用索引配置器类名作为参数运行artisan elastic:update-index命令。

php artisan elastic:update-index "App\MyIndexConfigurator"

准备好后，修改模型映射，并使用模型类作为第一个参数，所需索引名称作为第二个参数运行elastic:migrate-model命令。

php artisan elastic:migrate-model "App\MyModel" my_index_v2

注意，如果您只想在映射中添加新字段，请使用elastic:update-mapping命令。

调试

有两种方法可以帮助您分析搜索查询的结果：

explain

App\MyModel::search('Brazil')
    ->explain();

profile

App\MyModel::search('Brazil')
    ->profile();

这两种方法都返回ES的原始数据。

此外，您可以通过调用buildPayload方法来获取将被发送到ES的查询有效负载。

App\MyModel::search('Brazil')
    ->buildPayload();

请注意，由于一个查询中可能使用多个搜索规则，此方法返回一个有效负载集合。

替代方案

最近，我发布了一个新的针对Laravel的Elasticsearch生态系统，它包括：

Elastic Scout Driver - Laravel Scout的通用Elasticsearch驱动程序。如果您需要在Laravel应用程序中构建简单的搜索，这是完美的选择。
Elastic Scout Driver Plus - Elastic Scout Driver的扩展。如果您想利用布尔查询、高亮显示等Elasticsearch功能，这是您的选择。
Elastic Migrations - 一种轻松创建、删除或更新Elasticsearch索引模式并与同事共享的方法。它具有与Laravel数据库迁移相当类似的界面。

如果您对其中任何一项感兴趣并想了解更多详情，请阅读Laravel应用程序中Elasticsearch的终极指南。该文章对所提到的包进行了很好的概述，并提供了使用示例。

常见问题解答（FAQ）

为什么您创建了一个新包而不是新的scout-elasticsearch-driver版本？ - 由于明显的原因，我不想创建另一个全能包：关注点分离，不兼容其他Scout驱动程序，难以测试和开发等。由于Elastic Scout Driver是一个通用驱动程序，并且没有实现所有scout-elasticsearch-driver功能，因此将其称为新的scout-elasticsearch-driver版本是不正确的。
这对scout-elasticsearch-driver意味着什么？ - 目前，它由社区维护（感谢@iget-esoares和@lucamichot让项目保持活力🎉）。我希望他们会继续为项目做出贡献，并在未来带来scout-elasticsearch-driver的新版本。

plank / scout-elasticsearch-driver

维护者

详细信息