ElasticSearch学习笔记
ElasticSearch
一、初识ES
1. 什么是ElasticSearch？
ES的概念：
ElasticSearch是一款非常强大的开源搜索引擎，可以帮助我们从海量数据中快速找到需要的内容。
ElasticSearch结合Kibana、LogStach、Beats，也就是Elastic Stack（ELK）。被广泛应用在日志数据分析、实时监控等领域。
ES的发展：
Lucene是一个Java语言的搜索引擎类库，是Apache公司的顶级项目，由DoougCutting于1999年研发
Lucene的优势：
- 易扩展
- 高性能（基于倒排索引）
Lucene的缺点：
- 只限于Java语言开发
- 学习曲线陡峭
- 不支持水平扩展
2004年Shay Banon基于Lucene开发了Compass
2010年Shay Banon重写了Compass，取名为ElasticSearch
相比于Lucene，ElasSearch具备下列优势：
- 支持分布式，可水平扩展
- 提供Restful接口，可以被任何语言调用
搜索引擎技术排名：
- ElasticSearch：开源的分布式搜索引擎
- Splunk：商业项目
- Solr：Apache的开源搜素引擎
2. 倒排索引
Elasticsearch中的倒排索引是一种数据结构，用于快速定位包含特定词项（terms）的文档。它与传统的正排索引（将文档按顺序存储）不同，倒排索引存储了每个词项及其出现在哪些文档中的引用信息。
倒排索引由两部分组成：词项表（terms dictionary）和倒排列表（inverted list）。
-
词项表：存储了所有出现在索引中的词项，以及指向对应倒排列表的指针或偏移量。
-
倒排列表：对于每个词项，倒排列表记录了包含该词项的文档列表或位置信息。每个词项都有一个倒排列表，其中包含了相关文档的标识（如文档ID或者位置信息），以便能够快速地定位到包含查询词的文档。
举个例子，如果有三个文档分别包含词项 “apple”：
- 文档1: “An apple a day keeps the doctor away.”
- 文档2: “She bought an apple and a banana.”
- 文档3: “The apple company produces computers.”
倒排索引会将词项 “apple” 映射到相关文档的列表：
- “apple” -> [文档1, 文档2, 文档3]
这样的设计使得Elasticsearch可以非常快速地执行全文搜索，因为它可以通过倒排索引迅速确定包含搜索词的文档，而不必逐个扫描所有文档。
倒排索引在Elasticsearch中被广泛应用，支持各种搜索操作，并且能够高效地处理大规模的文本数据。
文档（document）：每一条数据就是一个文档
词条（term）：文档按照词义分成的词语
正排索引：
基于文档id创建索引。查询词条时必须先找到文档，而后判断是否包含词条。
倒排索引：
对文档内容进行分词，对词条创建索引，并记录词条所在的文档的信息。
查询时先根据词条查询到文档id，而后获取到文档。
3. ES 和 MySQL 的概念对比
| MySQL | ElasticSearch | 说明 |
|---|---|---|
| Table | Index | 索引（index）也就是文档的集合，类似数据库的表（table） |
| Row | Document | 文档（Document）就是一条条的数据，类似数据库的行（Row），文档都是JSON格式 |
| Column | Field | 字段（Field），就是JSON文档中的字段，类似数据库中的列（Column） |
| Schema | Mapping | 映射（Mapping）是索引中文档的约束，例如字段类型约束。类似数据库的表结构（Schema） |
| SQL | DSL | DSL是ElasticSearch提供的JSON风格的请求语句，用来操作ElasticSearch，实现CRUD |
4. 安装ElasticSearch
1.创建网络
因为我们还需要部署kibana容器，因此需要让es和kibana容器互联。这里先创建一个网络：
docker network create es-net
2.加载镜像
这里我们采用elasticsearch的7.12.1版本的镜像
docker load -i es.tar
3.运行
运行docker命令，部署单点es：
docker run -d \
--name es \
-e "ES_JAVA_OPTS=-Xms512m -Xmx512m" \
-e "discovery.type=single-node" \
-v es-data:/usr/share/elasticsearch/data \
-v es-plugins:/usr/share/elasticsearch/plugins \
--privileged \
--network es-net \
-p 9200:9200 \
-p 9300:9300 \
elasticsearch:7.12.1
命令解释：
-e "cluster.name=es-docker-cluster"：设置集群名称-e "http.host=0.0.0.0"：监听的地址，可以外网访问-e "ES_JAVA_OPTS=-Xms512m -Xmx512m"：内存大小-e "discovery.type=single-node"：非集群模式-v es-data:/usr/share/elasticsearch/data：挂载逻辑卷，绑定es的数据目录-v es-logs:/usr/share/elasticsearch/logs：挂载逻辑卷，绑定es的日志目录-v es-plugins:/usr/share/elasticsearch/plugins：挂载逻辑卷，绑定es的插件目录--privileged：授予逻辑卷访问权--network es-net：加入一个名为es-net的网络中-p 9200:9200：端口映射配置
在浏览器中输入：http://192.168.200.102:9200 即可看到elasticsearch的响应结果:
5. 安装Kibana
kibana可以给我们提供一个elasticsearch的可视化界面，便于我们学习。
1.部署
运行docker命令，部署kibana
docker run -d \
--name kibana \
-e ELASTICSEARCH_HOSTS=http://es:9200 \
--network=es-net \
-p 5601:5601 \
kibana:7.12.1
--network es-net：加入一个名为es-net的网络中，与elasticsearch在同一个网络中-e ELASTICSEARCH_HOSTS=http://es:9200"：设置elasticsearch的地址，因为kibana已经与elasticsearch在一个网络，因此可以用容器名直接访问elasticsearch-p 5601:5601：端口映射配置
kibana启动一般比较慢，需要多等待一会，可以通过命令：
docker logs -f kibana
查看运行日志，当查看到下面的日志，说明成功：
此时，在浏览器输入地址访问：http://192.168.200.102:5601，即可看到结果
2.DevTools
kibana中提供了一个DevTools界面：
这个界面中可以编写DSL来操作elasticsearch。并且对DSL语句有自动补全功能。
6. 安装 IK 分词器
1.在线安装 ik 插件（较慢）
# 进入容器内部
docker exec -it elasticsearch /bin/bash
# 在线下载并安装
./bin/elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v7.12.1/elasticsearch-analysis-ik-7.12.1.zip
#退出
exit
#重启容器
docker restart elasticsearch
2.离线安装ik插件（推荐）
查看数据卷目录
安装插件需要知道elasticsearch的plugins目录位置，而我们用了数据卷挂载，因此需要查看elasticsearch的数据卷目录，通过下面命令查看:
docker volume inspect es-plugins
显示结果：
[
{
"CreatedAt": "2022-05-06T10:06:34+08:00",
"Driver": "local",
"Labels": null,
"Mountpoint": "/var/lib/docker/volumes/es-plugins/_data",
"Name": "es-plugins",
"Options": null,
"Scope": "local"
}
]
说明plugins目录被挂载到了：/var/lib/docker/volumes/es-plugins/_data 这个目录中。
上传到es容器的插件数据卷中
也就是/var/lib/docker/volumes/es-plugins/_data ：
重启容器
# 4、重启容器
docker restart es
# 查看es日志
docker logs -f es
测试：
IK分词器包含两种模式：
-
ik_smart：最少切分 -
ik_max_word：最细切分
GET /_analyze
{
"analyzer": "ik_max_word",
"text": "Java是世界上最好的语言"
}
{
"tokens" : [
{
"token" : "java",
"start_offset" : 0,
"end_offset" : 4,
"type" : "ENGLISH",
"position" : 0
},
{
"token" : "是",
"start_offset" : 4,
"end_offset" : 5,
"type" : "CN_CHAR",
"position" : 1
},
{
"token" : "世界上",
"start_offset" : 5,
"end_offset" : 8,
"type" : "CN_WORD",
"position" : 2
},
{
"token" : "世界",
"start_offset" : 5,
"end_offset" : 7,
"type" : "CN_WORD",
"position" : 3
},
{
"token" : "上",
"start_offset" : 7,
"end_offset" : 8,
"type" : "CN_CHAR",
"position" : 4
},
{
"token" : "最好",
"start_offset" : 8,
"end_offset" : 10,
"type" : "CN_WORD",
"position" : 5
},
{
"token" : "的",
"start_offset" : 10,
"end_offset" : 11,
"type" : "CN_CHAR",
"position" : 6
},
{
"token" : "语言",
"start_offset" : 11,
"end_offset" : 13,
"type" : "CN_WORD",
"position" : 7
}
]
}
二、索引库和文档的相关操作
1. mapping映射属性
mapping是对索引库中文档的约束，常见的mapping属性包括：
- type：字段数据类型，常见的简单类型有：
- 字符串：text（可分词的文本）、keyword（精确值，例如：品牌、国家等）
- 数值：long、integer、short、byte、double、float
- 布尔：boolean
- 日期：date
- 对象：object
- index：是否创建索引，默认为true
- analyzer：使用哪种分词器
- properties：该字段的子字段
例如下面的json文档：
{
"age": 21,
"weight": 52.1,
"isMarried": false,
"info": "常山赵子龙",
"email": "[email protected]",
"score": [99.1, 99.5, 98.9],
"name": {
"firstName": "云",
"lastName": "赵"
}
}
对应的每个字段映射（mapping）：
- age：类型为 integer；参与搜索，因此需要index为true；无需分词器
- weight：类型为float；参与搜索，因此需要index为true；无需分词器
- isMarried：类型为boolean；参与搜索，因此需要index为true；无需分词器
- info：类型为字符串，需要分词，因此是text；参与搜索，因此需要index为true；分词器可以用ik_smart
- email：类型为字符串，但是不需要分词，因此是keyword；不参与搜索，因此需要index为false；无需分词器
- score：虽然是数组，但是我们只看元素的类型，类型为float；参与搜索，因此需要index为true；无需分词器
- name：类型为object，需要定义多个子属性
- name.firstName；类型为字符串，但是不需要分词，因此是keyword；参与搜索，因此需要index为true；无需分词器
- name.lastName；类型为字符串，但是不需要分词，因此是keyword；参与搜索，因此需要index为true；无需分词器
2. 索引库的CRUD
2.1 创建索引库的映射
基本语法：
- 请求方式：PUT
- 请求路径：/索引库名，可以自定义
- 请求参数：mapping映射
格式：
PUT /索引库名称
{
"mappings": {
"properties": {
"字段名":{
"type": "text",
"analyzer": "ik_smart"
},
"字段名2":{
"type": "keyword",
"index": "false"
},
"字段名3":{
"properties": {
"子字段": {
"type": "keyword"
}
}
},
// ...略
}
}
}
示例：
PUT /student
{
"mappings": {
"properties": {
"info":{
"type": "text",
"analyzer": "ik_smart"
},
"email":{
"type": "keyword",
"index": "falsae"
},
"name":{
"properties": {
"firstName": {
"type": "keyword"
}
}
},
// ... 略
}
}
}
2.2 查询索引库
基本语法：
- 请求方式：GET
- 请求路径：/索引库名称
- 请求参数：无
格式：
GET /索引库名称
2.3 修改索引库
倒排索引结构虽然不复杂，但是一旦数据结构改变（比如改变了分词器），就需要重新创建倒排索引，这简直是灾难。因此索引库一旦创建，无法修改mapping。
虽然无法修改mapping中已有的字段，但是却允许添加新的字段到mapping中，因为不会对倒排索引产生影响。
语法：
PUT /索引库名/_mapping
{
"properties": {
"新字段名":{
"type": "integer"
}
}
}
2.4 删除索引库
基本语法：
- 请求方式：DELETE
- 请求路径：/索引库名称
- 请求参数：无
格式：
DELETE /索引库名称
3. 文档的CRUD
3.1 新增文档
语法：
POST /索引库名/_doc/文档id
{
"字段1": "值1",
"字段2": "值2",
"字段3": {
"子属性1": "值3",
"子属性2": "值4"
},
// ...
}
示例：
POST /studnet/_doc/1
{
"info": "常山赵子龙",
"email": "[email protected]",
"name": {
"firstName": "云",
"lastName": "赵"
}
}
3.2 查询文档
根据rest风格，新增是post，查询应该是get，不过查询一般都需要条件，这里我们把文档id带上。
语法：
GET /{索引库名称}/_doc/{id}
示例：
GET /student/_doc/1
3.3 删除文档
删除使用DELETE请求，同样，需要根据id进行删除
语法：
DELETE /{索引库名}/_doc/id值
示例：
# 根据id删除数据
DELETE /heima/_doc/1
3.4 修改文档
修改有两种方式：
- 全量修改：直接覆盖原来的文档
- 增量修改：修改文档中的部分字段
3.4.1 全量修改
全量修改是覆盖原来的文档，其本质是：
- 根据指定的id删除文档
- 新增一个相同id的文档
注意：如果根据id删除时，id不存在，第二步的新增也会执行，也就从修改变成了新增操作了。
语法：
PUT /{索引库名}/_doc/文档id
{
"字段1": "值1",
"字段2": "值2",
// ... 略
}
示例：
PUT /student/_doc/1
{
"info": "常山赵子龙",
"email": "[email protected]",
"name": {
"firstName": "云",
"lastName": "赵"
}
}
3.4.2 增量修改
增量修改是只修改指定id匹配的文档中的部分字段。
语法：
POST /{索引库名}/_update/文档id
{
"doc": {
"字段名": "新的值",
}
}
示例：
POST /student/_update/1
{
"doc": {
"email": "[email protected]"
}
}
JavaRestClient操作elasticsearch的流程基本类似。核心是client.indices()方法来获取索引库的操作对象。
索引库操作的基本步骤：
- 初始化RestHighLevelClient
- 创建XxxIndexRequest。XXX是Create、Get、Delete
- 准备DSL（ Create时需要，其它是无参）
- 发送请求。调用RestHighLevelClient#indices().xxx()方法，xxx是create、exists、delete
四、DSL查询文档
1. DSL查询分类
Elasticsearch提供了基于JSON的DSL（Domain Specific Language）来定义查询。常见的查询类型包括：
-
查询所有：查询出所有数据，一般测试用。例如：match_all
-
全文检索（full text）查询：利用分词器对用户输入内容分词，然后去倒排索引库中匹配。例如：
- match_query
- multi_match_query
-
精确查询：根据精确词条值查找数据，一般是查找keyword、数值、日期、boolean等类型字段。例如：
- ids
- range
- term
-
地理（geo）查询：根据经纬度查询。例如：
- geo_distance
- geo_bounding_box
-
复合（compound）查询：复合查询可以将上述各种查询条件组合起来，合并查询条件。例如：
- bool
- function_score
查询的语法基本一致：
GET /indexName/_search
{
"query": {
"查询类型": {
"查询条件": "条件值"
}
}
}
我们以查询所有为例，其中：
- 查询类型为match_all
- 没有查询条件
// 查询所有
GET /indexName/_search
{
"query": {
"match_all": {
}
}
}
其它查询无非就是查询类型、查询条件的变化。
2. 全文检索查询
使用场景：
全文检索查询的基本流程如下：
- 对用户搜索的内容做分词，得到词条
- 根据词条去倒排索引库中匹配，得到文档id
- 根据文档id找到文档，返回给用户
比较常用的场景包括：
- 商城的输入框搜索
- 百度输入框搜索
例如京东：
因为是拿着词条去匹配，因此参与搜索的字段也必须是可分词的text类型的字段。
基本语法：
常见的全文检索查询包括：
- match查询：单字段查询
- multi_match查询：多字段查询，任意一个字段符合条件就算符合查询条件
match查询语法如下：
GET /indexName/_search
{
"query": {
"match": {
"FIELD": "TEXT"
}
}
}
mulit_match语法如下：
GET /indexName/_search
{
"query": {
"multi_match": {
"query": "TEXT",
"fields": ["FIELD1", " FIELD12"]
}
}
}
match和multi_match的区别是什么？
- match：根据一个字段查询
- multi_match：根据多个字段查询，参与查询字段越多，查询性能越差
3. 精确查询
精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有：
- term：根据词条精确值查询
- range：根据值的范围查询
3.1 term查询
因为精确查询的字段搜是不分词的字段，因此查询的条件也必须是不分词的词条。查询时，用户输入的内容跟自动值完全匹配时才认为符合条件。如果用户输入的内容过多，反而搜索不到数据。
基本语法：
// term查询
GET /indexName/_search
{
"query": {
"term": {
"FIELD": {
"value": "VALUE"
}
}
}
}
3.2 range查询
范围查询，一般应用在对数值类型做范围过滤的时候。比如做价格范围过滤。
基本语法：
// range查询
GET /indexName/_search
{
"query": {
"range": {
"FIELD": {
"gte": 10, // 这里的gte代表大于等于，gt则代表大于
"lte": 20 // lte代表小于等于，lt则代表小于
}
}
}
}
精确查询常见的有哪些？
- term查询：根据词条精确匹配，一般搜索keyword类型、数值类型、布尔类型、日期类型字段
- range查询：根据数值范围查询，可以是数值、日期的范围
4. 地理坐标查询
所谓的地理坐标查询，其实就是根据经纬度查询，官方文档：https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-queries.html
常见的使用场景包括：
- 携程：搜索我附近的酒店
- 滴滴：搜索我附近的出租车
- 微信：搜索我附近的人
4.1 矩形范围查询
矩形范围查询，也就是geo_bounding_box查询，查询坐标落在某个矩形范围的所有文档：
查询时，需要指定矩形的左上、右下两个点的坐标，然后画出一个矩形，落在该矩形内的都是符合条件的点。
基本语法：
// geo_bounding_box查询
GET /indexName/_search
{
"query": {
"geo_bounding_box": {
"FIELD": {
"top_left": { // 左上点
"lat": 31.1,
"lon": 121.5
},
"bottom_right": { // 右下点
"lat": 30.9,
"lon": 121.7
}
}
}
}
}
4.2 附近查询
附近查询，也叫做距离查询（geo_distance）：查询到指定中心点小于某个距离值的所有文档。
换句话来说，在地图上找一个点作为圆心，以指定距离为半径，画一个圆，落在圆内的坐标都算符合条件：
基本语法：
// geo_distance 查询
GET /indexName/_search
{
"query": {
"geo_distance": {
"distance": "15km", // 半径
"FIELD": "31.21,121.5" // 圆心
}
}
}
5. 复合查询
复合（compound）查询：复合查询可以将其它简单查询组合起来，实现更复杂的搜索逻辑。常见的有两种：
- fuction score：算分函数查询，可以控制文档相关性算分，控制文档排名
- bool query：布尔查询，利用逻辑关系组合多个其它的查询，实现复杂搜索
5.1 算分函数查询
根据相关度打分是比较合理的需求，但合理的不一定是产品经理需要的。
以百度为例，你搜索的结果中，并不是相关度越高排名越靠前，而是谁掏的钱多排名就越靠前。如图：
要想认为控制相关性算分，就需要利用elasticsearch中的function score 查询了。
基本语法：
function score 查询中包含四部分内容：
- 原始查询条件：query部分，基于这个条件搜索文档，并且基于BM25算法给文档打分，原始算分（query score)
- 过滤条件：filter部分，符合该条件的文档才会重新算分
- 算分函数：符合filter条件的文档要根据这个函数做运算，得到的函数算分（function score），有四种函数
- weight：函数结果是常量
- field_value_factor：以文档中的某个字段值作为函数结果
- random_score：以随机数作为函数结果
- script_score：自定义算分函数算法
- 运算模式：算分函数的结果、原始查询的相关性算分，两者之间的运算方式，包括：
- multiply：相乘
- replace：用function score替换query score
- 其它，例如：sum、avg、max、min
function score的运行流程如下：
- 1）根据原始条件查询搜索文档，并且计算相关性算分，称为原始算分（query score）
- 2）根据过滤条件，过滤文档
- 3）符合过滤条件的文档，基于算分函数运算，得到函数算分（function score）
- 4）将原始算分（query score）和函数算分（function score）基于运算模式做运算，得到最终结果，作为相关性算分。
因此，其中的关键点是：
- 过滤条件：决定哪些文档的算分被修改
- 算分函数：决定函数算分的算法
- 运算模式：决定最终算分结果
示例：
需求：给“如家”这个品牌的酒店排名靠前一些
翻译一下这个需求，转换为之前说的四个要点：
- 原始条件：不确定，可以任意变化
- 过滤条件：brand = “如家”
- 算分函数：可以简单粗暴，直接给固定的算分结果，weight
- 运算模式：比如求和
DSL语句如下：
GET /hotel/_search
{
"query": {
"function_score": {
"query": { .... }, // 原始查询，可以是任意条件
"functions": [ // 算分函数
{
"filter": { // 满足的条件，品牌必须是如家
"term": {
"brand": "如家"
}
},
"weight": 2 // 算分权重为2
}
],
"boost_mode": "sum" // 加权模式，求和
}
}
}
function score query定义的三要素是什么？
- 过滤条件：哪些文档要加分
- 算分函数：如何计算function score
- 加权方式：function score 与 query score如何运算
5.2 布尔查询
布尔查询是一个或多个查询子句的组合，每一个子句就是一个子查询。子查询的组合方式有：
- must：必须匹配每个子查询，类似“与”
- should：选择性匹配子查询，类似“或”
- must_not：必须不匹配，不参与算分，类似“非”
- filter：必须匹配，不参与算分
需要注意的是，搜索时，参与打分的字段越多，查询的性能也越差。因此这种多条件查询时，建议这样做：
- 搜索框的关键字搜索，是全文检索查询，使用must查询，参与算分
- 其它过滤条件，采用filter查询。不参与算分
示例：
需求：搜索名字包含“如家”，价格不高于400，在坐标31.21,121.5周围10km范围内的酒店。
分析：
- 名称搜索，属于全文检索查询，应该参与算分。放到must中
- 价格不高于400，用range查询，属于过滤条件，不参与算分。放到must_not中
- 周围10km范围内，用geo_distance查询，属于过滤条件，不参与算分。放到filter中
bool查询有几种逻辑关系？
- must：必须匹配的条件，可以理解为“与”
- should：选择性匹配的条件，可以理解为“或”
- must_not：必须不匹配的条件，不参与打分
- filter：必须匹配的条件，不参与打分
五、搜索结果处理
1. 排序
elasticsearch默认是根据相关度算分（_score）来排序，但是也支持自定义方式对搜索结果排序。可以排序字段类型有：keyword类型、数值类型、地理坐标类型、日期类型等。
1.1 普通字段排序
keyword、数值、日期类型排序的语法基本一致。
语法：
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"FIELD": "desc" // 排序字段、排序方式ASC、DESC
}
]
}
排序条件是一个数组，也就是可以写多个排序条件。按照声明的顺序，当第一个条件相等时，再按照第二个条件排序，以此类推
1.2 地理坐标排序
地理坐标排序略有不同。
语法：
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"_geo_distance" : {
"FIELD" : "纬度，经度", // 文档中geo_point类型的字段名、目标坐标点
"order" : "asc", // 排序方式
"unit" : "km" // 排序的距离单位
}
}
]
}
这个查询的含义是：
- 指定一个坐标，作为目标点
- 计算每一个文档中，指定字段（必须是geo_point类型）的坐标 到目标点的距离是多少
- 根据距离排序
2. 分页
语法：
GET /hotel/_search
{
"query": {
"match_all": {}
},
"from": 0, // 分页开始的位置，默认为0
"size": 10, // 期望获取的文档总数
"sort": [
{"price": "asc"}
]
}
3. 高亮
什么是高亮显示呢？
我们在百度，京东搜索时，关键字会变成红色，比较醒目，这叫高亮显示：
高亮显示的实现分为两步：
- 1）给文档中的所有关键字都添加一个标签，例如
标签 - 2）页面给
标签编写CSS样式
语法：
GET /hotel/_search
{
"query": {
"match": {
"FIELD": "TEXT" // 查询条件，高亮一定要使用全文检索查询
}
},
"highlight": {
"fields": { // 指定要高亮的字段
"FIELD": {
"pre_tags": "", // 用来标记高亮字段的前置标签
"post_tags": "" // 用来标记高亮字段的后置标签
}
}
}
}
注意：
- 高亮是对关键字高亮，因此搜索条件必须带有关键字，而不能是范围这样的查询。
- 默认情况下，高亮的字段，必须与搜索指定的字段一致，否则无法高亮
- 如果要对非搜索字段高亮，则需要添加一个属性：required_field_match=false
六、RestClient相关操作
1. RestClient操作索引库
import org.apache.http.HttpHost;
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.client.indices.CreateIndexRequest;
import org.elasticsearch.client.indices.GetIndexRequest;
import org.elasticsearch.common.xcontent.XContentType;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.io.IOException;
@SpringBootTest
public class HotelIndexTest {
private RestHighLevelClient client;
// 创建索引库
@Test
void creatHotelIndex() throws IOException {
// 1. 创建Request对象
CreateIndexRequest request = new CreateIndexRequest("hotel");
// 2. 请求参数，source是创建索引库的DSL语句
request.source("{\n" +
" \"mappings\": {\n" +
" \"properties\": {\n" +
" \"id\": {\n" +
" \"type\": \"keyword\"\n" +
" },\n" +
" \"name\":{\n" +
" \"type\": \"text\",\n" +
" \"analyzer\": \"ik_max_word\",\n" +
" \"copy_to\": \"all\"\n" +
" },\n" +
" \"address\":{\n" +
" \"type\": \"keyword\",\n" +
" \"index\": false\n" +
" },\n" +
" \"price\":{\n" +
" \"type\": \"integer\"\n" +
" },\n" +
" \"score\":{\n" +
" \"type\": \"integer\"\n" +
" },\n" +
" \"brand\":{\n" +
" \"type\": \"keyword\",\n" +
" \"copy_to\": \"all\"\n" +
" },\n" +
" \"city\":{\n" +
" \"type\": \"keyword\",\n" +
" \"copy_to\": \"all\"\n" +
" },\n" +
" \"starName\":{\n" +
" \"type\": \"keyword\"\n" +
" },\n" +
" \"business\":{\n" +
" \"type\": \"keyword\"\n" +
" },\n" +
" \"location\":{\n" +
" \"type\": \"geo_point\"\n" +
" },\n" +
" \"pic\":{\n" +
" \"type\": \"keyword\",\n" +
" \"index\": false\n" +
" },\n" +
" \"all\":{\n" +
" \"type\": \"text\",\n" +
" \"analyzer\": \"ik_max_word\"\n" +
" }\n" +
" }\n" +
" }\n" +
"}", XContentType.JSON);
// 3. 发送请求
client.indices().create(request, RequestOptions.DEFAULT);
}
// 删除索引库
@Test
void deleteHotelIndex() throws IOException {
// 1. 构建Request请求对象
DeleteIndexRequest request = new DeleteIndexRequest("hotel");
// 2. 发送请求
client.indices().delete(request, RequestOptions.DEFAULT);
}
// 判断索引库是否存在
@Test
void existHotelIndex() throws IOException {
// 1. 构建Request请求对象
GetIndexRequest request = new GetIndexRequest("hotel");
// 2. 发送请求
boolean exists = client.indices().exists(request, RequestOptions.DEFAULT);
System.err.println(exists ? "索引库已经存在！" : "索引库不存在！");
}
@BeforeEach
void setUp() {
client = new RestHighLevelClient(
RestClient.builder(
HttpHost.create("192.168.200.102:9200")));
}
@AfterEach
void tearDown() throws IOException {
client.close();
}
}
2. RestClient的文档基本操作
import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.pojo.HotelDoc;
import cn.itcast.hotel.service.IHotelService;
import com.alibaba.fastjson.JSON;
import org.apache.http.HttpHost;
import org.elasticsearch.action.bulk.BulkRequest;
import org.elasticsearch.action.delete.DeleteRequest;
import org.elasticsearch.action.get.GetRequest;
import org.elasticsearch.action.get.GetResponse;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.action.update.UpdateRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.common.xcontent.XContentType;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.io.IOException;
import java.util.List;
@SpringBootTest
class HotelDocumentTest {
private RestHighLevelClient client;
@Autowired
private IHotelService hotelService;
// 新增文档
@Test
void addDocument() throws IOException {
// 1. 根据id查询数据库数据
Hotel hotel = hotelService.getById(61083L);
// 2. 转换为文档类型对应的对象
HotelDoc hotelDoc = new HotelDoc(hotel);
// 3. 转换为JSON
String json = JSON.toJSONString(hotelDoc);
// 4. 构建Request对象
IndexRequest request = new IndexRequest("hotel").id(hotelDoc.getId().toString());
request.source(json, XContentType.JSON);
// 5. 发送请求
client.index(request, RequestOptions.DEFAULT);
}
// 删除文档
@Test
void deleteDocument() throws IOException {
// 1. 构建Request对象
DeleteRequest request = new DeleteRequest("hotel", "61083");
// 2. 发送请求
client.delete(request, RequestOptions.DEFAULT);
}
// 更新文档
@Test
void updateDocument() throws IOException {
// 1. 构建Request对象
UpdateRequest request = new UpdateRequest("hotel", "61083");
request.doc(
"price", "952",
"starName", "四钻"
);
// 3. 发送请求
client.update(request, RequestOptions.DEFAULT);
}
// 查询文档
@Test
void queryDocument() throws IOException {
// 1. 构建Request对象
GetRequest request = new GetRequest("hotel", "61083");
// 2. 发送请求
GetResponse response = client.get(request, RequestOptions.DEFAULT);
// 3. 获取响应内容
String json = response.getSourceAsString();
// 4. 转换为Java对象
HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
System.err.println(hotelDoc);
}
// 批量新增文档
@Test
void bulkInsert() throws IOException {
// 1. 构建Request对象
BulkRequest request = new BulkRequest();
List<Hotel> hotelList = hotelService.list();
for (Hotel hotel : hotelList) {
HotelDoc hotelDoc = new HotelDoc(hotel);
request.add(new IndexRequest("hotel")
.id(hotelDoc.getId().toString())
.source(JSON.toJSONString(hotelDoc), XContentType.JSON));
}
// 2. 发送请求
client.bulk(request, RequestOptions.DEFAULT);
}
@BeforeEach
void setUp() {
client = new RestHighLevelClient(
RestClient.builder(
HttpHost.create("192.168.200.102:9200")));
}
@AfterEach
void tearDown() throws IOException {
client.close();
}
}
文档操作的基本步骤：
- 初始化RestHighLevelClient
- 创建XxxRequest。XXX是Index、Get、Update、Delete、Bulk
- 准备参数（Index、Update、Bulk时需要）
- 发送请求。调用RestHighLevelClient#.xxx()方法，xxx是index、get、update、delete、bulk
- 解析结果（Get时需要）
3. DSL
3.1 match_all
代码：
@Test
void matchAll() throws IOException {
// 1. 构建request对象
SearchRequest request = new SearchRequest("hotel");
// 2. DSL
request.source().query(QueryBuilders.matchAllQuery());
// 3. 发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
handlerResponse(response);
}
private void handlerResponse(SearchResponse response) {
SearchHits searchHits = response.getHits();
long total = searchHits.getTotalHits().value;
System.out.println("共有 " + total + " 条数据");
SearchHit[] hits = searchHits.getHits();
for (SearchHit hit : hits) {
String json = hit.getSourceAsString();
System.out.println(json);
}
}
查询代码：
-
第一步，创建
SearchRequest对象，指定索引库名这里关键的API有两个，一个是
request.source()，其中包含了查询、排序、分页、高亮等所有功能另一个是
QueryBuilders，其中包含match、term、function_score、bool等各种查询： -
第二步，利用
request.source()构建DSL，DSL中可以包含查询、分页、排序、高亮等query()：代表查询条件，利用QueryBuilders.matchAllQuery()构建一个match_all查询的DSL
-
第三步，利用client.search()发送请求，得到响应
结果解析代码：
elasticsearch返回的结果是一个JSON字符串，结构包含：
hits：命中的结果total：总条数，其中的value是具体的总条数值max_score：所有结果中得分最高的文档的相关性算分hits：搜索结果的文档数组，其中的每个文档都是一个json对象_source：文档中的原始数据，也是json对象
因此，我们解析响应结果，就是逐层解析JSON字符串，流程如下：
SearchHits：通过response.getHits()获取，就是JSON中的最外层的hits，代表命中的结果SearchHits#getTotalHits().value：获取总条数信息SearchHits#getHits()：获取SearchHit数组，也就是文档数组SearchHit#getSourceAsString()：获取文档结果中的_source，也就是原始的json文档数据
3.2 match 查询
全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件，也就是query的部分。
@Test
void match() throws IOException {
// 1. 构建request
SearchRequest request = new SearchRequest("hotel");
// 2. DSL
// request.source().query(QueryBuilders.matchQuery("all", "如家"));
request.source().query(QueryBuilders.multiMatchQuery("如家", "name", "business"));
// 3. 发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
handlerResponse(response);
}
3.4 精确查询
精确查询主要是两者：
- term：词条精确匹配
- range：范围查询
与之前的查询相比，差异同样在查询条件，其它都一样。
// term
request.source().query(QueryBuilders.termQuery("city", "上海"));
// range
request.source().query(QueryBuilders.rangeQuery("price").gt(100).lt(300));
3.5 布尔查询
布尔查询是用must、must_not、filter等方式组合其它查询，代码示例如下：
@Test
void boolQuery() throws IOException {
// 1. 构建request
SearchRequest request = new SearchRequest("hotel");
// 2. DSL
// 2.1 构建布尔查询
BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
boolQuery.must(QueryBuilders.termQuery("city", "上海"));
boolQuery.filter(QueryBuilders.rangeQuery("price").lt(250));
// 2.2 加入查询参数
request.source().query(boolQuery);
// 3. 发送请求
client.search(request, RequestOptions.DEFAULT);
}
3.6 分页和排序
搜索结果的排序和分页是与query同级的参数，因此同样是使用request.source()来设置。
@Test
void pageAndSort() throws IOException {
// 1. 构建request
SearchRequest request = new SearchRequest("hotel");
// 2. DSL
request.source().query(QueryBuilders.matchAllQuery());
request.source().from(0).size(5);
request.source().sort("price", SortOrder.DESC);
// 3. 发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
handlerResponse(response);
}
3.7 高亮
高亮的代码与之前代码差异较大，有两点：
- 查询的DSL：其中除了查询条件，还需要添加高亮条件，同样是与query同级。
- 结果解析：结果除了要解析_source文档数据，还要解析高亮结果
请求代码：
@Test
void highLight() throws IOException {
// 1. 构建request
SearchRequest request = new SearchRequest("hotel");
// 2. DSL
request.source().query(QueryBuilders.matchQuery("name", "如家"));
request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
// 3. 发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
handlerResponse(response);
}
代码解读：
- 第一步：从结果中获取source。hit.getSourceAsString()，这部分是非高亮结果，json字符串。还需要反序列为HotelDoc对象
- 第二步：获取高亮结果。hit.getHighlightFields()，返回值是一个Map，key是高亮字段名称，值是HighlightField对象，代表高亮值
- 第三步：从map中根据高亮字段名称，获取高亮字段值对象HighlightField
- 第四步：从HighlightField中获取Fragments，并且转为字符串。这部分就是真正的高亮字符串了
- 第五步：用高亮的结果替换HotelDoc中的非高亮结果
响应结果解析：
private void handlerResponse(SearchResponse response) {
SearchHits searchHits = response.getHits();
long total = searchHits.getTotalHits().value;
System.out.println("共有 " + total + " 条数据");
SearchHit[] hits = searchHits.getHits();
for (SearchHit hit : hits) {
String json = hit.getSourceAsString();
// 反序列化
HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
// 获取高亮结果
Map<String, HighlightField> highlightFields = hit.getHighlightFields();
if (!CollectionUtils.isEmpty(highlightFields)) {
// 根据字段名获取高亮结果
HighlightField highlightField = highlightFields.get("name");
if (highlightField != null) {
// 获取高亮值
String name = highlightField.getFragments()[0].string();
// 覆盖非高亮结果
hotelDoc.setName(name);
}
}
System.out.println("hotelDoc = " + hotelDoc);
}
}