SpringBoot：整合Elasticsearch

1&＃xff0c;基本概念

1.1&＃xff0c;下载安装

Elasticsearch与Solr类似&＃xff0c;同样是一个基于Lucene的开源的分布式搜索引擎。当年由于Lucene的Java API比较难用&＃xff0c;于是Shay Banon就开发 出一个叫作Compass的框架来对Lucene进行封装。Compass框架用起来十分方便&＃xff0c;后来发现在2009年之后&＃xff0c;Compass项目就不更新了。因为Shay Banon用Elasticsearch取代了Compass。由于Compass只是一个Java框架&＃xff0c;所以必须掌握Java编程才能使用Compass&＃xff1b;而Elasticsearch则是一个独立应用&＃xff0c;它提供了RESTful的操作接口&＃xff0c;因此不管用什么编程语言&＃xff0c; 即使不会编程&＃xff0c;也可使用Elasticsearch&＃xff0c;只要会用Postman或curl发送请求即可。

&＃xff08;1&＃xff09;登录官网&＃xff08;地址&＃xff09;下载Elasticsearch&＃xff0c;版本对照关系&＃xff08;地址&＃xff09;

Elasticsearch启动报错&＃xff1a;
warning: ignoring JAVA_HOME&＃61;C:\Program Files\Java\jdk1.8.0_191&＃xff1b; using bundled JDK。原因是JDK和Elasticsearch版本不对应。warning: usage of JAVA_HOME is deprecated, use ES_JAVA_HOME。原因是 elasticsearch 7系列版本以上都是自带的jdk,可以在es的bin目录下找到elasticsearch-env.bat这个文件&＃xff0c;配置es的jdk。官方推荐使用es自带的jdk。

&＃xff08;2&＃xff09;下载后得到Elasticsearch

➢ bin&＃xff1a;该目录下包含Elasticsearch的各种工具命令。
➢ config&＃xff1a;该目录下包含Elasticsearch的各种配置文件&＃xff0c;尤其是elasticsearch.yml和jvm.options两个配置文件很重要&＃xff0c;其中elasticsearch.yml用于配置Elasticsearch&＃xff0c;jvm.options用于配置JVM的堆内存,垃圾回收机制等选项。
➢ jdk&＃xff1a;该目录下包含一份最新的JDK。
➢ lib&＃xff1a;该目录下保存Elasticsearch的核心JAR包及依赖的第三方JAR包。
➢ logs&＃xff1a;日志目录。
➢ plugins&＃xff1a;Elasticsearch的插件目录。


&＃xff08;3&＃xff09;配置环境变量

JAVA_HOME:E:\Java\jdk-1.11
PATH:E:\Elasticsearch

&＃xff08;4&＃xff09;修改elasticsearch.yml文件

cluster.name: my-application #配置集群名
node.name: node-1 #配置节点名
#network.host: 192.168.0.1 #配置Elasticsearch绑定的IP地址
#http.port: 9200 #监听端口

Elasticsearch的集群配置非常简单&＃xff0c;在同一个局域网内的多个节点&＃xff08;多个Elasticsearch服务器&＃xff09;上只要指定了相同的 cluster.name&＃xff0c;它们都会自动加入同一个集群。因此&＃xff0c;一个节点只要设置了cluster.name就能加入集群&＃xff0c;成为集群的一部分。

&＃xff08;5&＃xff09;启动Elasticsearch

访问(http://localhost:9200)发送GET请求&＃xff0c;输出name&＃xff0c;cluster_name就是前面配置的节点名和集群名&＃xff0c;也可以看到Elasticsearch的版本信息。则表明Elasticsearch启动成功。

1.2&＃xff0c;Elasticsearch安全配置 

如果想就这样使用Elasticsearch&＃xff0c;当然也是可以的&＃xff0c;但很明显安全性不够&＃xff0c;下面为Elasticsearch启用SSL支持&＃xff0c;以及配置用户名&＃xff0c;密码。

&＃xff08;1&＃xff09;修改config目录下的elasticsearch.yml文件&＃xff0c;添加内容。

# ---------------------------------- Security ----------------------------------
xpack.security.enabled: true

&＃xff08;2&＃xff09;启动Elasticsearch&＃xff0c;打开新CMD然后设置密码。

Elasticsearch内置了用于不同目的几个用户&＃xff0c;故此处要依次为每个用户设置密码&＃xff0c;每个密码都要设置两次。

• elastic&＃xff1a;超级用户。
• kibana&＃xff1a;Kibana通过该用户连接Elasticsearch。
• logstash_system&＃xff1a;Logstash将监控信息存储到Elasticsearch中时使用该用户。
• beats_system&＃xff1a;Beats在Elasticsearch中存储监视信息时使用该用户。
• apm_system&＃xff1a;APM服务器在Elasticsearch中存储监视信息时使用该用户。
• remote_monitoring_user&＃xff1a;Metricbeat用户在Elasticsearch中收集和存储监视信息时使用该用户。

1.3&＃xff0c;Index操作

【Elastisearch、RDBMS、Solr基本对应关系】

RDBMS	Elasticsearch	Solr
Table	Index	Core&＃xff08;Collection&＃xff09;
row&＃xff08;行&＃xff09;	Document&＃xff08;文档&＃xff09;	Document&＃xff08;文档&＃xff09;
column&＃xff08;列&＃xff09;	Field&＃xff08;字段&＃xff09;	Field&＃xff08;字段&＃xff09;

&＃xff08;1&＃xff09;添加Index

curl -k -u elastic:123456 -X PUT http://localhost:9200/test

PS&＃xff1a;不允许使用大写

&＃xff08;2&＃xff09;查看Index

curl -k -u elastic:123456 http://localhost:9200/_cat/indices

结果以点 (.) 开头的Index是Elasticsearch内置的Index。

&＃xff08;3&＃xff09;删除Index

curl -k -u elastic:123456 -X DELETE http://localhost:9200/test

&＃xff08;4&＃xff09;替换默认分词器&＃xff1a;Elasticsearch 内置了一些分词器&＃xff0c;但这些分词器对中文支持并不 好&＃xff0c;这里可选择使用 IK 分词器来处理中文分词&＃xff08;地址&＃xff09;&＃xff0c;注意版本对应关系。

elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v7.16.3/elasticsearch-analysis-ik-7.16.3.zip

安装完成后&＃xff0c;IK分词器会被自动安装到Elasticsearch的plugins目录下&＃xff0c;还会在config目录下创建一个analysis-ik子目录&＃xff0c;用于保存IK分词器的配置文件。为Elasticsearch安装任何插件后都需要重启Elasticsearch服务器来加载IK分词器。然后在当前目录下&＃xff08;命令行提示符“>”前的路径&＃xff09;下创建一个配置文件&＃xff1a;

{"settings": {"analysis": {"analyzer": {"default": {"tokenizer": "ik_max_word"}}}}
}

上面文件指定为Index设置默认的中文分词器&＃xff1a;ik_max_word&＃xff0c;该分词器由IK分词器提供&＃xff0c;它还提供了一个名为“ik_smart”的中文分词器。

curl -k -u elastic:123456 -X PUT http://localhost:9200/test -d &＃64;test.json -H "Content-Type:application/json"-H:设置Content-Type请求头的值为“application/json”&＃xff1b;
-d:用于读取配置文件的内容作为请求数据。

• 在命令行所在的当前路径下定义一个test.json文件&＃xff0c;该JSON文件指定使用ik_max_word分词器&＃xff0c;text属性指定要测试分 词的文本内容。

{"analyzer": "ik_max_word","text": "Elasticsearch与Solr类似&＃xff0c;同样是一个基于Lucene的开源的分布式搜索引擎。"
}

• 运行如下命令

curl -k -u elastic:123456 -X POST http://localhost:9200/test/_analyze?pretty&＃61;true -d &＃64;test.json -H "Content-Type:application/json"{"tokens" : [{"token" : "elasticsearch","start_offset" : 0,"end_offset" : 13,"type" : "ENGLISH","position" : 0},{"token" : "与","start_offset" : 13,"end_offset" : 14,"type" : "CN_CHAR","position" : 1},......]
}

每个词都被称作一个token&＃xff0c;每个token都对应如下属性&＃xff1a;

• start_offset&＃xff1a;起始位置。
• end_offset&＃xff1a;结束位置。
• type&＃xff1a;类型。
• position&＃xff1a;词的位置。

1.4&＃xff0c;文档操作

&＃xff08;1&＃xff09;添加文档&＃xff1a;在命令行所在的当前路径下定义一个book.json文件&＃xff0c;内容如下&＃xff1a;

{"name": "呐喊","description": "生动地塑造了狂人、孔乙己、阿Q等一批不朽的艺术形象&＃xff0c;深刻反映了19世纪末到20世纪20年代间中国社会生活的现状&＃xff0c;有力揭露和鞭挞了封建旧恶势力&＃xff0c;表达了作者渴望变革&＃xff0c;为时代呐喊&＃xff0c;希望唤醒国民的思想。","price": 35
}

curl -k -u elastic:123456 -X POST http://localhost:9200/test/book/1 -d &＃64;book.json -H "Content-Type:application/json"
{"_index":"test","_type":"book","_id":"1","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}book:就是type
1:就是被添加文档的ID&＃xff0c;这个ID其实是字符串&＃xff0c;因此也可指定为“abc”

&＃xff08;2&＃xff09;查看Index下所有文档&＃xff1a;命令中的pretty&＃61;true是一个很常见的参数&＃xff0c;用于让Elasticsearch生成格式良好的响应。从该命令可以看出&＃xff0c;查看Index下的所有文档&＃xff0c;只要在该Index后添加“_search”即可。

curl -k -u elastic:123456 http://localhost:9200/test/_search?pretty&＃61;true
{"took" : 717,"timed_out" : false,"_shards" : {"total" : 1,"successful" : 1,"skipped" : 0,"failed" : 0},"hits" : {"total" : {"value" : 1,"relation" : "eq"},"max_score" : 1.0,"hits" : [{"_index" : "test","_type" : "book","_id" : "1","_score" : 1.0,"_source" : {"name" : "呐喊","description" : "生动地塑造了狂人、孔乙己、阿Q等一批不朽的艺术形象&＃xff0c;深刻反映了19世纪末到20世纪20年代间中国社会生活的现状&＃xff0c;有力揭露和鞭挞了封建旧恶势力&＃xff0c;表达了作者渴望变革&＃xff0c;为时代呐喊&＃xff0c;希望唤醒国民的思想。","price" : 35}}]}
}

&＃xff08;3&＃xff09;查看Index下指定ID的文档&＃xff1a;

curl -k -u elastic:123456 http://localhost:9200/test/book/1?pretty&＃61;true
{"_index" : "test","_type" : "book","_id" : "1","_version" : 1,"_seq_no" : 0,"_primary_term" : 1,"found" : true,"_source" : {"name" : "呐喊","description" : "生动地塑造了狂人、孔乙己、阿Q等一批不朽的艺术形象&＃xff0c;深刻反映了19世纪末到20世纪20年代间中国社会生活的现状&＃xff0c;有力揭露和鞭挞了封建旧恶势力&＃xff0c;表达了作者渴望变革&＃xff0c;为时代呐喊&＃xff0c;希望唤醒国民的思想。","price" : 35}
}

&＃xff08;4&＃xff09;删除指定ID的文档&＃xff1a;

curl -k -u elastic:123456 -X DELETE http://localhost:9200/test/book/1
{"_index":"test","_type":"book","_id":"1","_version":2,"result":"deleted","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":1,"_primary_term":1}

&＃xff08;5&＃xff09;全文检索&＃xff1a;执行全文检索同样是向 Index 后加“_search”的 URL 地址发送请求&＃xff0c;只不过需要添加 JSON格式的请求数据而已。

{"query": {"match": {"description": "孔乙己"}}
}

Elasticsearch自己的查询语法&＃xff08;地址&＃xff09;&＃xff0c;它要求查询参数满足JSON格式&＃xff0c;其中query属性的值才是实际的查询参数&＃xff1a;

• match 表明使用普通关键词查询
• regexp 表示正则表达式查询
• fuzzy表示模糊查询
• prefix 表示前缀查询
• wildcard表示通配符查询
• range表示范围查询
• query_string定义查询字符串

curl -k -u elastic:123456 http://localhost:9200/test/_search?pretty&＃61;true -d &＃64;search.json -H "Content-Type:application/json"

&＃xff08;6&＃xff09;根据查询删除&＃xff1a;如果要根据查询条件来删除文档&＃xff0c;只要向Index后加“_delete_by_que ry”的URL地址发送POST请求即可。

curl -k -u elastic:123456 -X POST http://localhost:9200/test/_delete_by_query?pretty&＃61;true -d &＃64;search.json -H "Content-Type:application/json"

2&＃xff0c;RESTful客户

2.1&＃xff0c;使用RESTful客户端操作Elasticsearch

如果打算使用 Elasticsearch 自带的 RestClient 来操作 Elasticsearch&＃xff0c;甚至不需要添加 spring-boot-starter-data-elasticsearch依赖&＃xff0c;则直接使用最基本的spring-boot-starter依赖和Elasticsearch提供的RestClient依赖即可。

Elasticsearch官方提供的RestClient分为两种&＃xff1a;

• 高级RestClient&＃xff08;推荐&＃xff09;&＃xff1a;开发者面向Index&＃xff0c;文档等高层次的API编程&＃xff0c;因此更加简单&＃xff0c;方便。通常建议以高级 RestClient 为主&＃xff0c;只有当高级 RestClient 实在搞不定时&＃xff0c;才考虑使用低级RestClient。
• 低级RestClient&＃xff1a;开发者直接面向底层 RESTful 接口编程&＃xff0c;发送最原始的请求参数&＃xff0c;Elasticsearch 服务器也返回最原始的响应&＃xff0c;这种方式需要开发者自行处理请求&＃xff0c;响应的序列化和反序列化&＃xff0c;相当麻烦&＃xff0c;但灵活性最好。

Spring Boot只要检测到类路径下有 elasticsearch-rest-high-level-client 依赖&＃xff08;无须使用Spring Data Elasticsearch&＃xff09;&＃xff0c;Spring Boot 就会在容器中创建一个自动配置的 RestHighLevelClient&＃xff0c;它就是Elasticsearch的高级RestClient。如果想使用低级RestClient&＃xff0c;只要调用它的 getLowLevelClient() 方法即可返回 ResLowLevelClient&＃xff0c;它就是Elasticsearch的低级RestClient。

如果需要对 RestClient 进行定制&＃xff0c;则可在容器中部署一个或多个 RestClientBuilderCustomizerBean&＃xff0c;该 Bean 的 customize() 方法即可对 RestClientBuilder、HttpAsyncClientBuilder、RequestConfig.Builder进行定制&＃xff0c; 这些定制最终将作用于Elasticsearch的RestClient。

当容器中有了自动配置的RestHighLevelClient之后&＃xff0c;容器可通过依赖注入将它注入其他任何组件&＃xff08;主要是DAO组件&＃xff09;&＃xff0c;接下来该组件可通过它的如下方法来操作Elasticsearch索引库&＃xff1a;

• count(CountRequest countRequest&＃xff0c;RequestOptions options)&＃xff1a; 查询符合条件的文档数量。
• countAsync(CountRequest countRequest&＃xff0c;RequestOptions option s&＃xff0c;ActionListener listener)&＃xff1a;以异步方式查询符合条件的文档数量&＃xff0c;其中 listener 参数负责处理异步查询的结果。
• delete(DeleteRequest deleteRequest&＃xff0c;RequestOptions options)&＃xff1a; 根据ID删除文档。
• deleteAsync(DeleteRequest deleteRequest&＃xff0c;RequestOptions option s&＃xff0c;ActionListener listener)&＃xff1a;以异步方式根据ID删除文档&＃xff0c;其中listener参数负责处理异步删除的结果。
• deleteByQuery(DeleteByQueryRequest deleteByQueryRequest&＃xff0c;RequestOptions options)&＃xff1a;删除符合查询条件的文档。
• deleteByQueryAsync(DeleteByQueryRequest deleteByQueryRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式删除符合查询条件的文档&＃xff0c;其中listener参数负责处理异步删除的结果。
• exists(GetRequest getRequest&＃xff0c;RequestOptions options)&＃xff1a;判断指定ID对应的文档是否存在。
• existsAsync(GetRequest getRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式判断指定ID对应的文档是否存在。
• get(GetRequest getRequest&＃xff0c;RequestOptions options)&＃xff1a;根据ID 获取文档。
• getAsync(GetRequest getRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式根据ID获取文档。
• index(IndexRequest indexRequest&＃xff0c;RequestOptions options)&＃xff1a;创建索引或文档。
• indexAsync(IndexRequest indexRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式创建索引或文档。
• mget(MultiGetRequest multiGetRequest&＃xff0c;RequestOptions option s)&＃xff1a;根据多个ID获取多个文档。
• mgetAsync(MultiGetRequest multiGetRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式根据多个ID获取多个文档。
• msearch(MultiSearchRequest multiSearchRequest&＃xff0c;RequestOptions options)&＃xff1a;根据多个查询条件返回文档。
• msearchAsync(MultiSearchRequest multiSearchRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式根据多个查询条件返回文档。
• search(SearchRequest searchRequest&＃xff0c;RequestOptions option s)&＃xff1a;查询文档。
• searchAsync(SearchRequest searchRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式查询文档。
• update(UpdateRequest updateRequest &＃xff0c; RequestOptions options)&＃xff1a;根据ID更新文档。
• updateAsync(UpdateRequest updateRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式根据ID更新文档。
• updateByQuery(UpdateByQueryRequest updateByQueryRequest&＃xff0c; RequestOptions options&＃xff09;&＃xff1a;更新符合条件的所有文档。
• updateByQueryAsync(UpdateByQueryRequest updateByQueryRequest&＃xff0c;RequestOptions options&＃xff0c;ActionListener listener)&＃xff1a;以异步方式更新符合条件的所有文档。

此外&＃xff0c;它还提供了大量 xxx() 方法来返回对应的 XxxClient&＃xff0c;如 asyncSearch() 方法返回AsyncSearchClient&＃xff0c;cluster() 方法返回 ClusterClient&＃xff0c;eql() 方法返回 EqlClient&＃xff0c;indices()方法返回IndicesClient……这些XxxClient又提供了大量的方法来执行相应的操作。

&＃xff08;1&＃xff09;添加 elasticsearch-rest-high-level-client 依赖

org.elasticsearch.clientelasticsearch-rest-high-level-client


&＃xff08;2&＃xff09;修改 application.properties

# 指定Elasticsearch服务器的地址
spring.elasticsearch.rest.uris&＃61;http://127.0.0.1:9200
spring.elasticsearch.rest.read-timeout&＃61;10s
# 配置用户名和密码
spring.elasticsearch.rest.username&＃61;elastic
spring.elasticsearch.rest.password&＃61;123456

&＃xff08;3&＃xff09;Controller

package com.example.springboot.Controller;import org.elasticsearch.Assertions;
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.action.delete.DeleteRequest;
import org.elasticsearch.action.delete.DeleteResponse;
import org.elasticsearch.action.get.GetRequest;
import org.elasticsearch.action.get.GetResponse;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.action.index.IndexResponse;
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.support.master.AcknowledgedResponse;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.client.indices.CreateIndexRequest;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.SearchHits;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.io.IOException;&＃64;RestController
public class HelloController {&＃64;Autowiredprivate RestHighLevelClient restHighClient;&＃64;RequestMapping("CreateIndex")public boolean testCreateIndex() throws IOException {// 定义创建Index的设置&＃xff0c;和前面test.json文件的内容相同// 设置该Index的默认分词器是ik_max_wordvar json &＃61; "{\n" &＃43;" \"settings\": {\n" &＃43;" \"analysis\": {\n" &＃43;" \"analyzer\": {\n" &＃43;" \"default\": {\"tokenizer\": \"ik_max_word\"}\n" &＃43;" }\n" &＃43;" }\n" &＃43;" }\n" &＃43;"}\n";var indexRequest &＃61; new CreateIndexRequest("books").source(json, XContentType.JSON);AcknowledgedResponse resp &＃61; restHighClient.indices().create(indexRequest, RequestOptions.DEFAULT);return resp.isAcknowledged();}&＃64;RequestMapping("DeleteIndex")public boolean testDeleteIndex(String index) throws IOException {var indexRequest &＃61; new DeleteIndexRequest(index);AcknowledgedResponse resp &＃61; restHighClient.indices().delete(indexRequest, RequestOptions.DEFAULT);return resp.isAcknowledged();}&＃64;RequestMapping("SaveDocument")public void testSaveDocument(String index, Integer id, String name, String description, Double price) throws IOException {IndexRequest request &＃61; new IndexRequest(index).id(id &＃43; "").source("name", name, "description", description, "price", price);IndexResponse resp &＃61; restHighClient.index(request, RequestOptions.DEFAULT);System.out.println(resp);}&＃64;RequestMapping("GetDocument")public void testGetDocument(String index, Integer id) throws IOException {var request &＃61; new GetRequest(index).id(id &＃43; "");GetResponse resp &＃61; restHighClient.get(request, RequestOptions.DEFAULT);System.out.println(resp.getSource());}&＃64;RequestMapping("Search")public void testSearch(String index, String field, String term) throws IOException {var builder &＃61; new SearchSourceBuilder();if (term !&＃61; null && term.contains("*")) {builder.query(QueryBuilders.wildcardQuery(field, term));} else {builder.query(QueryBuilders.matchQuery(field, term));}var request &＃61; new SearchRequest(index).source(builder);SearchResponse resp &＃61; restHighClient.search(request, RequestOptions.DEFAULT);SearchHits hits &＃61; resp.getHits();hits.forEach(System.out::println);}&＃64;RequestMapping("DeleteDocument")public void testDeleteDocument(String index, Integer id) throws IOException {var request &＃61; new DeleteRequest(index).id(id &＃43; "");DeleteResponse resp &＃61; restHighClient.delete(request, RequestOptions.DEFAULT);System.out.println(resp.status());}
}


testSearch()方法测试全文检索功能&＃xff0c;该方法对传入的 term 关键 词进行判断&＃xff0c;如果该关键词包含星号( * )&＃xff0c;就使用通配符查询&＃xff08;Wildc ard Query&＃xff09;&＃xff0c;否则就使用普通查询。

2.2&＃xff0c;使用反应式RESTful客户端操作Elasticsearch

由于Elasticsearch官方并未提供反应式的RestClient&＃xff0c;因此Spring Data Elasticsearch额外补充了一个 ReactiveElasticsearchClient&＃xff0c;用于提供反应式 API 支持。ReactiveElasticsearchClient 相当于RestHighLevelClient的反应式版本&＃xff0c;因此它们二者的功能基本相似。只不过在调用ReactiveElasticsearchClient的方法时无须传入RequestOptions参数&＃xff0c;且其方法的返回值都是Flux或Mono &＃xff08;反应式API&＃xff09;&＃xff0c;因此下面程序使用了blockOptional()&＃xff0c;toIterable() 来保证反应式API能执行完成。

ReactiveElasticsearchClient 是基于 WebFlux 的 WebClient 的&＃xff0c;因此如果要使用反应式的RestClient&＃xff0c;还需要添加Spring WebFlux依赖。

org.springframework.bootspring-boot-starter-data-elasticsearch

org.springframework.bootspring-boot-starter-webflux


# 指定Elasticsearch服务器的地址
spring.data.elasticsearch.client.reactive.endpoints&＃61;127.0.0.1:9200
spring.data.elasticsearch.client.reactive.use-ssl&＃61;false
spring.elasticsearch.rest.read-timeout&＃61;10s
# 配置用户名和密码
spring.elasticsearch.rest.username&＃61;elastic
spring.elasticsearch.rest.password&＃61;123456

当容器中有了自动配置的ReactiveElasticsearchClient之后&＃xff0c;接下来即可将它依赖注入其他任何组件。

import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.action.delete.*;
import org.elasticsearch.action.get.GetRequest;
import org.elasticsearch.action.index.*;
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.admin.indices.create.CreateIndexRequest;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.index.get.GetResult;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.elasticsearch.client.reactive.ReactiveElasticsearchClient;
import org.springframework.web.bind.annotation.*;
import reactor.core.publisher.*;import java.io.IOException;
import java.util.function.Consumer;&＃64;RestController
public class HelloController {&＃64;Autowiredprivate ReactiveElasticsearchClient reactiveClient;&＃64;RequestMapping("CreateIndex")public boolean testCreateIndex() throws IOException {// 定义创建Index的设置&＃xff0c;和前面test.json文件的内容相同// 设置该Index的默认分词器是ik_max_wordvar json &＃61; "{\n" &＃43;" \"settings\": {\n" &＃43;" \"analysis\": {\n" &＃43;" \"analyzer\": {\n" &＃43;" \"default\": {\"tokenizer\": \"ik_max_word\"}\n" &＃43;" }\n" &＃43;" }\n" &＃43;" }\n" &＃43;"}\n";CreateIndexRequest indexRequest &＃61; new CreateIndexRequest("books").source(json, XContentType.JSON);Mono resp &＃61; reactiveClient.indices().createIndex(indexRequest);return resp.blockOptional().isPresent();}&＃64;RequestMapping("DeleteIndex")public boolean testDeleteIndex(String index) throws IOException {var indexRequest &＃61; new DeleteIndexRequest(index);Mono resp &＃61; reactiveClient.indices().deleteIndex(indexRequest);return resp.blockOptional().isPresent();}&＃64;RequestMapping("SaveDocument")public void testSaveDocument(String index, Integer id, String name, String description, Double price) throws IOException {IndexRequest request &＃61; new IndexRequest(index).id(id &＃43; "").source("name", name, "description", description, "price", price);Mono resp &＃61; reactiveClient.index(request);resp.blockOptional().ifPresent(System.out::println);}&＃64;RequestMapping("GetDocument")public void testGetDocument(String index, Integer id) throws IOException {var request &＃61; new GetRequest(index).id(id &＃43; "");Mono resp &＃61; reactiveClient.get(request);resp.blockOptional().ifPresent(e -> System.out.println(e.getSource()));}&＃64;RequestMapping("Search")public void testSearch(String index, String field, String term) throws IOException {var builder &＃61; new SearchSourceBuilder();if (term !&＃61; null && term.contains("*")) {builder.query(QueryBuilders.wildcardQuery(field, term));} else {builder.query(QueryBuilders.matchQuery(field, term));}var request &＃61; new SearchRequest(index).source(builder);Flux resp &＃61; reactiveClient.search(request);resp.toIterable().forEach(System.out::println);}&＃64;RequestMapping("DeleteDocument")public void testDeleteDocument(String index, Integer id) throws IOException {var request &＃61; new DeleteRequest(index).id(id &＃43; "");Mono resp &＃61; reactiveClient.delete(request);resp.blockOptional().ifPresent(e -> System.out.println(e.status()));}
}


3&＃xff0c;SpringBoot 整合 Elasticsearch

3.1&＃xff0c;Spring Data Elasticsearch

• 如果Spring Boot在类加载路径下检测到Spring Data Elasticsearch&＃xff0c;Spring Boot就会在容器中自动配置一个ElasticsearchRestTemplate&＃xff08;注意不是ElasticsearchTemplate&＃xff0c;ElasticsearchTemplate已经过时了&＃xff09;。ElasticsearchRestTemplate底层依赖于容器中自动配置的RestHighLevelClient。
• 如果Spring Boot在类加载路径下同时检测到Spring Data Elasticsearch和Spring WebFlux&＃xff0c;Spring Boot就会在容器中自动配置一个ReactiveElasticsearchTemplate。ReactiveElasticsearchTemplate底层依赖于容器中自动配置的 ReactiveElasticsearchClient。正如 ReactiveElasticsearchClient 是RestHighLevelClient的反应式版本&＃xff0c;ReactiveElasticsearchTemplate则是ElasticsearchRestTemplate的反应式版本。

与RestHighLevelClient、ReactiveElasticsearchClient 相比&＃xff0c;ElasticsearchRestTemplate、ReactiveElasticsearchTemplate 能以更加面向对象的方法来操作 Elasticsearch 索引库&＃xff0c;这些Xxx Template的方法操作的是实体对象&＃xff0c;而Spring Data Elasticsearch会自动将面向实体对象的操作转化为对索引库的操作。

3.2&＃xff0c;使用 Elasticsearch 的 Repository

由于Spring Data是高层次的抽象&＃xff0c;而Spring Data Elasticsearch只是属于底层的具体实现&＃xff0c;因此Spring Data Elasticsearch也提供了与前面Spring Data完全一致的操作。

Spring Data Elasticsearch大致包括如下几方面功能&＃xff1a;

• DAO接口只需继承CrudRepository或ReactiveCrudRepository&＃xff0c;Spring Data Elasticsearch能为DAO组件提供实现类。
• Spring Data Elasticsearch支持方法名关键字查询&＃xff0c;只不过Elasticsearch查询都是全文检索查询。
• Spring Data Elasticsearch同样支持DAO组件添加自定义的查询方法—通过添加额外的接口&＃xff0c;并为额外的接口提供实现类&＃xff0c;Spring Data Elasticsearch就能将该实现类中的方法“移植”到DAO组件中。

Spring Data Elasticsearch的 Repository 操作的数据类同样使用&＃64;Document和&＃64;Field注解修饰&＃xff0c;其中&＃64;Document修饰的实体类被映射到文档&＃xff0c; 使用该注解时可指定如下两个常用属性。

• indexName&＃xff1a;指定该实体类被映射到哪个Index。
• createIndex&＃xff1a;指定是否根据实体类创建Index。

&＃64;Field修饰的属性则被映射到索引文档的Field&＃xff0c;使用该注解时可指定如下常用属性。

• name&＃xff1a;指定该属性被映射到索引文档的哪个Field&＃xff0c;如果不指定该属性&＃xff0c;则默认基于同名映射。
• analyzer&＃xff1a;指定该Field所使用的分词器。
• searchAnalyzer&＃xff1a;指定对该Field执行搜索时所使用的分词器。

Maven

org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-starter-data-elasticsearchorg.springframework.bootspring-boot-starter-web


application.properties

# 指定Elasticsearch服务器的地址
spring.elasticsearch.rest.uris&＃61;https://127.0.0.1:9200
spring.elasticsearch.rest.read-timeout&＃61;10s
# 配置用户名和密码
spring.elasticsearch.rest.username&＃61;elastic
spring.elasticsearch.rest.password&＃61;123456

Pojo&＃xff1a;该 Book 类使用了&＃64;Document(index Name&＃61;"springboot"&＃xff0c;createIndex&＃61;true) 修饰&＃xff0c;这说明该类被映射到名为 “books” 的Index&＃xff0c;Spring Data Elasticsearch可根据该实体类自动创建 Index—如果该Index不存在的话。

package com.example.springboot.Pojo;import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;// createIndex指定自动创建索引
&＃64;Document(indexName &＃61; "books", createIndex &＃61; true)
public class Book {&＃64;Idprivate Integer id;&＃64;Field(analyzer &＃61; "ik_max_word", searchAnalyzer &＃61; "ik_smart")private String name;&＃64;Field(analyzer &＃61; "ik_max_word", searchAnalyzer &＃61; "ik_smart")private String description;&＃64;Field(analyzer &＃61; "ik_max_word", searchAnalyzer &＃61; "ik_smart")private Double price;//构造器、setter、getter
}


Dao

package com.example.springboot.Dao;import com.example.springboot.Pojo.Book;
import org.springframework.data.elasticsearch.annotations.Query;
import org.springframework.data.repository.CrudRepository;
import java.util.List;public interface BookDao extends CrudRepository, BookCustomDao {// 方法名关键字查询List findByName(String name);List findByIdIn(List list);List findByPriceBetween(double start, double end);List findByDescriptionMatches(String descPattern);// 使用&＃64;Query定义查询语句&＃64;Query("{ \"match\": { \"?0\": \"?1\" } } ")
// &＃64;Query("{ \"query_string\": { \"query\": \"?0:?1\" } } ")List findByQuery1(String field, String term);
}


package com.example.springboot.Dao;import com.example.springboot.Pojo.Book;
import java.util.List;public interface BookCustomDao {List customQuery1(String name, String description);
}


package com.example.springboot.Dao;import com.example.springboot.Pojo.Book;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
import org.springframework.data.elasticsearch.core.SearchHits;
import org.springframework.data.elasticsearch.core.query.Criteria;
import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
import org.springframework.data.elasticsearch.core.query.Query;
import java.util.ArrayList;
import java.util.List;public class BookCustomDaoImpl implements BookCustomDao {&＃64;Autowiredprivate ElasticsearchRestTemplate restTemplate;&＃64;Overridepublic List customQuery1(String name, String description) {// 以面向对象的方式定义查询语句Criteria criteria &＃61; new Criteria("name").is(name).and("description").is(description);// 创建CriteriaQueryQuery query &＃61; new CriteriaQuery(criteria);SearchHits hits &＃61; restTemplate.search(query, Book.class);List books &＃61; new ArrayList<>();hits.forEach(hit -> books.add(hit.getContent()));return books;}
}

Controller

package com.example.springboot.Controller;
import com.example.springboot.Dao.BookDao;
import com.example.springboot.Pojo.Book;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;&＃64;RestController
public class HelloController {&＃64;Autowiredprivate BookDao bookDao;&＃64;RequestMapping("/Save")public void testSave(Integer id, String name, String description, Double price) {var book &＃61; new Book(id, name, description, price);bookDao.save(book);}&＃64;RequestMapping("/Delete")public void testDelete() {// 删除id为3的Book对象bookDao.deleteById(3);}&＃64;RequestMapping("/FindByName")public void testFindByName(String name) {bookDao.findByName(name).forEach(System.out::println);}&＃64;RequestMapping("/FindByIdIn")public void testFindByIdIn(Integer id1, Integer id2) {bookDao.findByIdIn(List.of(id1, id2)).forEach(System.out::println);}&＃64;RequestMapping("/FindByPriceBetween")public void testFindByPriceBetween(double start, double end) {bookDao.findByPriceBetween(start, end).forEach(System.out::println);}&＃64;RequestMapping("/FindByDescriptionMatches")public void testFindByDescriptionMatches(String descPattern) {bookDao.findByDescriptionMatches(descPattern).forEach(System.out::println);}&＃64;RequestMapping("/FindByQuery1")public void testFindByQuery1(String field, String term) {bookDao.findByQuery1(field, term).forEach(System.out::println);}&＃64;RequestMapping("/CustomQuery1")public void testCustomQuery1(String name, String description) {bookDao.customQuery1(name, description).forEach(System.out::println);}
}