SpringBoot3集成ElasticSearch

目录

• 一、简介
  
• 二、环境搭建
  
  
  
  • 1、下载安装包
    
  • 2、服务启动
    
  
  
• 三、工程搭建
  
  
  
  • 1、工程结构
    
  • 2、依赖管理
    
  • 3、配置文件
    
  
  
• 四、基础用法
  
  
  
  • 1、实体类
    
  • 2、初始化索引
    
  • 3、仓储接口
    
  • 4、查询语法
    
  
  
• 五、参考源码
  

标签：ElasticSearch8.Kibana8；

一、简介

Elasticsearch是一个分布式、RESTful风格的搜索和数据分析引擎，适用于各种数据类型，数字、文本、地理位置、结构化数据、非结构化数据；
在实际的工作中，历经过Elasticsearch从6.0到7.0的版本升级，而这次SpringBoot3和ES8.0的集成，虽然脚本的语法变化很小，但是Java客户端的API语法变化很大；
二、环境搭建

1、下载安装包

需要注意的是，这些安装包的版本要选择对应的，不然容易出问题；

1. 软件包：elasticsearch-8.8.2-darwin-x86_64.tar.gz
2. 分词器工具：elasticsearch-analysis-ik-8.8.2.zip
3. 可视化工具：kibana-8.8.2-darwin-x86_64.tar.gz

复制代码

2、服务启动

不论是ES还是Kibana，在首次启动后，会初始化很多配置文件，可以根据自己的需要做相关的配置调整，比如常见的端口调整，资源占用，安全校验等；

1. 1、启动ES
2. elasticsearch-8.8.2/bin/elasticsearch
4. 本地访问：localhost:9200
6. 2、启动Kibana
7. kibana-8.8.2/bin/kibana
9. 本地访问：http://localhost:5601
11. # 3、查看安装的插件
12. http://localhost:9200/_cat/plugins  ->  analysis-ik 8.8.2

复制代码

三、工程搭建

1、工程结构


2、依赖管理

在starter-elasticsearch组件中，实际上依赖的是elasticsearch-java组件的8.7.1版本；

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
4.     <version>${spring-boot.version}</version>
5. </dependency>

复制代码

3、配置文件

在上面环境搭建的过程中，已经禁用了用户和密码的登录验证，配置ES服务地址即可；

1. spring:
2.   # ElasticSearch配置
3.   elasticsearch:
4.     uris: localhost:9200

复制代码

四、基础用法

1、实体类

通过Document和Field注解描述ES索引结构的实体类，注意这里JsonIgnoreProperties注解，解决索引中字段和实体类非一一对应的而引起的JSON解析问题；

1. @JsonIgnoreProperties(ignoreUnknown = true)
2. @Document(indexName = "contents_index", createIndex = false)
3. public class ContentsIndex implements Serializable {
5.     private static final long serialVersionUID=1L;
7.     @Field(type= FieldType.Integer)
8.     private Integer id;
10.     @Field(type= FieldType.Keyword)
11.     private String title;
13.     @Field(type= FieldType.Keyword)
14.     private String intro;
16.     @Field(type= FieldType.Text)
17.     private String content;
19.     @Field(type= FieldType.Integer)
20.     private Integer createId;
22.     @Field(type= FieldType.Keyword)
23.     private String createName;
25.     @Field(type= FieldType.Date,format = DateFormat.date_hour_minute_second)
26.     private Date createTime;
27. }

复制代码

2、初始化索引

基于ElasticsearchTemplate类和上述实体类，实现索引结构的初始化，并且将tb_contents表中的数据同步到索引中，最后通过ID查询一条测试数据；

1. @Service
2. public class ContentsIndexService {
3.     private static final Logger log = LoggerFactory.getLogger(ContentsIndexService.class);
5.     @Resource
6.     private ContentsService contentsService ;
7.     @Resource
8.     private ElasticsearchTemplate template ;
10.     /**
11.      * 初始化索引结构和数据
12.      */
13.     public void initIndex (){
14.         // 处理索引结构
15.         IndexOperations indexOps = template.indexOps(ContentsIndex.class);
16.         if (indexOps.exists()){
17.             boolean delFlag = indexOps.delete();
18.             log.info("contents_index exists，delete:{}",delFlag);
19.             indexOps.createMapping(ContentsIndex.class);
20.         } else {
21.             log.info("contents_index not exists");
22.             indexOps.createMapping(ContentsIndex.class);
23.         }
24.         // 同步数据库表记录
25.         List<Contents> contentsList = contentsService.queryAll();
26.         if (contentsList.size() > 0){
27.             List<ContentsIndex> contentsIndexList = new ArrayList<>() ;
28.             contentsList.forEach(contents -> {
29.                 ContentsIndex contentsIndex = new ContentsIndex() ;
30.                 BeanUtils.copyProperties(contents,contentsIndex);
31.                 contentsIndexList.add(contentsIndex);
32.             });
33.             template.save(contentsIndexList);
34.         }
35.         // ID查询
36.         ContentsIndex contentsIndex = template.get("10",ContentsIndex.class);
37.         log.info("contents-index-10:{}",contentsIndex);
38.     }
39. }

复制代码

3、仓储接口

继承ElasticsearchRepository接口，可以对ES这种特定类型的存储库进行通用增删改查操作；在测试类中对该接口的方法进行测试；

1. // 1、接口定义
2. public interface ContentsIndexRepository extends ElasticsearchRepository<ContentsIndex,Long> {
3. }
5. // 2、接口测试
6. public class ContentsIndexRepositoryTest {
7.     @Autowired
8.     private ContentsIndexRepository contentsIndexRepository;
10.     @Test
11.     public void testAdd (){
12.         // 单个新增
13.         contentsIndexRepository.save(buildOne());
14.         // 批量新增
15.         contentsIndexRepository.saveAll(buildList()) ;
16.     }
18.     @Test
19.     public void testUpdate (){
20.         // 根据ID查询后再更新
21.         Optional<ContentsIndex> contentsOpt = contentsIndexRepository.findById(14L);
22.         if (contentsOpt.isPresent()){
23.             ContentsIndex contentsId = contentsOpt.get();
24.             System.out.println("id=14:"+contentsId);
25.             contentsId.setContent("update-content");
26.             contentsId.setCreateTime(new Date());
27.             contentsIndexRepository.save(contentsId);
28.         }
29.     }
31.     @Test
32.     public void testQuery (){
33.         // 单个ID查询
34.         Optional<ContentsIndex> contentsOpt = contentsIndexRepository.findById(1L);
35.         if (contentsOpt.isPresent()){
36.             ContentsIndex contentsId1 = contentsOpt.get();
37.             System.out.println("id=1:"+contentsId1);
38.         }
39.         // 批量ID查询
40.         Iterator<ContentsIndex> contentsIterator = contentsIndexRepository
41.                                         .findAllById(Arrays.asList(10L,12L)).iterator();
42.         while (contentsIterator.hasNext()){
43.             ContentsIndex contentsIndex = contentsIterator.next();
44.             System.out.println("id="+contentsIndex.getId()+":"+contentsIndex);
45.         }
46.     }
48.     @Test
49.     public void testDelete (){
50.         contentsIndexRepository.deleteById(15L);
51.         contentsIndexRepository.deleteById(16L);
52.     }
53. }

复制代码

4、查询语法

无论是ElasticsearchTemplate类还是ElasticsearchRepository接口，都是对ES常用的简单功能进行封装，在实际使用时，复杂的查询语法还是依赖ElasticsearchClient和原生的API封装；
这里主要演示七个查询方法，主要涉及：ID查询，字段匹配，组合与范围查询，分页与排序，分组统计，最大值查询和模糊匹配；更多的查询API还是要多看文档中的案例才行；

1. public class ElasticsearchClientTest {
3.     @Autowired
4.     private ElasticsearchClient client ;
6.     @Test
7.     public void testSearch1 () throws IOException {
8.         // ID查询
9.         GetResponse<ContentsIndex> resp = client.get(
10.                 getReq ->getReq.index("contents_index").id("7"), ContentsIndex.class);
11.         if (resp.found()){
12.             ContentsIndex contentsIndex = resp.source() ;
13.             System.out.println("contentsIndex-7："+contentsIndex);
14.         }
15.     }
17.     @Test
18.     public void testSearch2 () throws IOException {
19.         // 指定字段匹配
20.         SearchResponse<ContentsIndex> resp = client.search(searchReq -> searchReq.index("contents_index")
21.                         .query(query -> query.match(field -> field
22.                         .field("createName").query("张三"))),ContentsIndex.class);
23.         printResp(resp);
24.     }
26.     @Test
27.     public void testSearch3 () throws IOException {
28.         // 组合查询：姓名和时间范围
29.         Query byName = MatchQuery.of(field -> field.field("createName").query("王五"))._toQuery();
30.         Query byTime = RangeQuery.of(field -> field.field("createTime")
31.                         .gte(JsonData.of("2023-07-10T00:00:00"))
32.                         .lte(JsonData.of("2023-07-12T00:00:00")))._toQuery();
33.         SearchResponse<ContentsIndex> resp = client.search(searchReq -> searchReq.index("contents_index")
34.                         .query(query -> query.bool(boolQuery -> boolQuery.must(byName).must(byTime))),ContentsIndex.class);
35.         printResp(resp);
36.     }
38.     @Test
39.     public void testSearch4 () throws IOException {
40.         // 排序和分页，在14条数据中，根据ID倒序排列，从第5条往后取4条数据
41.         SearchResponse<ContentsIndex> resp = client.search(searchReq -> searchReq.index("contents_index")
42.                 .from(5).size(4)
43.                 .sort(sort -> sort.field(sortField -> sortField.field("id").order(SortOrder.Desc))),ContentsIndex.class);
44.         printResp(resp);
45.     }
47.     @Test
48.     public void testSearch5 () throws IOException {
49.         // 根据createId分组统计
50.         SearchResponse<ContentsIndex> resp = client.search(searchReq -> searchReq.index("contents_index")
51.                 .aggregations("createIdGroup",agg -> agg.terms(term -> term.field("createId"))),ContentsIndex.class);
52.         Aggregate aggregate = resp.aggregations().get("createIdGroup");
53.         LongTermsAggregate termsAggregate = aggregate.lterms();
54.         Buckets<LongTermsBucket> buckets = termsAggregate.buckets();
55.         for (LongTermsBucket termsBucket : buckets.array()) {
56.             System.out.println(termsBucket.key() + " : " + termsBucket.docCount());
57.         }
58.     }
60.     @Test
61.     public void testSearch6 () throws IOException {
62.         // 查询最大的ID
63.         SearchResponse<ContentsIndex> resp = client.search(searchReq -> searchReq.index("contents_index")
64.                 .aggregations("maxId",agg -> agg.max(field -> field.field("id"))),ContentsIndex.class);
65.         for (Map.Entry<String, Aggregate> entry : resp.aggregations().entrySet()){
66.             System.out.println(entry.getKey()+":"+entry.getValue().max().value());
67.         }
68.     }
70.     @Test
71.     public void testSearch7 () throws IOException {
72.         // 模糊查询title字段，允许1个误差
73.         Query byContent = FuzzyQuery.of(field -> field.field("title").value("设计").fuzziness("1"))._toQuery();
74.         SearchResponse<ContentsIndex> resp = client.search(
75.                 searchReq -> searchReq.index("contents_index").query(byContent),ContentsIndex.class);
76.         printResp(resp);
77.     }
79.     private void printResp (SearchResponse<ContentsIndex> resp){
80.         TotalHits total = resp.hits().total();
81.         System.out.println("total："+total);
82.         List<Hit<ContentsIndex>> hits = resp.hits().hits();
83.         for (Hit<ContentsIndex> hit: hits) {
84.             ContentsIndex contentsIndex = hit.source();
85.             System.out.println(hit.id()+"："+contentsIndex);
86.         }
87.     }
88. }

复制代码

五、参考源码

1. 文档仓库：
2. https://gitee.com/cicadasmile/butte-java-note
4. 源码仓库：
5. https://gitee.com/cicadasmile/butte-spring-parent

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！