SpringData集成Elasticsearch

绝地灬酷狼 2023-09-30 10:13 36阅读 0赞

Spring Data 是一个用于简化数据库、非关系型数据库、索引库访问，并支持云服务的 开源框架。其主要目标是使得对数据的访问变得方便快捷，并支持 map-reduce 框架和云计 算数据服务。 Spring Data 可以极大的简化 JPA（Elasticsearch„）的写法，可以在几乎不用 写实现的情况下，实现对数据的访问和操作。除了 CRUD 外，还包括如分页、排序等一些 常用的功能。

[Spring Data官网 ][Spring Data_]

**Spring Data Elasticsearch** **介绍**

Spring Data Elasticsearch 基于 spring data API 简化 Elasticsearch 操作，将原始操作 Elasticsearch 的客户端 API 进行封装 。Spring Data 为 Elasticsearch 项目提供集成搜索引擎。

Spring Data Elasticsearch POJO 的关键功能区域为中心的模型与 Elastichsearch 交互文档和轻松地编写一个存储索引库数据访问层。

[Spring Data Elasticsearch][]

**Spring Data Elasticsearch** **版本对比**

<table> 
 <thead> 
  <tr> 
   <th>SpringData Release Train</th> 
   <th>SpringData ES</th> 
   <th>ES</th> 
   <th>SpringBoot</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Neumann</td> 
   <td>4.0.x</td> 
   <td>7.6.2</td> 
   <td>2.3.x</td> 
  </tr> 
  <tr> 
   <td>Moore</td> 
   <td>3.2.x</td> 
   <td>6.8.6</td> 
   <td>2.2.x</td> 
  </tr> 
  <tr> 
   <td>Lovelace</td> 
   <td>3.1.x</td> 
   <td>6.2.2</td> 
   <td>2.1.x</td> 
  </tr> 
  <tr> 
   <td>Kay</td> 
   <td>3.0.x</td> 
   <td>5.5.0</td> 
   <td>2.0.x</td> 
  </tr> 
  <tr> 
   <td>Ingalls</td> 
   <td>2.1.x</td> 
   <td>2.4.0</td> 
   <td>1.5.x</td> 
  </tr> 
 </tbody> 
</table>

Spring boot2.3.x 一般可以兼容 Elasticsearch7.x

1.  创建Maven工程

pom

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.6.RELEASE</version>
            <relativePath/>
        </parent>
    
        <groupId>com.atguigu.es</groupId>
        <artifactId>es-data</artifactId>
        <version>1.0-SNAPSHOT</version>
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-test</artifactId>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
            </dependency>
        </dependencies>
    </project>

1.  配置文件

# es 服务地址
    elasticsearch.host=127.0.0.1
    # es 服务端口
    elasticsearch.port=9200
    # 配置日志级别,开启 debug 日志
    logging.level.com.atguigu.es=debug

1.  主程序

@SpringBootApplication
    public class EsApplication {
        
        public static void main(String[] args) {
        
            SpringApplication.run(EsApplication.class, args);
        }
    }

1.  实体类

package com.atguigu.entity;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import lombok.ToString;
    import org.springframework.data.annotation.Id;
    import org.springframework.data.elasticsearch.annotations.Document;
    import org.springframework.data.elasticsearch.annotations.Field;
    import org.springframework.data.elasticsearch.annotations.FieldType;
    
    /**
     * <br>
     * created date 2022/3/20 17:10
     *
     * @author yh
     */
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    @ToString
    @Document(indexName = "shopping", shards = 3, replicas = 1)
    public class Product {
        
        //必须有 id,这里的 id 是全局唯一的标识，等同于 es 中的"_id"
        @Id
        private Long id;//商品唯一标识
    
        /**
         * type : 字段数据类型
         * analyzer : 分词器类型
         * index : 是否索引(默认:true)
         * Keyword : 短语,不进行分词
         */
        @Field(type = FieldType.Text, analyzer = "ik_max_word")
        private String title;//商品名称
    
        @Field(type = FieldType.Keyword)
        private String category;//分类名称
    
        @Field(type = FieldType.Double)
        private Double price;//商品价格
    
        @Field(type = FieldType.Keyword, index = false)
        private String images;//图片地址
    }

1.  配置类

*  ElasticsearchRestTemplate是spring-data-elasticsearch项目中的一个类,和其他spring项目中的 template类似。
 *  在新版的spring-data-elasticsearch 中，ElasticsearchRestTemplate 代替了原来的ElasticsearchTemplate。
 *  原因是ElasticsearchTemplate基于TransportClient，TransportClient即将在8.x 以后的版本中移除。所以，我们推荐使用ElasticsearchRestTemplate。
 *  ElasticsearchRestTemplate基于RestHighLevelClient客户端的。需要自定义配置类，继承AbstractElasticsearchConfiguration，并实现elasticsearchClient()抽象方法，创建RestHighLevelClient对象。

自定义配置类，继承AbstractElasticsearchConfiguration，并实现elasticsearchClient()抽象方法，创建RestHighLevelClient对象

@ConfigurationProperties(prefix = "elasticsearch")
    @Configuration
    @Data
    public class ElasticsearchConfig extends AbstractElasticsearchConfiguration {
        
        private String host;
        private Integer port;
    
        //重写父类方法
        @Override
        public RestHighLevelClient elasticsearchClient() {
        
            RestClientBuilder builder = RestClient.builder(new HttpHost(host, port));
            RestHighLevelClient restHighLevelClient = new
                    RestHighLevelClient(builder);
            return restHighLevelClient;
        }
    }

1.  DAO 数据访问对象

import com.atguigu.entity.Product;
    import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
    import org.springframework.stereotype.Repository;
    
    /**
     * <br>
     * created date 2022/3/20 17:13
     *
     * @author yh
     */
    @Repository
    public interface ProductDao extends ElasticsearchRepository<Product, Long> {
        
    
    }

1.  框架集成-SpringData-集成测试-索引操作

import com.atguigu.entity.Product;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
    import org.springframework.test.context.junit4.SpringRunner;
    
    /**
     * <br>
     * created date 2022/3/20 17:13
     *
     * @author yh
     */
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringDataEsTest {
        
        //注入 ElasticsearchRestTemplate
        @Autowired
        private ElasticsearchRestTemplate elasticsearchRestTemplate;
        //创建索引并增加映射配置
        @Test
        public void createIndex(){
        
            //创建索引，系统初始化会自动创建索引
            System.out.println("创建索引");
        }
    
        @Test
        public void deleteIndex(){
        
            //创建索引，系统初始化会自动创建索引
            boolean flg = elasticsearchRestTemplate.deleteIndex(Product.class);
            System.out.println("删除索引 = " + flg);
        }
    }

postman测试结果 GET http://localhost:9200/\_cat/indices?v

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCn5LiK5pyJ5Yac_size_20_color_FFFFFF_t_70_g_se_x_16]  
8.文档操作

import com.atguigu.es.dao.ProductDao;
    import com.atguigu.es.model.Product;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.data.domain.Page;
    import org.springframework.data.domain.PageRequest;
    import org.springframework.data.domain.Sort;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.ArrayList;
    import java.util.List;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringDataESProductDaoTest {
        
    
        @Autowired
        private ProductDao productDao;
        /**
         * 新增
         */
        @Test
        public void save(){
        
            Product product = new Product();
            product.setId(2L);
            product.setTitle("华为手机");
            product.setCategory("手机");
            product.setPrice(2999.0);
            product.setImages("http://www.atguigu/hw.jpg");
            productDao.save(product);
        }
        //POSTMAN, GET http://localhost:9200/product/_doc/2
    
        //修改
        @Test
        public void update(){
        
            Product product = new Product();
            product.setId(2L);
            product.setTitle("小米 2 手机");
            product.setCategory("手机");
            product.setPrice(9999.0);
            product.setImages("http://www.atguigu/xm.jpg");
            productDao.save(product);
        }
        //POSTMAN, GET http://localhost:9200/product/_doc/2
    
    
        //根据 id 查询
        @Test
        public void findById(){
        
            Product product = productDao.findById(2L).get();
            System.out.println(product);
        }
    
        @Test
        public void findAll(){
        
            Iterable<Product> products = productDao.findAll();
            for (Product product : products) {
        
                System.out.println(product);
            }
        }
    
        //删除
        @Test
        public void delete(){
        
            Product product = new Product();
            product.setId(2L);
            productDao.delete(product);
        }
        //POSTMAN, GET http://localhost:9200/product/_doc/2
    
        //批量新增
        @Test
        public void saveAll(){
        
            List<Product> productList = new ArrayList<>();
            for (int i = 0; i < 10; i++) {
        
                Product product = new Product();
                product.setId(Long.valueOf(i));
                product.setTitle("["+i+"]小米手机");
                product.setCategory("手机");
                product.setPrice(1999.0 + i);
                product.setImages("http://www.atguigu/xm.jpg");
                productList.add(product);
            }
            productDao.saveAll(productList);
        }
    
        //分页查询
        @Test
        public void findByPageable(){
        
            //设置排序(排序方式，正序还是倒序，排序的 id)
            Sort sort = Sort.by(Sort.Direction.DESC,"id");
            int currentPage=0;//当前页，第一页从 0 开始， 1 表示第二页
            int pageSize = 5;//每页显示多少条
            //设置查询分页
            PageRequest pageRequest = PageRequest.of(currentPage, pageSize,sort);
            //分页查询
            Page<Product> productPage = productDao.findAll(pageRequest);
            for (Product Product : productPage.getContent()) {
        
                System.out.println(Product);
            }
        }
    }

1.  文档搜索

import com.atguigu.es.dao.ProductDao;
    import com.atguigu.es.model.Product;
    import org.elasticsearch.index.query.QueryBuilders;
    import org.elasticsearch.index.query.TermQueryBuilder;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.data.domain.PageRequest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringDataESSearchTest {
        
    
        @Autowired
        private ProductDao productDao;
        /**
         * term 查询
         * search(termQueryBuilder) 调用搜索方法，参数查询构建器对象
         */
        @Test
        public void termQuery(){
        
            TermQueryBuilder termQueryBuilder = QueryBuilders.termQuery("title", "小米");
                    Iterable<Product> products = productDao.search(termQueryBuilder);
            for (Product product : products) {
        
                System.out.println(product);
            }
        }
        /**
         * term 查询加分页
         */
        @Test
        public void termQueryByPage(){
        
            int currentPage= 0 ;
            int pageSize = 5;
            //设置查询分页
            PageRequest pageRequest = PageRequest.of(currentPage, pageSize);
            TermQueryBuilder termQueryBuilder = QueryBuilders.termQuery("title", "小米");
                    Iterable<Product> products =
                            productDao.search(termQueryBuilder,pageRequest);
            for (Product product : products) {
        
                System.out.println(product);
            }
        }
    }

笔记整理自:  
[https://www.bilibili.com/video/BV1hh411D7sb][https_www.bilibili.com_video_BV1hh411D7sb]  
[https://blog.csdn.net/u011863024/article/details/115721328][https_blog.csdn.net_u011863024_article_details_115721328]

[Spring Data_]: https://spring.io/projects/spring-data
[Spring Data Elasticsearch]: https://spring.io/projects/spring-data-elasticsearch
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCn5LiK5pyJ5Yac_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/e22832fc9c7441a69022395826041263.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCn5LiK5pyJ5Yac,size_20,color_FFFFFF,t_70,g_se,x_16
[https_www.bilibili.com_video_BV1hh411D7sb]: https://www.bilibili.com/video/BV1hh411D7sb
[https_blog.csdn.net_u011863024_article_details_115721328]: https://blog.csdn.net/u011863024/article/details/115721328