只需五步集成新版 Elasticsearch7.9 中文搜索到你的 Laravel7 项目

只需五步骤：

启动集成ik中文分词插件的Elasticsearch7.9 Docker镜像
Laravel7 配置 Scout
配置 Model模型
导入数据
搜索

演示地址

https://www.ar414.com

搜索范围

文章内容
标题
标签

结果权重

出现关键词数量
出现关键词次数

搜索页面

高亮显示
分词显示
结果分页

前言

主要是博客刚好想做个搜索,顺便就整理成文章

Laravel + Elasticsearch 很多前辈都写过教程和案例,但是随着Elasticsearch和laravel的版本升级以前的文章很多都不适用新版本的,建议大家使用任何开源项目时应该过一遍文档以当前使用的版本文档为主,教程为辅

参考

使用集成`ik中文分词`插件的Elasticsearch

拉取docker

$ docker pull ar414/elasticsearch-7.9-ik-plugin

创建日志和数据存储目录

本地映射到docker容器内，防止docker重启数据丢失

$ mkdir -p /data/elasticsearch/data
$ mkdir -p /data/elasticsearch/log
$ chmod -R 777 /data/elasticsearch/data
$ chmod -R 777 /data/elasticsearch/log

运行

docker run -d -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -v /data/elasticsearch/data:/var/lib/elasticsearch -v /data/elasticsearch/log:/var/log/elasticsearch ar414/elasticsearch-7.9-ik-plugin

验证

$ curl http://localhost:9200
{
  "name" : "01ac21393985",
  "cluster_name" : "docker-cluster",
  "cluster_uuid" : "h8L336qcRb2i1aydOv04Og",
  "version" : {
    "number" : "7.9.0",
    "build_flavor" : "default",
    "build_type" : "docker",
    "build_hash" : "a479a2a7fce0389512d6a9361301708b92dff667",
    "build_date" : "2020-08-11T21:36:48.204330Z",
    "build_snapshot" : false,
    "lucene_version" : "8.6.0",
    "minimum_wire_compatibility_version" : "6.8.0",
    "minimum_index_compatibility_version" : "6.0.0-beta1"
  },
  "tagline" : "You Know, for Search"
}

测试中文分词

curl -X POST "http://localhost:9200/_analyze?pretty" -H 'Content-Type: application/json' -d'
{
  "analyzer": "ik_max_word",
  "text":     "laravel天下无敌"
}
'

{
  "tokens" : [
    {
      "token" : "laravel",
      "start_offset" : 0,
      "end_offset" : 7,
      "type" : "ENGLISH",
      "position" : 0
    },
    {
      "token" : "天下无敌",
      "start_offset" : 7,
      "end_offset" : 11,
      "type" : "CN_WORD",
      "position" : 1
    },
    {
      "token" : "天下",
      "start_offset" : 7,
      "end_offset" : 9,
      "type" : "CN_WORD",
      "position" : 2
    },
    {
      "token" : "无敌",
      "start_offset" : 9,
      "end_offset" : 11,
      "type" : "CN_WORD",
      "position" : 3
    }
  ]
}

Laravel 项目中使用 Elasticsearch

Elasticsearch官方有提供 SDK，在 Laravel 项目中可以更加优雅快速的接入 Elasticsearch，Laravel 本身有提供 Scout全文搜索的解决方案，我们只需将默认的 Algolia 驱动替换成ElasticSearch驱动。

安装

laravel/scout
matchish/laravel-scout-elasticsearch

$ composer require laravel/scout
$ composer require matchish/laravel-scout-elasticsearch

配置

生成 Scout 配置文件(config/scout.php)

$ php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
Copied File [\vendor\laravel\scout\config\scout.php] To [\config\scout.php]
Publishing complete.

指定 Scout 驱动

第一种：在.env文件中指定（建议）

SCOUT_DRIVER=Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine

第二种：在config/scout.php直接修改默认驱动

'driver' => env('SCOUT_DRIVER', 'algolia')
改为
'driver' => env('SCOUT_DRIVER', 'Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine')

指定Elasticsearch服务IP端口

如果使用docker部署则使用 docker0的IP，Linux通过ifconfig查看
在.env中配置

ELASTICSEARCH_HOST=172.17.0.1:9200

注册服务

config/app.php

'providers' => [
    // Other Service Providers
    \Matchish\ScoutElasticSearch\ElasticSearchServiceProvider::class
],

清除配置缓存

$ php artisan config:clear

至此 laravel 已经接入 Elasticsearch

实际业务中使用

需求

通过博客右上角的搜索框可以搜索到与关键词相关的文章，从以下几点匹配

文章内容
文章标题
文章标签

涉及到2张 Mysql表以及字段

article
- title
- tags
article_content
- content

为文章配置 Elasticsearch 索引

创建索引配置文件（config/elasticsearch.php）

$ touch config/elasticsearch.php

elasticsearch.php 配置字段映射

 [
        'mappings' => [
            'blog-articles' => [
                "properties"=>  [
                    "content"=>  [
                        "type"=>  "text",
                        "analyzer"=>  "ik_max_word",
                        "search_analyzer"=>  "ik_smart"
                    ],
                    "tags"=>  [
                        "type"=>  "text",
                        "analyzer"=>  "ik_max_word",
                        "search_analyzer"=>  "ik_smart"
                    ],
                    "title"=>  [
                        "type"=>  "text",
                        "analyzer"=>  "ik_max_word",
                        "search_analyzer"=>  "ik_smart"
                    ]
                ]
            ]
        ]
    ],
];

analyzer：字段文本的分词器
- search_analyzer：搜索词的分词器
- 根据具体业务场景选择(颗粒小占用资源多,一般场景analyzer使用ik_max_word,search_analyzer使用ik_smart):
  - ik_max_word：ik中文分词插件提供,对文本进行最大数量分词
    laravel天下无敌 -> laravel，天下无敌,天下,无敌
  - ik_smart: ik中文分词插件提供,对文本进行最小数量分词

    `laravel天下无敌` -> `laravel`，`天下无敌`

配置文章模型

建议先看一遍 Laravel Scout 使用文档

引入Laravel Scout

namespace App\Models\Blog;
    
use Laravel\Scout\Searchable;

class Article extends BlogBaseModel
{
    use Searchable;
}

指定索引(刚刚配置文件中的elasticsearch.indices.mappings.blog-articles)
```
/**
 * 指定索引
```

 */
public function searchableAs()
{
    return 'blog-articles';
}
```

设置导入索引的数据字段

/**
 * 设置导入索引的数据字段

 */
public function toSearchableArray()
{
    return [
        'content' => ArticleContent::query()
            ->where('article_id',$this->id)
            ->value('content'),
        'tags'    => implode(',',$this->tags),
        'title'   => $this->title
    ];
}
```

指定搜索索引中存储的唯一ID

/**
 * 指定 搜索索引中存储的唯一ID

 */
public function getScoutKey()
{
    return $this->id;
}

/**
 * 指定 搜索索引中存储的唯一ID的键名
 * @return string
 */
public function getScoutKeyName()
{
    return 'id';
}
```

数据导入

其实是将数据表中的数据通过Elasticsearch导入到Lucene
Elasticsearch 是 Lucene 的封装，提供了 REST API 的操作接口

一键自动导入: php artisan scout:import
导入指定模型: php artisan scout:import ${model}

$ php artisan scout:import "App\Models\Blog\Article"
Importing [App\Models\Blog\Article]
Switching to the new index
5/5 [⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬] 100%
[OK] All [App\Models\Blog\Article] records have been imported.

导入失败,常见原因:

Unresolvable dependency resolving [Parameter #0 [ integer $retries ]] in class ElasticsearchTransport
- 解决: 修改配置后,没有清除配置缓存
invalid_index_name_exception
- 解决: searchableAs配置错误,为索引创建别名后,指定别名

检查索引是否正确

$ curl -XGET http://localhost:9200/blog-articles/_mapping?pretty
{
  "blog-articles_1598362919" : {
    "mappings" : {
      "properties" : {
        "__class_name" : {
          "type" : "text",
          "fields" : {
            "keyword" : {
              "type" : "keyword",
              "ignore_above" : 256
            }
          }
        },
        "content" : {
          "type" : "text",
          "analyzer" : "ik_max_word",
          "search_analyzer" : "ik_smart"
        },
        "tags" : {
          "type" : "text",
          "analyzer" : "ik_max_word",
          "search_analyzer" : "ik_smart"
        },
        "title" : {
          "type" : "text",
          "analyzer" : "ik_max_word",
          "search_analyzer" : "ik_smart"
        }
      }
    }
  }
}

测试

创建一个测试命令行

$ php artisan make:command ElasticTest

代码

getPreciseTimestamp(3);
        $articles = Article::search($this->argument('query'))->get()->toArray();
        $userTime = Carbon::now()->getPreciseTimestamp(3) - $startTime;
        echo "耗时(毫秒)：{$userTime} \n";
        
        //content在另外一张表中，方便观察测试 这里输出
        if(!empty($articles)) {
            foreach($articles as &$article) {
                $article = ArticleContent::query()->where('article_id',$article['id'])->value('content');
            }
        }

        var_dump($articles);

    }
}

测试

$ php artisan elasticsearch 周杰伦

高亮显示片段

高亮显示需要自定义查询，核心代码

//ONGR\ElasticsearchDSL\Highlight\Highlight 
ArticleModel::search($query,function($client,$body) {
            $higlight = new Highlight();
            $higlight->addField('content',['type' => 'plain']);
            $higlight->addField('title');
            $higlight->addField('tags');
            $body->addHighlight($higlight);
            $body->setSource(['title','tags']);
            return $client->search(['index' => (new ArticleModel())->searchableAs(), 'body' => $body->toArray()]);
        })->raw();

自定义查询可参考以两个包灵活开发

$client elasticsearch/elasticsearch package
$body ongr/elasticsearch-dsl package

只需五步 集成新版 Elasticsearch7.9 中文搜索 到你的 Laravel7 项目