1. 介绍

官方文档地址：https://docs.spring.io/spring-data/elasticsearch/docs/4.1.12/reference/html/#elasticsearch.repositories

Spring Boot 使用 ElasticSearch 除了使用 es 官网建议的 RestHighLevelClient ，还可以使用 Spring Data ElasticSearch 提供的相关API。
Spring Data ElasticSearch 对 RestHighLevelClient 进行了封装，使我们使用起来更轻松。
Spring Data ElasticSearch 提供了 实现ElasticsearchRepository类和 ElasticsearchRestTemplate（es7开始） 两种用法，前者用于简单的CRUD操作，后者用于前者无法处理的复杂操作。

前提：

  • 必须根据官方文档对应的 Spring Boot 和 es 的版本进行一一对应
  • es7 和之前的改动很大，很多API都不再可用，注意变更。 | Spring Data Release Train | Spring Data Elasticsearch | Elasticsearch | Spring Boot | | —- | —- | —- | —- | | 2020.0.0[1] | 4.1.x[1] | 7.9.3 | 2.4.x[1] | | Neumann | 4.0.x | 7.6.2 | 2.3.x | | Moore | 3.2.x | 6.8.12 | 2.2.x | | Lovelace | 3.1.x | 6.2.2 | 2.1.x | | Kay[2] | 3.0.x[2] | 5.5.0 | 2.0.x[2] | | Ingalls[2] | 2.1.x[2] | 2.4.0 | 1.5.x[2] |

2. 前提配置

2.1 改pom

  1. <dependency>
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
  4. </dependency>

2.2 写 yml 或 自定义 @Bean

2.2.1 写 yml

org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration 路径下寻找相关配置，并在yml中进行配置

image.png
image.png

  1. spring:
  2.   elasticsearch:
  3.     rest:
  4.       uris: 
  5.         - localhost:9200
  6.         - localhost:9201
  7.       username: xxx   # 没有可不写
  8.       password: xxx   # 没有可不写
  9.       connection-timeout: 1s  # 默认值
  10.       read-timeout: 30s       # 默认值

2.2.2 自定义 @Bean

同样为上面的自动装配地址，查找到相应的默认配置，并改成自己的配置

  1. // 默认自动装配源码
  2. @Configuration(
  3.     proxyBeanMethods = false
  4. )
  5. @ConditionalOnMissingBean({RestHighLevelClient.class})
  6. static class RestHighLevelClientConfiguration {
  7.     RestHighLevelClientConfiguration() {
  8.     }
  10.     @Bean
  11.     RestHighLevelClient elasticsearchRestHighLevelClient(RestClientBuilder restClientBuilder) {
  12.         return new RestHighLevelClient(restClientBuilder);
  13.     }
  14. }
  1. // 自定义配置
  2. package com.edward.config;
  4. import org.apache.http.HttpHost;
  5. import org.elasticsearch.client.RestClient;
  6. import org.elasticsearch.client.RestHighLevelClient;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. @Configuration
  11. public class EsConfig {
  12.     @Bean
  13.     RestHighLevelClient restHighLevelClient() {
  14.         return new RestHighLevelClient(
  15.                 RestClient.builder(new HttpHost("localhost", 9200)));
  16.     }
  17. }

3. ElasticsearchRepository 用法

必须以上面第二步的配置为前提


3.1 Model

我们先写一个的实体类，借助这个实体类呢来完成基础的CRUD功能。

  1. @Data
  2. @Accessors(chain = true)
  3. @Document(indexName = "blog", type = "java")
  4. public class BlogModel implements Serializable {
  6.     private static final long serialVersionUID = 6320548148250372657L;
  8.     @Id
  9.     private String id;
  11.     private String title;
  13.     //@Field(type = FieldType.Date, format = DateFormat.basic_date)
  14.     @DateTimeFormat(pattern = "yyyy-MM-dd")
  15.     @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
  16.     private Date time;
  17. }

注意id字段是必须的，可以不写注解@Id。

3.2 BlogRepository

  1. public interface BlogRepository extends ElasticsearchRepository<BlogModel, String> {
  2. }

3.3 CRUD

dao层的方法除了默认了，也可以自己添加，自己添加时根据提示写出可识别的代码 或者 dao层的抽象方法上标注 @Query 注解并书写 es 查询语句

  1. @RestController
  2. @RequestMapping("/blog")
  3. public class BlogController {
  4.     @Autowired
  5.     private BlogRepository blogRepository;
  7.     // 新增
  8.     @PostMapping("/add")
  9.     public Result add(@RequestBody BlogModel blogModel) {
  10.         blogRepository.save(blogModel);
  11.         return Result.success();
  12.     }
  14.     // 根据ID修改（覆盖修改）
  15.     @PostMapping("/update")
  16.     public Result updateById(@RequestBody BlogModel blogModel) {
  17.         String id = blogModel.getId();
  18.         if (StringUtils.isEmpty(id))
  19.             return Result.error();
  20.         blogRepository.save(blogModel);
  21.         return Result.success();
  22.     }
  24.     // 根据ID查询
  25.     @GetMapping("/get/{id}")
  26.     public Result getById(@PathVariable String id) {
  27.         if (StringUtils.isEmpty(id))
  28.             return Result.error();
  29.         Optional<BlogModel> blogModelOptional = blogRepository.findById(id);
  30.         if (blogModelOptional.isPresent()) {
  31.             BlogModel blogModel = blogModelOptional.get();
  32.             return Result.success(blogModel);
  33.         }
  34.         return Result.error();
  35.     }
  37.     // 查询所有
  38.     @GetMapping("/get")
  39.     public Result getAll() {
  40.         Iterable<BlogModel> iterable = blogRepository.findAll();
  41.         List<BlogModel> list = new ArrayList<>();
  42.         iterable.forEach(list::add);
  43.         return Result.success(list);
  45.         /* 分页查询（pageNum，pageSize）
  46.             Page<User> users = userDao.findAll(PageRequest.of(0, 3));
  47.             users.map(x -> {
  48.                 System.out.println(x);
  49.                 return null;
  50.             });
  51.         */
  52.     }
  54.     // 根据ID删除
  55.     @DeleteMapping("/delete/{id}")
  56.     public Result deleteById(@PathVariable String id) {
  57.         if (StringUtils.isEmpty(id))
  58.             return Result.error();
  59.         blogRepository.deleteById(id);
  60.         /*  
  61.             删除所有数据
  62.             blogRepository.deleteAll();    
  63.         */
  64.         return Result.success();
  65.     }
  66. }

4. ElasticsearchRestTemplate 用法

同样必须以上述2前提配置为基础 这里API较多，只写一个查询作为示例

  1. // 写法1：
  2. public List<User> testRestTemplate() {
  3.     // 构建范围查找条件
  4.     RangeQueryBuilder rangeQueryBuilder = QueryBuilders.rangeQuery("age").gte(1).lte(4);
  5.     // 构建 QueryBuilder
  6.     NativeSearchQueryBuilder nativeSearchQueryBuilder = new NativeSearchQueryBuilder();
  7.     // 为 QueryBuilder 添加相应配置（范围查找条件、分页等）
  8.     nativeSearchQueryBuilder.withQuery(rangeQueryBuilder);
  9.     nativeSearchQueryBuilder.withPageable(PageRequest.of(0, 2));
  10.     // 搜索
  11.     List<User> users = elasticsearchRestTemplate.multiGet(nativeSearchQueryBuilder.build(), User.class);
  12.     return users;
  13. }
  15. // 写法2：
  16. public List<SearchHit<User>> testRestTemplate() {
  17.     RangeQueryBuilder rangeQueryBuilder = QueryBuilders.rangeQuery("age").gte(1).lte(4);
  19.     NativeSearchQueryBuilder nativeSearchQueryBuilder = new NativeSearchQueryBuilder();
  21.     nativeSearchQueryBuilder.withQuery(rangeQueryBuilder);
  22.     nativeSearchQueryBuilder.withPageable(PageRequest.of(0, 2));
  24.     SearchHits<User> searchHits = elasticsearchRestTemplate.search(nativeSearchQueryBuilder.build(), User.class);
  25.     return searchHits.getSearchHits();
  26. }

5. 总结

  • Spring Data ElasticSearch 比 RestHighLevelClient 要方便很多，不过要注意版本匹配和API的更新迭代。
  • 简单操作可用 ElasticsearchRepository 解决，复杂操作可用 ElasticsearchRestTemplate 。