docker + laravel项目使用elasticsearch进行全文检索功能

Laravel项目使用Elasticsearch进行全文检索功能

博主用的是mac + docker，所以就用docker进行讲解
只需五步骤：
• 启动 集成 ik 中文分词插件的 Elasticsearch Docker 镜像
• Laravel 配置 Scout
• 配置 Model 模型
• 导入数据
• 搜索

参考
• ik 中文分词插件
• elasticsearch 官方文档

docker拉取es镜像

使用集成 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 /Users/mac/lnmp/php-server/elasticsearch/data:/var/lib/elasticsearch -v /Users/mac/lnmp/php-server/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”
}

Laravel 项目中使用 Elasticsearch

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

1、安装

• 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.

2、指定 Scout 驱动

• 第一种：在.env 文件中指定（建议）
SCOUT_DRIVER=Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine
• 第二种：在 config/scout.php 直接修改默认驱动
‘driver’ => env(‘SCOUT_DRIVER’, ‘algolia’)
改为
‘driver’ => env(‘SCOUT_DRIVER’, ‘Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine’)

3、指定 Elasticsearch 服务 IP 端口

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

4、注册服务

config/app.php
‘providers’ => [
// Other Service Providers
\Matchish\ScoutElasticSearch\ElasticSearchServiceProvider::class
],

5、注册服务

清除配置缓存
$ php artisan config:clear

6、为文章配置 Elasticsearch 索引

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

7、配置模型（建议先看一遍 Laravel Scout 使用文档）

7、数据导入

$ php artisan scout:import “App\Models\Blog\Article”

其实是将数据表中的数据通过 Elasticsearch 导入到 Lucene
Elasticsearch 是 Lucene 的封装，提供了 REST API 的操作接口
• 一键自动导入: php artisan scout:import
• 导入指定模型: php artisan scout:import ${model}
因为用的是docker所以得去docker容器中执行该操作，不然查询时会报错

导入失败，常见原因:
Unresolvable dependency resolving [Parameter #0 [ integer $retries ]] in class Elasticsearch\Transport
解决：修改配置后，没有清除配置缓存
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
代码

测试
$ php artisan elasticsearch 小吴

如果出现postman请求集群失败本地运行即可，php artisan serve
下面是我个人的es操作

因为已经是在Model配置好了，所以增删改都得通过模型进行操作，这样数据就会一致，不会出现新增的数据，查询不到！

文章有部分内容是参考https://zhuanlan.zhihu.com/p/215756862，该文章重点是博主自己实际动手运行的效果，偏向于docker环境和实践过程踩的坑！