本篇文章为你整理了【主流技术】ElasticSearch 在 Spring 项目中的实践()的详细内容,包含有 【主流技术】ElasticSearch 在 Spring 项目中的实践,希望能帮助你了解 【主流技术】ElasticSearch 在 Spring 项目中的实践。
ElasticSearch简称es,是一个开源的高扩展的分布式全文检索引擎。
它可以近乎实时的存储、检索数据,其扩展性很好,ElasticSearch是企业级应用中较为常见的技术。
下面和大家分享 ElasticSearch 集成在Spring Boot 项目的一些学习心得。
ElasticSearch简称es,是一个开源的高扩展的分布式全文检索引擎。
它可以近乎实时的存储、检索数据,其扩展性很好,ElasticSearch是企业级应用中较为常见的技术。
下面和大家分享 ElasticSearch 集成在Spring Boot 项目的一些学习心得。
一、ElasticSearch概述
1.1基本认识
ElasticSearch 是基于 Lucene 实现的开源、分布式、RESTful接口的全文搜索引擎。
Elasticsearch 还是一个分布式文档数据库,其中每个字段均是被索引的数据且可被搜索,它能够扩展至数以百计的服务器存储以及处理PB级的数据。
Elasticsearch 可以通过简单的 RESTful 风格 API 来隐藏 Lucene 的复杂性,让搜索变得更加简单。
1.2核心概念
Elasticsearch 的核心概念是 Elasticsearch 搜索的过程,在搜索的过程中,Elasticsearch 的存储过程、数据结构都会有所涉及。
Elasticsearch (集群)中可以包含多个indices(对应库),每个索引中可以包含多个types(对应表),每个types下面又包含多个documents(对应行记录),每个documents中又含有多个fields(对应字段)。
Elasticsearch 中一切数据的格式都是 JSON。
indices
Elasticsearch 中的索引是一个非常大的文档集合,存储了映射类型的字段和其它设置,被存储在各个分片上。
1.3倒排索引
Elasticsearch 使用一种名为倒排索引的结构进行搜索,一个索引由文档中所有不重复的列表构成,对于每一个词,都有一个包含它的文档列表。
传统数据库的搜索结构一般以id为主,可以一一对应数据库中的所有内容,即key-value的形式。
而倒排索引则与之相反,以内容为主,将所有不重复的内容记录按照匹配的程度(阈值)进行展示,即value-key的形式。
以下举两个例子来进行说明。
在关系型数据库中,数据是按照id的顺序进行约定的,记录的id具有唯一性,方便人们使用id去确定内容,如表2所示:
在 ElasticSearch 中使用倒排索引:数据是按照不重复的内容进行约定的,不重复的内容具有唯一性,这样可以快速地找出符合内容的记录,再根据匹配的阈值去进行展示,如表3所示:
ELK 是 ElasticSearch、Logstash、Kibana这三大开源框架首字母大写简称。
其中 Logstash 是中央数据流引擎,用于从不同目标(文件/数据存储/MQ)中收集不同的数据格式,经过过滤后支持输送到不同的目的地(文件/MQ/Redis/elasticsearch/kafka等)。
而 Kibana 可以将 ElasticSearch 的数据通过友好的可视化界面展示出来,且提供实时分析的功能。
ELK一般来说是一个日志分析架构技术栈的总称,但实际上 ELK 不仅仅适用于日志分析,它还可以支持任何其它数据分析和收集的场景,日志的分析和收集只是更具有代表性,并非 ELK 的唯一用途。
二、ElasticSearch(插件)安装
2.1安装声明
适用于JDK1.8及以上版本
ElasticSearch客户端
ElasticSearch版本与Maven依赖版本对应
2.2 ElasticSearch下载
官网地址:https://www.elastic.co
下载地址(7.6.1版本):https://www.elastic.co/downloads/past-releases/elasticsearch-7-6-1,推荐迅雷下载(速度较快)。
2.3安装ElasticSearch
将下载好的压缩包进行安装即可,解压后如下图所示:
jvm.options:Java 虚拟机相关配置
elasticsearch.yml:elasticsearch配置文件,默认 9200 端口,解决跨域问题。
2.4启动ElasticSearch
打开bin文件夹下的elasticsearch.bat文件,双击启动后访问默认地址:localhost:9200,即可得到以下json格式的数据:
{
"name" : "ZHUZQC",
"cluster_name" : "elasticsearch",
"cluster_uuid" : "AMdLpCANStmY8kvou9-OtQ",
"version" : {
"number" : "7.6.1",
"build_flavor" : "default",
"build_type" : "zip",
"build_hash" : "aa751e09be0a5072e8570670309b1f12348f023b",
"build_date" : "2020-02-29T00:15:25.529771Z",
"build_snapshot" : false,
"lucene_version" : "8.4.0",
"minimum_wire_compatibility_version" : "6.8.0",
"minimum_index_compatibility_version" : "6.0.0-beta1"
"tagline" : "You Know, for Search"
2.5可视化界面-head安装
下载地址:https://github.com/mobz/elasticsearch-head/
安装要求:先检查计算机是否安装node.js、npm
步骤三:解决跨域问题,打开 elasticsearch.yml 文件,输入以下代码后保存:
http.cors.enabled: true
http.cors.allow-origin: "*"
注:head仅可以当作一个数据可视化的展示工具,对于查询语句推荐使用Kibana。
2.7安装Kibana工具
Kibana是一个针对 ElasticSearch 的开源分析、可视化平台,用于搜索、查看交互存储在ElasticSearch中的数据。
Kibana 操作简单,基于浏览器的的用户界面可以快速创建仪表板(dashboard)并实时显示数据。
官网下载:https://www.elastic.co/downloads/past-releases/kibana-7-6-1
注意事项:Kibana 版本需要和 ElasticSearch 的版本保持一致。
安装步骤如下:
步骤一:打开解压缩后的bin文件夹,双击.bat文件;
步骤二:打开 http://localhost:5601 进入 Kibana 界面
2.8使用Kibana工具
在开发的过程中,可供数据测试的工具有很多,比如postman、head、Chrome浏览器等,这里推荐使用 Kibana 进行数据测试。
操作界面如下图所示:
kibana界面
三、IK分词器
3.1基本介绍
在使用中文进行搜索时,我们会对要搜索的信息进行分词:将一段中文分成一个个的词语或者句子,然后将分出的词进行搜索。
默认的中文分词是一个汉字一个词,如:“你好世界”,会被分成:“你”,“好”,“世”,“界”。但这样的分词方式显然并不全面,比如还可以分成:“你好”,“世界”。
ik分词器就解决了默认分词不全面的问题,可以将中文进行不重复的分词。
ik分词器提供了两种2算法:ik_smart(最少切分)以及ik_max_word(最细颗粒度划分)。
github下载:https://github.com/medcl/elasticsearch-analysis-ik/releases/tag/v7.6.1
步骤一:将解压后的所有文件放置在 elasticsearch 下的plugins文件夹下;
步骤二:重启 elasticsearch
3.2使用Kibana测试
3.3修改本地字典
ik分词的默认字典并不能完全涵盖所有的中文分词,当我们想自定义分词时,就需要修改ik分词器的字典配置。
步骤一:打开elasticsearch-7.6.1\plugins\ik\config文件夹,增加自定义dic文件;
步骤二:在同一文件夹中的IKAnalyzer.cfg.xml里,将上述步骤的dic文件写入自己的扩展字典;
具体效果如下图3-3所示:
四、Rest风格操作
ElasticSearch 使用 Rest 风格来进行一系列操作,具体的命令如图4-1所示:
4.1创建索引
PUT /test_1/type/1
"name": "zhuzqc",
"age": 35364
4.2修改索引内容
GET /test_1
"mappings": {
"properties": {
"name": {
"type": "text"
"age": {
"type": "long"
"birthdy": {
"type": "date"
4.3更新索引内容
POST /test_1/_doc/1/_update
"doc": {
"name": "noone"
4.4删除索引
DELETE test_2
4.5关于documents的操作
4.5.1基本操作
documents 可以看作是数据库中的行记录;
首先先生产一些 documents 数据:
PUT zhuzqc/user/3
"name": "李四",
"age": 894,
"desc": "影流之主",
"tags": ["劫","刺客","中单"]
2.获取数据:
GET zhuzqc/user/1
3.更新数据
// POST请求对指定内容进行更新
POST zhuzqc/user/1/_update
"doc": {
"name": "342rfd",
"age": 243234
4.简单的条件查询
// 查询统一GET开头,_search后接?,q代表query,属性:内容
GET zhuzqc/user/_search?q=name:李
如:查询zhuzqc索引中name为李四的信息,其中李四遵循默认的分词规则
GET zhuzqc/user/_search?q=name:李四
4.5.2复杂操作
上述的一些简单查询操作在企业级应用开发中使用地较少,更多地还是使用查询实现复杂的业务。
随着业务的复杂程度增加,查询的语句也随之复杂起来,在使用复杂查询的过程中必然会涉及一些 elasticsearch 的进阶语法。
对于复杂查询的操作在下一章会详细介绍。
五、查询详解
ElasticSearch引擎首先分析需要查询的字符串,根据分词器规则对其进行分词。分词之后,才会根据查询条件进行结果返回。
5.1关键字介绍
query 关键字:将需要查询的 JSON 参数体进行包裹,声明这是一条查询语句。
bool 关键字:表明返回结果类型为布尔类型。
keyword 关键字:keyword代表一种分词类型,表明该字段的值不会被分词器分词。
must 关键字:在 must 中的内容表明都是必须执行的内容,在 must 中可以创建多条语句,多条语句需同时满足条件才能执行,作用相当于 SQL 语句中的 AND 。
should 关键字:在 should 关键字里的内容只要满足其中一项就可以执行,作用相当于 SQL 语句中的 OR 。
must_not 关键字:类似于 Java 中的 != 作用,展示查询内容之外的内容。
match 关键字:match 的作用是匹配查询,首先经过分词器的分词,后再执行 match 查询,默认情况下:字段内容必须完整地匹配到任意一个词条(分词后),才会有返回结果。
注:如果需要查询的词有多个,可以用空格隔开。
match_all 关键字:待补充。
match_phrase 关键字:待补充。
term 关键字:精确查询关键字,使用 term 时首先不会对需要查询的词条进行分词,只有精确地匹配到一模一样的内容才会返回结果。
terms 关键字:待补充。
filter 关键字:对查询的内容进行筛选过滤,常使用 gt(大于)、gte(大于等于)、lt(小于)和 lte (小于等于)来进行筛选。
GET product_cloud/_search
"query": {
"bool": {
"must": [
"bool": {
"should": [
{"match": {"product_comment":"持续交付 工程师"}}
"bool": {
"should": [
{"terms": {"label_ids": [3]}}
"filter": {
"range": {
"label_ids": {
"gte": 0
score 关键字:字段内容与词条的匹配程度,分数越高,表明匹配度越高,就越符合查询结果。
hits 关键字:对应 Java 代码中的 hit 对象,包含了索引和文档信息,包括查询结果总数,查询出来的_doc内容(一串 JSON),分数(score)等。
source:需要展示的内容字段,默认是展示索引的所有字段,也可以自定义指定需要展示的字段。
"_source": ["product_comment","product_name","label_ids","product_solution","company_name"],
"sort": [
"label_ids": {
"order": "desc"
"from": 0,
"size": 3
5.2 highlight 高亮
使用 highlight 关键字可以在搜索结果中对需要高亮的字段进行高亮(可自定义样式)展示,具体代码如下:
GET product_cloud/_search
"query": {
"term": {
"product_comment": "世界"
"highlight": {
"pre_tags": " p ",
"post_tags": " /p ",
"fields": {
"product_comment": {}
六、Spring Boot集成ElasticSearch
在 Elasticsearch 的官方文档中有对 Elasticsearch 客户端使用的详细介绍: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/8.0/installation.html
6.1添加依赖
properties
java.version 11 /java.version
!-- 自定义 ElasticSearch 依赖版本与安装的版本一致 --
elasticsearch.verson 7.6.1 /elasticsearch.verson
/properties
dependency
groupId org.springframework.boot /groupId
artifactId spring-boot-starter-data-elasticsearch /artifactId
/dependency
6.2创建对象
定义一个客户端对象:
@Configuration
public class EsConfig {
@Bean
public RestHighLevelClient restHighLevelClient(){
RestHighLevelClient restHighLevelClient = new RestHighLevelClient(
RestClient.builder(
new HttpHost("127.0.0.1",9200,"http")
return restHighLevelClient;
6.3分析类中的方法(索引相关API)
CreateIndexRequest request = new CreateIndexRequest("zhu_index");
//2、执行创建请求,并获得响应
CreateIndexResponse createIndexResponse =
restHighLevelClient.indices().create(request, RequestOptions.DEFAULT);
System.out.println(createIndexResponse);
void testExistIndex() throws IOException {
GetIndexRequest getIndexRequest = new GetIndexRequest("zhu_index");
boolean exists = restHighLevelClient.indices().exists(getIndexRequest, RequestOptions.DEFAULT);
System.out.println(exists);
void testDeleteIndex() throws IOException {
DeleteIndexRequest deleteIndexRequest = new DeleteIndexRequest();
AcknowledgedResponse delete = restHighLevelClient.indices().delete(deleteIndexRequest, RequestOptions.DEFAULT);
System.out.println(delete);
七、相关API操作
API 的操作主要是将Spring Boot项目与 Elasticsearch 的 indices 与 docs 相关联起来,这样可以做到在 Elasticsearch 中对项目数据进行一系列的操作。
7.1文档API
IndexRequest zhu_index_request = new IndexRequest("zhu_index");
// 规则:put /zhu_index/_doc/1
zhu_index_request.id("1");
zhu_index_request.timeout(TimeValue.timeValueSeconds(1));
// 将数据放入 ElasticSearch 请求(JSON格式)
zhu_index_request.source(JSON.toJSONString(user), XContentType.JSON);
// 客户端发送请求
IndexResponse indexResponse = restHighLevelClient.index(zhu_index_request,
RequestOptions.DEFAULT);
// 添加大批量的数据
@Test
void testBulkRequest() throws IOException {
BulkRequest bulkRequest = new BulkRequest();
bulkRequest.timeout("10s");
//创建数据集合
ArrayList User userList = new ArrayList ();
userList.add(new User("zzz2",22));
userList.add(new User("zzz3",23));
userList.add(new User("zzz4",24));
userList.add(new User("zzz5",25));
userList.add(new User("zzz6",26));
//遍历数据:批量处理
for (int i = 0; i userList.size(); i++) {
// 批量添加(或更新、或删除)
bulkRequest.add(
new IndexRequest("zhu_index")
//.id(""+(i+1))
.source(JSON.toJSONString(userList.get(i)), XContentType.JSON));
BulkResponse bulkResponse = restHighLevelClient.bulk(bulkRequest, RequestOptions.DEFAULT);
void testGetDocument() throws IOException {
GetRequest getRequest = new GetRequest("zhu_index","1");
GetResponse getResponse = restHighLevelClient.get(getRequest, RequestOptions.DEFAULT);
// 返回_source的上下文
getRequest.fetchSourceContext(new FetchSourceContext(true));
void testUpdateDocument() throws IOException {
UpdateRequest updateRequest = new UpdateRequest("zhu_index","1");
updateRequest.timeout("1s");
User user = new User("ZhuZhuQC",18);
updateRequest.doc(JSON.toJSONString(user), XContentType.JSON);
UpdateResponse updateResponse = restHighLevelClient.update(updateRequest,
RequestOptions.DEFAULT);
SearchRequest searchRequest = new SearchRequest(EsConst.ES_INDEX);
// 构建搜索条件(精确查询、全匹配查询)
TermQueryBuilder termQuery = QueryBuilders.termQuery("name","zzz2");
MatchAllQueryBuilder matchAllQuery = QueryBuilders.matchAllQuery();
// 执行构造器
SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
sourceBuilder.query(termQuery);
sourceBuilder.query(matchAllQuery);
// 设置查询时间,3秒内
sourceBuilder.timeout(new TimeValue(3, TimeUnit.SECONDS));
// 设置分页
sourceBuilder.from(0);
sourceBuilder.size(3);
// 最后执行搜索,并返回搜索结果
searchRequest.source(sourceBuilder);
SearchResponse searchResponse = restHighLevelClient.search(searchRequest,
RequestOptions.DEFAULT);
searchResponse.getHits();
// 打印结果
System.out.println(JSON.toJSONString(searchResponse.getHits()));
for (SearchHit documentFields : searchResponse.getHits().getHits()) {
System.out.println(documentFields.getSourceAsMap());
八、实战分析
实战部分会模拟一个真实的 ElasticSearch 搜索过程:从创建项目开始,到使用爬虫爬取数据、编写业务,再到前后端分离交互,最后搜索结果高亮展示。
8.1创建项目
创建项目的步骤可如以下几步:
!-- 自定义 ElasticSearch 依赖版本与安装的版本一致 --
elasticsearch.version 7.6.1 /elasticsearch.version
/properties
dependency
groupId com.alibaba /groupId
artifactId fastjson /artifactId
version 1.2.83 /version
/dependency
spring.datasource.password=password123
spring.datasource.url=jdbc:mysql://localhost:3306/elasticsearch-test?useSSL=false useUnicode=true characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#mybatis-plus日志配置
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
#mybatis-plus逻辑删除配置,删除为1,未删除为0
mybatis-plus.global-config.db-config.logic-delete-value = 1
mybatis-plus.global-config.db-config.logic-not-delete-value = 0
这个步骤可以在网盘
地址:https://pan.baidu.com/s/1yk_yekYoGXCuO0dc5B-Ftg
密码: rwpq
获取对应的 zip 包,里面包括了一些前端的静态资源和样式,直接放入 resources 文件夹中即可。
8.2爬取数据
在真实的项目中,数据可以从数据库获得,也可以从MQ(消息队列)中获得,也可以通过爬取数据(爬虫)获得,在这里介绍一下使用爬虫获取项目所需数据的过程。
1.首先导入网页解析依赖:
!--网页解析依赖--
dependency
groupId org.jsoup /groupId
artifactId jsoup /artifactId
version 1.11.2 /version
/dependency
2.编写网页解析工具类(返回爬取到的数据):
@Component
public class HtmlParseUtil {
public static List Content parseJD(String keyword) throws IOException {
// 1、获取请求:https://search.jd.com/Search?keyword=java
String reqUrl = "https://search.jd.com/Search?keyword=" + keyword;
// 2、解析网页,返回的document对象就是页面的 js 对象
Document document = Jsoup.parse(new URL(reqUrl), 30000);
// 3、js 中使用的方法获取页面信息
Element j_goodList = document.getElementById("J_goodsList");
// 4、获取所有的 li 元素
Elements liElements = j_goodList.getElementsByTag("li");
//5、返回List封装对象
ArrayList Content goodsList = new ArrayList ();
//5、获取元素中的内容,遍历的 li 对象就是每一个 li 标签
for (Element el : liElements) {
String price = el.getElementsByClass("p-price").eq(0).text();
String title = el.getElementsByClass("p-name").eq(0).text();
String img = el.getElementsByTag("img").eq(0).attr("data-lazy-img");
// 将爬取的信息放入 List 对象中
Content content = new Content();
content.setTitle(title);
content.setImg(img);
content.setPrice(price);
goodsList.add(content);
return goodsList;
8.3编写业务
要编写的业务只有两部分:1、将上述获取的数据放入 ElasticSearch 的索引中;2、实现 ElasticSearch 的搜索功能;
1.controller层:
@Autowired
private ContentService contentService;
@GetMapping("/parse/{keyword}")
public Boolean parse(@PathVariable("keyword") String keyword) throws IOException {
return contentService.parseContent(keyword);
2.service层:
@Autowired
private RestHighLevelClient restHighLevelClient;
* 1、将解析后的数据放入 ElasticSearch 的索引中
* */
public Boolean parseContent(String keyword) throws IOException {
List Content contents = new HtmlParseUtil().parseJD(keyword);
//批量插入 es
BulkRequest bulkRequest = new BulkRequest();
bulkRequest.timeout("2m");
for (int i = 0; i contents.size(); i++) {
bulkRequest.add(
new IndexRequest("jd_goods")
.source(JSON.toJSONString(contents.get(i)), XContentType.JSON)
BulkResponse bulk = restHighLevelClient.bulk(bulkRequest, RequestOptions.DEFAULT);
return bulk.hasFailures();
1.controller层:
@GetMapping("/search/{keyword}/{pageNo}/{pageSize}")
public List Map String, Object search(@PathVariable("keyword") String keyword,
@PathVariable("pageNo") Integer pageNo,
@PathVariable("pageSize") Integer pageSize) throws IOException {
return contentService.searchPage(keyword, pageNo, pageSize);
2.service层:
/**
* 2、获取数据后实现搜索功能
* */
public List Map String,Object searchPage(String keyword, Integer pageNo, Integer pageSize) throws IOException {
if (pageNo = 1){
pageNo = 1;
//条件搜索
SearchRequest searchRequest = new SearchRequest("jd_goods");
SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
//精准匹配
TermQueryBuilder titleTermQuery = QueryBuilders.termQuery("title", keyword);
sourceBuilder.query(titleTermQuery);
sourceBuilder.timeout(new TimeValue(3, TimeUnit.SECONDS));
//分页
sourceBuilder.from(pageNo);
sourceBuilder.size(10);
//执行搜索
searchRequest.source(sourceBuilder);
SearchResponse searchResponse = restHighLevelClient.search(searchRequest,RequestOptions.DEFAULT);
//解析结果
ArrayList Map String, Object list = new ArrayList ();
for (SearchHit documentFields : searchResponse.getHits().getHits()) {
list.add(documentFields.getSourceAsMap());
return list;
8.4前后端交互
前后端交互主要是通过接口查询数据并返回:前端有请求参数(关键字、分页参数)后,后端通过关键字去 elasticsearch 索引中进行筛选,最终将结果返回给前端现实的一个过程。
在这里主要分析一下前端是怎么获得后端接口参数的,后端的接口在上述业务编写中已经包含了。
script th:src="@{/js/axios.min.js}" /script
script th:src="@{/js/vue.min.js}" /script
//对接后端接口:关键字、分页参数
axios.get(search/ + keyword + /1/20).then(response= {
console.log(response);
//绑定数据
this.results = response.data;
/script
8.4搜索高亮
关键字高亮总结来说,就是将原来搜索内容中的关键字置换为加了样式的关键字,进而展示出高亮效果。
主要逻辑在于,获取到 Hits 对象后,遍历关键字字段,将高亮的关键字重新放入 Hits 集合中。
具体代码如下:
//解析结果
ArrayList Map String, Object list = new ArrayList ();
for (SearchHit documentFields : searchResponse.getHits().getHits()) {
//解析高亮字段,遍历整个 Hits 对象
Map String, HighlightField highlightFields = documentFields.getHighlightFields();
//获取到关键字的字段
HighlightField title = highlightFields.get("title");
Map String, Object sourceAsMap = documentFields.getSourceAsMap();
//置换为高亮字段:将原来的字段替换为高亮的字段
if(title != null){
Text[] fragments = title.fragments();
//定义新的高亮字段
String new_title = "";
for (Text text : fragments) {
new_title += text;
//将高亮的字段放入 Map 集合
sourceAsMap.put("title",new_title);
list.add(sourceAsMap);
ElasticSearch 作为一个分布式全文检索引擎,也可以应用在集群当中(K8S、Docker)。
ElasticSearch 实现全文检索的过程并不复杂,只要在业务需要的地方创建 ElasticSearch 索引,将数据放入索引中,就可以使用 ElasticSearch 集成在各个语言中的搜索对象进行查询操作了。
而在集成了 ElasticSearch 的 Spring Boot 项目中,无论是创建索引、精准匹配、还是字段高亮等,都是使用 ElasticSearch 对象在操作,本质上还是一个面向对象的过程。
和 Java 中的其它“对象”一样,只要灵活运用这些“对象”的使用规则和特性,就可以满足业务上的需求,对这个过程的把控也是工程师能力 的一种体现。
在 Spring Boot 项目中集成 ElasticSearch 就和大家分享到这里,如有不足,还望大家不吝赐教!
以上就是【主流技术】ElasticSearch 在 Spring 项目中的实践()的详细内容,想要了解更多 【主流技术】ElasticSearch 在 Spring 项目中的实践的内容,请持续关注盛行IT软件开发工作室。
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。