Skip to content

新增高亮显示 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

新增高亮显示 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5fb4b6
新增高亮显示
luorenshu Jun 15, 2022
be442d2
新增高亮显示
luorenshu Jun 16, 2022
0a4f804
新增高亮显示
luorenshu Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

[`hyperf-ext/scout`](https://github.com/hyperf-ext/scout) 组件为 Hyperf 模型的全文搜索提供了基于 Elasticsearch 的简单的解决方案。通过使用模型观察者，组件会自动同步模型记录的搜索索引。

该组件移植自 [`Laravel Scout`](https://github.com/laravel/scout )，与 Laravel Scout 不同的是，为了提升使用体验并更好的与 Elasticsearch 结合，该组件移除了自定义驱动的特性，仅支持 Elasticsearch，同时针对 Elasticsearch 的特性在原来的基础上进行了诸多的优化，通过队列更新索引的方式也改为通过协程实现。
该组件移植自 [`Laravel Scout`](https://github.com/laravel/scout )，与 Laravel Scout 不同的是，为了提升使用体验并更好的与 Elasticsearch 结合，该组件移除了自定义驱动的特性，仅支持 Elasticsearch，同时针对
Elasticsearch 的特性在原来的基础上进行了诸多的优化，通过队列更新索引的方式也改为通过协程实现。

另外，组件在搜索查询构造器中通过 [`ongr/elasticsearch-dsl`](https://github.com/ongr-io/ElasticsearchDSL) 包来使用 Elasticsearch DSL 构建复杂的查询条件。

> 注意，组件依赖的 `elasticsearch/elasticsearch` 包版本为 `^7.9`，映射类型已被废弃并将在 `8.0` 中彻底移除，因此组件同样也不提供映射类型的支持，即一个模型对应一个索引。
>
>
> 使用独立的索引取代使用映射类型可以让数据更倾向于密集而非稀疏，并且由于同一个索引中的所有的文档表示为同一种实体，在通过全文搜索时打分的条件统计会更为精确。


## 安装

Expand Down Expand Up @@ -62,6 +62,35 @@ class Post extends Model

## 配置模型

### 配置 Elasticsearch 搜索设置

搜索设置可以通过在模型中添加 `searchSetting` 属性来配置，目前只支持高亮：

```php
<?php

declare(strict_types=1);

namespace App\Models;

use Hyperf\Database\Model\Model;
use HyperfExt\Scout\Searchable;

class Post extends Model
{
use Searchable;

// 搜索 `searchSetting` 配置
public $searchSetting = [
//高亮
'attributesToHighlight' => [
'title' => ["pre_tags" => "<b style='color:red'>", "post_tags" => "</b>"],
'content'
],
];
}
```

### 配置 Elasticsearch 索引设置

索引设置可以通过在模型中添加 `scoutSettings` 属性或重写 `getScoutSettings` 方法来配置：
Expand Down Expand Up @@ -529,13 +558,15 @@ $orders = App\Models\Order::search('Star Trek')->paginate(15);

### 软删除

如果您索引的模型配置了[软删除](https://hyperf.wiki/2.0/#/zh-cn/db/model?id=%e8%bd%af%e5%88%a0%e9%99%a4 )，并且您需要搜索已删除的模型，请设置 `config/autoload/scout.php` 中的 `soft_delete` 选项为 `true`（默认值）：
如果您索引的模型配置了[软删除](https://hyperf.wiki/2.0/#/zh-cn/db/model?id=%e8%bd%af%e5%88%a0%e9%99%a4 )，并且您需要搜索已删除的模型，请设置 `config/autoload/scout.php`
中的 `soft_delete` 选项为 `true`（默认值）：

```php
'soft_delete' => true,
```

当此配置选项为 `true` 时，Scout 将不会从搜索索引中删除软删除的模型。并且在查询时，其逻辑与传统的模型是一致的，因此请确保索引的数据中包含软删除的标识字段，通常是 `deleted_at`。然后，您可以在搜索时使用 `withTrashed` 或 `onlyTrashed` 方法来检索软删除的记录：
当此配置选项为 `true` 时，Scout 将不会从搜索索引中删除软删除的模型。并且在查询时，其逻辑与传统的模型是一致的，因此请确保索引的数据中包含软删除的标识字段，通常是 `deleted_at`。然后，您可以在搜索时使用 `withTrashed` 或 `onlyTrashed`
方法来检索软删除的记录：

```php
// 检索结果时包含已删除记录...
Expand Down
61 changes: 44 additions & 17 deletions src/Engine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* @contact [email protected]
* @license https://github.com/hyperf-ext/scout/blob/master/LICENSE
*/

namespace HyperfExt\Scout;

use Elasticsearch\Client;
Expand Down Expand Up @@ -52,18 +53,18 @@ public function update(ModelCollection $models)
$body[] = [
'update' => [
'_index' => $model->searchableAs(),
'_id' => $model->getScoutKey(),
'_id' => $model->getScoutKey(),
],
];
$body[] = [
'doc' => $doc,
'doc' => $doc,
'doc_as_upsert' => true,
];
}

$this->elasticsearch->bulk([
'refresh' => config('scout.doc_refresh', true),
'body' => $body,
'body' => $body,
]);
}

Expand All @@ -82,14 +83,14 @@ public function delete(ModelCollection $models)
$body[] = [
'delete' => [
'_index' => $model->searchableAs(),
'_id' => $model->getScoutKey(),
'_id' => $model->getScoutKey(),
],
];
}

$this->elasticsearch->bulk([
'refresh' => config('scout.document_refresh', true),
'body' => $body,
'body' => $body,
]);
}

Expand All @@ -104,7 +105,7 @@ public function search(Builder $builder)
$size = $builder->getSearch()->getSize();
return $this->performSearch(
$builder,
! is_null($from)
!is_null($from)
? ['size' => $size, 'from' => $from]
: []
);
Expand All @@ -130,7 +131,7 @@ public function count(Builder $query): int
{
$result = $this->performCount($query);

return isset($result['count']) ? (int) $result['count'] : 0;
return isset($result['count']) ? (int)$result['count'] : 0;
}

/**
Expand All @@ -143,12 +144,13 @@ public function mapIds($results): BaseCollection
return collect($results['hits']['hits'])->pluck('_id');
}


/**
* Map the given results to instances of the given model.
*
* @param mixed $results
*/
public function map(Builder $builder, $results, Model $model): ModelCollection
public function map(Builder $builder, $results, Model $model)
{
if ($this->getTotalCount($results) === 0) {
return $model->newCollection();
Expand All @@ -158,14 +160,25 @@ public function map(Builder $builder, $results, Model $model): ModelCollection

$idPositions = array_flip($ids);

return $model->getScoutModelsByIds(
$res = $model->getScoutModelsByIds(
$builder,
$ids
)->filter(function ($model) use ($ids) {
return in_array($model->getScoutKey(), $ids);
})->sortBy(function ($model) use ($idPositions) {
return $idPositions[$model->getScoutKey()];
})->values();
})->keyBy($model->getKeyName());

return collect($results['hits']['hits'])->map(function ($hit) use ($res) {
$one = $res[$hit['_id']];

if (isset($hit['highlight'])) {
foreach ($hit['highlight'] as $key => $value) {
$one->{$key} = $value[0];
}
}
return $one;
});
}

/**
Expand All @@ -175,7 +188,7 @@ public function map(Builder $builder, $results, Model $model): ModelCollection
*/
public function getTotalCount($results): int
{
return (int) $results['hits']['total']['value'];
return (int)$results['hits']['total']['value'];
}

/**
Expand All @@ -185,8 +198,8 @@ public function flush(Model $model)
{
$this->elasticsearch->deleteByQuery([
'refresh' => config('scout.document_refresh', true),
'index' => $model->searchableAs(),
'body' => [
'index' => $model->searchableAs(),
'body' => [
'query' => ['match_all' => []],
],
]);
Expand Down Expand Up @@ -227,8 +240,8 @@ public function getClient(): Client
protected function performCount(Builder $builder, array $options = [])
{
$query = [
'index' => $builder->index ?? $builder->model->searchableAs(),
'body' => $builder->toArray(),
'index' => $builder->index ?? $builder->model->searchableAs(),
'body' => $builder->toArray(),
'ignore_throttled' => false,
];

Expand All @@ -243,8 +256,8 @@ protected function performCount(Builder $builder, array $options = [])
protected function performSearch(Builder $builder, array $options = [])
{
$query = [
'index' => $builder->index ?: $builder->model->searchableAs(),
'body' => $builder->toArray(),
'index' => $builder->index ?: $builder->model->searchableAs(),
'body' => $builder->toArray(),
'ignore_throttled' => false,
];

Expand All @@ -256,6 +269,20 @@ protected function performSearch(Builder $builder, array $options = [])
$query['from'] = $options['from'];
}

$searchSetting = $builder->model->searchSetting ?? [];

// 高亮
if ($searchSetting && isset($searchSetting['attributesToHighlight'])) {
$attributes = $searchSetting['attributesToHighlight'];
foreach ($attributes as $key => $attribute) {
if (is_array($attribute)) {
$query['body']['highlight']['fields'][$key] = $attribute;
} else {
$query['body']['highlight']['fields'][$attribute] = new \stdClass();
}
}
}

if ($builder->callback) {
return call_user_func(
$builder->callback,
Expand Down