• ElasticsearchRestTemplate 和ElasticsearchRepository 的使用

    目录

    一、使用ElasticsearchRestTemplate类

     1.引用Maven类库

    2. 配置文件application.yml

    3.创建实体类（用于JSON文档对象的转换）

    二、使用ElasticsearchRepository 类

    1.引用Maven类库

    2. 配置文件application.yml

    3. ElasticsearchRepository接口的源码 

    4.CrudRepository  源码

    5. 查询查找策略

    5.1存储库方法可以定义为具有以下返回类型，用于返回多个元素：

    5.2 使用@Query注解

    6.开发实例：

    操作ElasticSearch的数据，有两种方式一种是 ElasticsearchRepository 接口，另一种是ElasticsearchTemplate接口。SpringData对ES的封装ElasticsearchRestTemplate类，可直接使用，此类在ElasticsearchRestTemplate基础上进行性一定程度的封装，使用起来更方便灵活，拓展性更强。ElasticsearchRepository可以被继承操作ES，是SpringBoot对ES的高度封装，操作最为方便，但牺牲了灵活性。

      Spring boot 和Elasticsearch版本关系：

    一、使用ElasticsearchRestTemplate类

        1.引用Maven类库

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

         2. 配置文件application.yml

    1. spring:
    2.   elasticsearch:
    3.     rest:
    4.       uris: http://192.168.10.202:9200
    5.       connection-timeout: 1s
    6.       read-timeout: 1m
    7.       username: elastic
    8.       password: elastic

    注意，如果es资源没有开启x-pack安全插件的话，可以不加username和password（因为默认是没有的）。

    3.创建实体类（用于JSON文档对象的转换）

    1. import com.fasterxml.jackson.annotation.JsonFormat;
    2. import lombok.Data;
    3. import org.springframework.data.annotation.Id;
    4. import org.springframework.data.elasticsearch.annotations.DateFormat;
    5. import org.springframework.data.elasticsearch.annotations.Document;
    6. import org.springframework.data.elasticsearch.annotations.Field;
    7. import org.springframework.data.elasticsearch.annotations.FieldType;
    8. import java.time.LocalDate;
    9. import java.time.LocalDateTime;
    10. /**
    11.  * @author Sinbad
    12.  * @description: 测试ES对象
    13.  * @date 2022/8/26 17:12
    14.  */
    15. @Document(indexName = "mysql-test")
    16. @Data
    17. public class TestEsEntity {
    18.     @Id  
    19.     Long id;
    20.     @Field(type = FieldType.Text, name = "addr")
    21.     String addr;
    22.     @Field(type = FieldType.Text, name = "name")
    23.     String name;
    24.     @Field(type = FieldType.Date, name = "birthday", pattern = "yyyy-MM-dd")
    25.     LocalDate birthday;
    26.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8",locale = "zh_CN")
    27.     @Field(type = FieldType.Date, name = "create_time", pattern = "yyyy-MM-dd HH:mm:ss",format =DateFormat.custom )
    28.     LocalDateTime createTime;
    29. }

     @Document注解：表示对应一个索引名相关的文档
    @Data注解：lombok的，为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法
    @Id 注解：表示文档的ID字段
    @Field注解：文档字段的注解，对于日期含时间的字段，要写patten和format，不然会无法更新文档对象
    @JsonFormat注解：将文档转换成JSON返回给前端时用到
    注意日期类型字段不要用java.util.Date类型，要用java.time.LocalDate或java.time.LocalDateTime类型。

     测试实例：

    1. import com.hkyctech.commons.base.entity.JsonResult;
    2. import com.hkyctech.tu.core.vo.TestEsEntity ;
    3. import lombok.extern.slf4j.Slf4j;
    4. import org.elasticsearch.index.query.BoolQueryBuilder;
    5. import org.elasticsearch.index.query.QueryBuilders;
    6. import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
    7. import org.springframework.data.domain.PageRequest;
    8. import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
    9. import org.springframework.data.elasticsearch.core.query.NativeSearchQuery;
    10. import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
    11. import org.springframework.data.elasticsearch.core.query.Query;
    12. import org.springframework.stereotype.Service;
    13. import javax.annotation.Resource;
    14.  
    15.  
    16. @Slf4j
    17. @Service
    18. public class ElasticSearchServiceImpl {
    19.     @Resource
    20.     ElasticsearchRestTemplate elasticsearchTemplate; //直接注入就可以用了
    21.     /***
    22.      * @description 查询全部数据
    23.      */
    24.     public Object testSearchAll(){
    25.         Query query=elasticsearchTemplate.matchAllQuery();
    26.         return elasticsearchTemplate.search(query, TestEsEntity .class);
    27.     }
    28.  
    29.     /***
    30.     * @description  精确查询地址字段
    31.     * @param keyword 搜索关键字
    32.     */
    33.     public Object testSearchAddr(String keyword) {
    34.         NativeSearchQuery nativeSearchQuery = new NativeSearchQueryBuilder()
    35.                 //查询条件
    36.                 .withQuery(QueryBuilders.queryStringQuery(keyword).defaultField("addr"))
    37.                 //分页
    38.                 .withPageable(PageRequest.of(0, 10))
    39.                 //高亮字段显示
    40.                 .withHighlightFields(new HighlightBuilder.Field(keyword))
    41.                 .build();
    42.         return elasticsearchTemplate.search(nativeSearchQuery, TestEsEntity .class);
    43.     }
    44.  
    45.     /***
    46.     * @description 组合查询，查询关键词不分词，关系and
    47.     */
    48.     public Object testComboSearchAnd(){
    49.         BoolQueryBuilder esQuery=QueryBuilders.boolQuery()
    50.                 .must(QueryBuilders.termQuery("addr", "深圳"))
    51.                 .must(QueryBuilders.termQuery("addr", "广东"));
    52.  
    53.         NativeSearchQuery nativeSearchQuery = new NativeSearchQueryBuilder()
    54.                 //查询条件
    55.                 .withQuery(esQuery)
    56.                 //分页
    57.                 .withPageable(PageRequest.of(0, 10))
    58.                 .build();
    59.         return elasticsearchTemplate.search(nativeSearchQuery, TestEsEntity .class);
    60.     }
    61.  
    62.  
    63.     /***
    64.      * @description 组合查询，查询关键词不分词，关系or
    65.      */
    66.     public Object testComboSearchOr(){
    67.         BoolQueryBuilder esQuery=QueryBuilders.boolQuery()
    68.                 .should(QueryBuilders.termQuery("addr", "深圳"))
    69.                 .should(QueryBuilders.termQuery("addr", "广东"));
    70.  
    71.         NativeSearchQuery nativeSearchQuery = new NativeSearchQueryBuilder()
    72.                 //查询条件
    73.                 .withQuery(esQuery)
    74.                 //分页
    75.                 .withPageable(PageRequest.of(0, 10))
    76.                 .build();
    77.         return elasticsearchTemplate.search(nativeSearchQuery, TestEsEntity .class);
    78.     }
    79.  
    80.     /***
    81.     * @description  索引或更新文档
    82.     * @param vo 文档对象
    83.     */
    84.     public JsonResult testPutDocument(TestEsEntity  vo){
    85.         try {
    86.             Object data = elasticsearchTemplate.save(vo);
    87.             return JsonResult.getSuccessResult(data,"更新成功");
    88.         }catch (Exception e){
    89.             // 看http请求响应日志其实操作成功了，但是会报解析出错，可能是spring的bug，这里拦截一下
    90.             String message=e.getMessage();
    91.             if(message.indexOf("response=HTTP/1.1 200 OK")>0 || message.indexOf("response=HTTP/1.1 201 Created")>0){
    92.                 return JsonResult.getSuccessResult("更新成功");
    93.             }
    94.             return JsonResult.getFailResult(e.getStackTrace(),e.getMessage());
    95.         }
    96.     }
    97.  
    98.     /***
    99.     * @description  删除文档
    100.     * @param id 文档ID
    101.     */
    102.     public JsonResult deleteDocument(String id){
    103.         try {
    104.             elasticsearchTemplate.delete(id, TestEsEntity .class);
    105.             return JsonResult.getSuccessResult("删除成功");
    106.         }catch (Exception e){
    107.             String message=e.getMessage();
    108.             // 看http请求响应日志其实操作成功了，但是会报解析出错，可能是spring的bug，这里拦截一下
    109.             if(message.indexOf("response=HTTP/1.1 200 OK")>0 ){
    110.                 return JsonResult.getSuccessResult("删除成功");
    111.             }
    112.             return JsonResult.getFailResult(e.getStackTrace(),e.getMessage());
    113.         }
    114.     }
    115. }

    二、使用ElasticsearchRepository 类

      1.引用Maven类库

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

      2. 配置文件application.yml

    1. spring:
    2.   elasticsearch:
    3.     rest:
    4.       uris: http://192.168.10.202:9200
    5.       connection-timeout: 1s
    6.       read-timeout: 1m
    7.       username: elastic
    8.       password: elastic

     3. ElasticsearchRepository接口的源码 

    1. package org.springframework.data.elasticsearch.repository;
    2.  
    3. import java.io.Serializable;
    4.  
    5. import org.elasticsearch.index.query.QueryBuilder;
    6. import org.springframework.data.domain.Page;
    7. import org.springframework.data.domain.Pageable;
    8. import org.springframework.data.elasticsearch.core.query.SearchQuery;
    9. import org.springframework.data.repository.NoRepositoryBean;
    10.  
    11. @NoRepositoryBean
    12. public interface ElasticsearchRepository<T, ID extends Serializable> extends ElasticsearchCrudRepository<T, ID> {
    13.  
    14. 	<S extends T> S index(S entity);
    15.  
    16. 	Iterable<T> search(QueryBuilder query);
    17.  
    18. 	Page<T> search(QueryBuilder query, Pageable pageable);
    19.  
    20. 	Page<T> search(SearchQuery searchQuery);
    21.  
    22. 	Page<T> searchSimilar(T entity, String[] fields, Pageable pageable);
    23.  
    24. 	void refresh();
    25.  
    26. 	Class<T> getEntityClass();
    27. }

     4.CrudRepository  源码

    1. package org.springframework.data.repository;
    2.  
    3. import java.util.Optional;
    4.  
    5. /**
    6.  * Interface for generic CRUD operations on a repository for a specific type.
    7.  *
    8.  * @author Oliver Gierke
    9.  * @author Eberhard Wolff
    10.  */
    11. @NoRepositoryBean
    12. public interface CrudRepository<T, ID> extends Repository<T, ID> {
    13.  
    14. 	/**
    15. 	 * Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
    16. 	 * entity instance completely.
    17. 	 *
    18. 	 * @param entity must not be {@literal null}.
    19. 	 * @return the saved entity will never be {@literal null}.
    20. 	 */
    21. 	<S extends T> S save(S entity);
    22.  
    23. 	/**
    24. 	 * Saves all given entities.
    25. 	 *
    26. 	 * @param entities must not be {@literal null}.
    27. 	 * @return the saved entities will never be {@literal null}.
    28. 	 * @throws IllegalArgumentException in case the given entity is {@literal null}.
    29. 	 */
    30. 	<S extends T> Iterable<S> saveAll(Iterable<S> entities);
    31.  
    32. 	/**
    33. 	 * Retrieves an entity by its id.
    34. 	 *
    35. 	 * @param id must not be {@literal null}.
    36. 	 * @return the entity with the given id or {@literal Optional#empty()} if none found
    37. 	 * @throws IllegalArgumentException if {@code id} is {@literal null}.
    38. 	 */
    39. 	Optional<T> findById(ID id);
    40.  
    41. 	/**
    42. 	 * Returns whether an entity with the given id exists.
    43. 	 *
    44. 	 * @param id must not be {@literal null}.
    45. 	 * @return {@literal true} if an entity with the given id exists, {@literal false} otherwise.
    46. 	 * @throws IllegalArgumentException if {@code id} is {@literal null}.
    47. 	 */
    48. 	boolean existsById(ID id);
    49.  
    50. 	/**
    51. 	 * Returns all instances of the type.
    52. 	 *
    53. 	 * @return all entities
    54. 	 */
    55. 	Iterable<T> findAll();
    56.  
    57. 	/**
    58. 	 * Returns all instances of the type with the given IDs.
    59. 	 *
    60. 	 * @param ids
    61. 	 * @return
    62. 	 */
    63. 	Iterable<T> findAllById(Iterable<ID> ids);
    64.  
    65. 	/**
    66. 	 * Returns the number of entities available.
    67. 	 *
    68. 	 * @return the number of entities
    69. 	 */
    70. 	long count();
    71.  
    72. 	/**
    73. 	 * Deletes the entity with the given id.
    74. 	 *
    75. 	 * @param id must not be {@literal null}.
    76. 	 * @throws IllegalArgumentException in case the given {@code id} is {@literal null}
    77. 	 */
    78. 	void deleteById(ID id);
    79.  
    80. 	/**
    81. 	 * Deletes a given entity.
    82. 	 *
    83. 	 * @param entity
    84. 	 * @throws IllegalArgumentException in case the given entity is {@literal null}.
    85. 	 */
    86. 	void delete(T entity);
    87.  
    88. 	/**
    89. 	 * Deletes the given entities.
    90. 	 *
    91. 	 * @param entities
    92. 	 * @throws IllegalArgumentException in case the given {@link Iterable} is {@literal null}.
    93. 	 */
    94. 	void deleteAll(Iterable<? extends T> entities);
    95.  
    96. 	/**
    97. 	 * Deletes all entities managed by the repository.
    98. 	 */
    99. 	void deleteAll();
    100. }

    5. 查询查找策略

    5.1存储库方法可以定义为具有以下返回类型，用于返回多个元素：

    • List

    • Stream

    • SearchHits

    • List>

    • Stream>

    • SearchPage

    5.2 使用@Query注解

     使用@query注释对方法声明query。

    1. interface BookRepository extends ElasticsearchRepository<Book, String> {
    2.     @Query("{\"match\": {\"name\": {\"query\": \"?0\"}}}")
    3.     Page<Book> findByName(String name,Pageable pageable);
    4. }
    5.

    设置为注释参数的字符串必须是有效的 Elasticsearch JSON 查询。 它将作为查询元素的值发送到Easticsearch;例如，如果使用参数 John 调用函数，它将生成以下查询正文：

    1. {
    2.   "query": {
    3.     "match": {
    4.       "name": {
    5.         "query": "John"
    6.       }
    7.     }
    8.   }
    9. }

    对@Query采用集合参数的方法进行注释

    1. @Query("{\"ids\": {\"values\": ?0 }}")
    2. List<SampleEntity> getByIds(Collection<String> ids);
    3.

    将进行ID查询以返回所有匹配的文档。因此，调用List为[“id1”、“id2”、“id3”]的方法将生成查询主体

    1. {
    2.   "query": {
    3.     "ids": {
    4.       "values": ["id1", "id2", "id3"]
    5.     }
    6.   }
    7. }

    6.开发实例：

    1. public interface LogRepository extends ElasticsearchRepository<Log, String> {
    2.     /**
    3.      * 定义一个方法查询：根据title查询es
    4.      *
    5.      * 原因：  ElasticsearchRepository会分析方法名,参数对应es中的field（这就是灵活之处）
    6.      * @param title
    7.    
    8.      */
    10.     List<Log> findBySummary(String summary);
    11.     List<Log> findByTitle(String title);
    12.  
    13. 	/**
    14.      * 定义一个方法查询： 根据title，content查询es
    15.      */
    16.     List<Log> findByTitleAndContent(String title, String content);
    17.  
    18. }
    1.    @PostMapping("save")
    2.     public void save(@Validated @RequestBody Log req){
    3.         Log dto = new Log();
    4.         dto.setTitle(req.getTitle());
    5.         dto.setSummary(req.getSummary());
    6.         dto.setContent(req.getContent());
    7.         dto.setCreateTime(new Date());
    8.         dto.setId(req.getId());      
    9.         LogRepository.save(dto);
    10.         return ;
    11.         } 
    12.  
    13.     @PostMapping("testTitle")
    14.     public void testSearchTitle(@Validated @RequestBody Log req){
    15.         List<Log> searchResult = logRepository.findByTitle(req.getMobileType());
    16.         Iterator<Log> iterator = searchResult.iterator();
    17.         while(iterator.hasNext()){
    18.             System.out.println(iterator.next());
    19.         }
    20.         System.out.println("sa");
    21.         return;
    22.     }

    官网：Spring Data Elasticsearch - Reference Documentation

  • 相关阅读:
    【七：docken+jenkens部署】
    qt输出自定义的pdf文件源码详解
    Android 开发学习(二)
    【软考学习3】数据表示——浮点数计算 + 单精度浮点数IEEE754计算
    Spark(林子雨慕课课程)
    二、python+前端 实现MinIO分片上传
    PHP8的数据封装（数据隐藏）-PHP8知识详解
    HTTP+ 加密 + 认证 + 完整性保护 =HTTPS（HTTPS 安全通信机制）
    关于游戏公司组织架构的小讨论
    redis初级介绍
  • 原文地址：https://blog.csdn.net/leesinbad/article/details/128278548