5.SpringBoot集成ElasticSearch7.x

1.添加依賴

本文使用springboot版本為2.7

    <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-elasticsearch</artifactId></dependency>

spring官網es對應版本關系 https://docs.spring.io/spring-data/elasticsearch/reference/elasticsearch/versions.html

2.yml配置

spring:data:elasticsearch:repositories:enabled: true  #打開elasticsearch倉庫，默認trueelasticsearch:#username:#password:#path-prefix:uris: http://127.0.0.1:9200connection-timeout: 60000   #連接elasticsearch超時時間socket-timeout: 30000

3.創建文檔對象

/*** @author moshangshang* createIndex默認為true自動創建索引*/
@Data
@AllArgsConstructor
@Document(indexName ="books",createIndex = true)
public class Books implements Serializable {@Idprivate Integer id;//指定字段類型和分詞器@Field(type = FieldType.Text, analyzer = "ik_max_word")private String name;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String describe;}

public enum FieldType {Text,Integer,Long,Date,Float,Double,Boolean,Object,Auto,Nested,Ip,Attachment,Keyword
}

@GeoPointField  //地理位置類型字段
private GeoPoint location;

@Field(index = false) //不進行索引

4.繼承ElasticsearchRepository

/*** @author moshangshang*/
public interface BookMapper extends ElasticsearchRepository<Books,String> {
}

自定義接口查詢方法

 List<Book> findByNameAndPrice(String name, Integer price);

等同于

{"query": {"bool" : {"must" : [{ "query_string" : { "query" : "?", "fields" : [ "name" ] } },{ "query_string" : { "query" : "?", "fields" : [ "price" ] } }]}}
}

詳細接口方法命名見官方文檔：

https://docs.spring.io/spring-data/elasticsearch/reference/elasticsearch/repositories/elasticsearch-repository-queries.html

5.注入ElasticsearchRestTemplate

   @Autowiredprivate ElasticsearchRestTemplate elasticsearchRestTemplate;

建議通過elasticsearchRestTemplate進行es操作，ElasticsearchRepository也可直接操作，但多數方法已過時，不建議用

6.SpringBoot操作ElasticSearch

1.ElasticsearchRestTemplate索引操作

   /*** 操作文檔索引* 如果文檔的createIndex設置為true自動創建，則可以直接創建映射會自動創建索引* 如果為false，直接創建映射會返回Document的json，但索引并未創建*/@GetMapping("/create/index")public Document createIndex(){// 獲取操作的索引文檔對象IndexOperations indexOperations = elasticsearchRestTemplate.indexOps(Books.class);//判斷索引是否存在log.info("exists：{}",indexOperations.exists());//刪除索引文檔log.info("delete：{}",indexOperations.delete());//創建索引，如果存在則會拋異常log.info("create：{}",indexOperations.create());//創建映射，返回Documentlog.info("createMapping：{}",indexOperations.createMapping());indexOperations.delete();//創建索引同時創建映射，如果存在索引則會拋異常log.info("createWithMapping{}",indexOperations.createWithMapping());//更新映射mappinglog.info("putMapping：{}",indexOperations.putMapping());// 配置映射return indexOperations.createMapping();}

2.ElasticsearchRepository文檔操作

 /*** 發送保存數據，會自動創建索引文檔并保存數據* 如果文檔的createIndex設置為false，該方法會創建索引*/@GetMapping("/data/{id}")public String data(@PathVariable Integer id){//新增數據，等同于PUT/POST方式發送數據bookMapper.save(new Books(id,"四大名著西游記111","著名的神話小說"));//查所有數據bookMapper.findAll().forEach(System.out::println);bookMapper.findAllById(Arrays.asList("1", "10")).forEach(System.out::println);bookMapper.findById(id.toString()).ifPresent(System.out::println);//查所有數據按id排序bookMapper.findAll(Sort.by("id")).forEach(System.out::println);//刪除指定id數據bookMapper.deleteById(String.valueOf(id));//分頁查詢Page<Books> booksPage = bookMapper.findAll(Pageable.ofSize(2));//效果等同于booksPage2.getContent().forEach()log.info("總頁數:{}",booksPage.getTotalPages());System.out.println("第1頁");booksPage.forEach(System.out::println);int i = 1;//判斷是否有下一頁，hasPrevious方法判斷是否有前一頁while (booksPage.hasNext()){i++;booksPage = bookMapper.findAll(booksPage.nextPageable());log.info("第{}頁",i);booksPage.forEach(System.out::println);}return "success";}

3.ElasticsearchRestTemplate文檔操作

注意：直接執行可能會刪除時更新操作還未執行完，全部刪除時會導致更新的數據還在

    @GetMapping("/data1/{id}")public UpdateResponse data1(@PathVariable Integer id){//添加 elasticsearchRestTemplate.save(new Books(id,"四大名著西游記111","著名的神話小說"));elasticsearchRestTemplate.save(new Books(1,"四大名著西游記111","著名的神話小說"),new Books(2,"四大名著西游記111","著名的神話小說"),new Books(3,"四大名著西游記111","著名的神話小說"));/*** 修改 跟新增是相同。若id已存在，覆蓋其他所有字段，* 若某個字段沒有值，則為null。無法修改單個字段*/elasticsearchRestTemplate.save(new Books(3,"四大名著西游記222",null));//修改部分字段Document document = Document.create();document.put("name", "三國演義");document.put("describe", "著名的小說");//需要修改的id和參數UpdateQuery updateQuery = UpdateQuery.builder(String.valueOf(id)).withDocument(document).build();UpdateResponse response = elasticsearchRestTemplate.update(updateQuery, IndexCoordinates.of("books"));//批量修改部分字段List<UpdateQuery> updateQueryList = new ArrayList<>();for (int i = 1; i <= 3; i++) {Document bulkDocument = Document.create();bulkDocument.put("name", "三國演義"+i);bulkDocument.put("describe", "著名的小說"+i);//索引i數據不存在會報錯UpdateQuery updateQueryBulk = UpdateQuery.builder(Long.toString(i)).withDocument(bulkDocument).build();updateQueryList.add(updateQueryBulk);}elasticsearchRestTemplate.bulkUpdate(updateQueryList, IndexCoordinates.of("books"));//查詢Books books = elasticsearchRestTemplate.get(id.toString(), Books.class, IndexCoordinates.of("books"));log.info("查詢數據：{}",books);//刪除String delete = elasticsearchRestTemplate.delete(id.toString(), Books.class);log.info("刪除數據id：{}",delete);//條件刪除NativeSearchQuery nativeSearchQuery = new NativeSearchQueryBuilder().withQuery(QueryBuilders.matchQuery("name", "三國")).build();ByQueryResponse queryResponse = elasticsearchRestTemplate.delete(nativeSearchQuery, Books.class, IndexCoordinates.of("books"));log.info("刪除queryResponse數據數量：{}",queryResponse.getDeleted());//全部刪除//直接執行可能會刪除時更新操作還未執行完，全部刪除時會導致更新的數據還在ByQueryResponse queryResponse1 = elasticsearchRestTemplate.delete(new NativeSearchQueryBuilder().withQuery(QueryBuilders.matchAllQuery()).build(),Books.class, IndexCoordinates.of("books"));log.info("刪除queryResponse1數據數量：{}",queryResponse1.getDeleted());return response;}

4.ElasticsearchRestTemplate數據檢索

基礎高亮查詢

   @GetMapping("/query")public void query() {// 構建查詢條件(NativeSearchQueryBuilder更接近原生查詢)NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();//查詢queryBuilder.withQuery(QueryBuilders.matchQuery("username","lisi")).withSort(Sort.by("age").ascending());//高亮查詢HighlightBuilder highlightBuilder = new HighlightBuilder();highlightBuilder.field("username");//多個匹配項高亮關閉highlightBuilder.requireFieldMatch(false);highlightBuilder.preTags("<span style='color:red'>");highlightBuilder.postTags("</span>");//設置高亮queryBuilder.withHighlightBuilder(highlightBuilder);SearchHits<News> searchHits = elasticsearchRestTemplate.search(queryBuilder.build(), News.class);searchHits.forEach(e -> {log.info("全文檢索{}", e.getContent());Map<String, List<String>> highlightFields = e.getHighlightFields();List<String> list = highlightFields.get("username");if (list != null) {list.forEach(ex -> log.info("高亮{}", ex));}});}

NativeSearchQueryBuilder條件構建

 // 構建查詢條件(NativeSearchQueryBuilder更接近原生查詢)NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();  //查詢全部 match_allqueryBuilder.withQuery(QueryBuilders.matchAllQuery());  //查詢全部 過濾時間范圍queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withFilter(QueryBuilders.rangeQuery("time").timeZone("+08:00").format("yyyy-MM-dd HH:mm:ss").gt("2024-06-27 14:22:22").lt("2024-06-27 14:22:28"));//查詢全部 match_all 并按age升序queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withSort(Sort.by("age").ascending());//查詢全部 match_all 并按age升序 并分頁queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withSort(Sort.by("age").ascending()).withPageable(PageRequest.of(2, 10));//term精確查詢，整體匹配// 查詢內容只是為數字時 推薦使用term 進行檢索,但是當使用term中進行文本內容的全量檢索時term不會檢索任何內容queryBuilder.withQuery(QueryBuilders.termQuery("age", "2"));//多匹配值查詢queryBuilder.withQuery(QueryBuilders.termsQuery("age", "2", "3"));//全文檢索 match_queryqueryBuilder.withQuery(QueryBuilders.matchQuery("address", "Beijing"));//or 只要有一個詞存在則就符合條件，and表示每個詞都需存在queryBuilder.withQuery(QueryBuilders.matchQuery("address", "Beijing shanghai").operator((Operator.OR)));//短語匹配 match_phrasequeryBuilder.withQuery(QueryBuilders.matchPhraseQuery("address", "Beijing aaa"));//短語匹配 match_phrase_prefix 它允許文本中最后一項使用前綴匹配queryBuilder.withQuery(QueryBuilders.matchPhrasePrefixQuery("address", "Beijing a"));//多字段匹配 multi_matchqueryBuilder.withQuery(QueryBuilders.multiMatchQuery("Beijing aaa", "address", "username"));queryBuilder.withQuery(QueryBuilders.multiMatchQuery("Beijing aaa", "address", "username")//提升該字段查詢匹配權重.field("address", 10));//match_bool_prefix 允許文本中最后一項使用前綴匹配 其它都是term query。queryBuilder.withQuery(QueryBuilders.matchBoolPrefixQuery("address", "b"));//id查詢queryBuilder.withQuery(QueryBuilders.idsQuery().addIds("1", "2"));//區間查詢queryBuilder.withQuery(QueryBuilders.rangeQuery("age").gte(2).lte(3));//bool復合查詢//must必須  mustNot必須不//should 條件可以滿足也可以不滿足,在查詢中如果有滿足should的條件就會增加相關性得分QueryBuilders.boolQuery().must(QueryBuilders.matchQuery("address", "Beijing")).must(QueryBuilders.matchQuery("username", "lisi")).mustNot(QueryBuilders.matchQuery("age", "1")).should(QueryBuilders.matchQuery("age", "2"))//minimumShouldMatch 最小匹配度，必須 匹配的should子句的數量或百分比。.minimumShouldMatch("50%");//filter結果過濾QueryBuilders.boolQuery().filter(QueryBuilders.rangeQuery("age").gte(1).lte(2));//與上面結果相等QueryBuilders.boolQuery().must(QueryBuilders.rangeQuery("age").gte(1).lte(2));

完整測試代碼

<?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 https://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.7.0</version></parent><groupId>com.example</groupId><artifactId>test</artifactId><version>0.0.1-SNAPSHOT</version><name>test</name><properties><java.version>8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-elasticsearch</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build></project>

/*** @author moshangshang*/
@Data
@AllArgsConstructor
@Document(indexName ="news")
public class News implements Serializable {@Idprivate Integer id;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String address;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String username;@Field(type = FieldType.Long)private Integer age;
}

/*** @author moshangshang*/
@Data
@AllArgsConstructor
@Document(indexName ="books")
public class Books implements Serializable {@Idprivate Integer id;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String name;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String describe;}

/*** @author moshangshang*/
public interface BookMapper extends ElasticsearchRepository<Books,String> {
}

/*** @author moshangshang*/
@Slf4j
@RestController
@RequestMapping("/es")
public class BookController {@Autowiredprivate BookMapper bookMapper;@Autowiredprivate ElasticsearchRestTemplate elasticsearchRestTemplate;/*** 操作文檔索引* 如果文檔的createIndex設置為true自動創建，則可以直接創建映射會自動創建索引* 如果為false，直接創建映射會返回Document的json，但索引并未創建*/@GetMapping("/create/index")public Document createIndex() {// 獲取操作的索引文檔對象IndexOperations indexOperations = elasticsearchRestTemplate.indexOps(Books.class);//判斷索引是否存在log.info("exists：{}", indexOperations.exists());//刪除索引文檔log.info("delete：{}", indexOperations.delete());//創建索引，如果存在則會拋異常log.info("create：{}", indexOperations.create());//創建映射，返回Documentlog.info("createMapping：{}", indexOperations.createMapping());indexOperations.delete();//創建索引同時創建映射，如果存在索引則會拋異常log.info("createWithMapping{}", indexOperations.createWithMapping());//更新映射mappinglog.info("putMapping：{}", indexOperations.putMapping());// 配置映射return indexOperations.createMapping();}/*** 發送保存數據，會自動創建索引文檔并保存數據* 如果文檔的createIndex設置為false，該方法會創建索引*/@GetMapping("/data/{id}")public String data(@PathVariable Integer id) {//新增數據bookMapper.save(new Books(id, "四大名著西游記111", "著名的神話小說"));//查所有數據bookMapper.findAll().forEach(System.out::println);bookMapper.findAllById(Arrays.asList("1", "10")).forEach(System.out::println);bookMapper.findById(id.toString()).ifPresent(System.out::println);//查所有數據按id排序bookMapper.findAll(Sort.by("id")).forEach(System.out::println);//刪除指定id數據//bookMapper.deleteById(String.valueOf(id));//刪除匹配的數據bookMapper.delete(new Books(null, "四大名著西游記111", "著名的神話小說"));//刪除所有數據//bookMapper.deleteAll();//分頁查詢Page<Books> booksPage = bookMapper.findAll(Pageable.ofSize(2));//效果等同于booksPage2.getContent().forEach()log.info("總頁數:{}", booksPage.getTotalPages());System.out.println("第1頁");booksPage.forEach(System.out::println);int i = 1;//判斷是否有下一頁，hasPrevious方法判斷是否有前一頁while (booksPage.hasNext()) {i++;booksPage = bookMapper.findAll(booksPage.nextPageable());log.info("第{}頁", i);booksPage.forEach(System.out::println);}return "success";}@GetMapping("/data1/{id}")public UpdateResponse data1(@PathVariable Integer id) {//添加elasticsearchRestTemplate.save(new Books(id, "四大名著西游記111", "著名的神話小說"));elasticsearchRestTemplate.save(new Books(1, "四大名著西游記111", "著名的神話小說"),new Books(2, "四大名著西游記111", "著名的神話小說"),new Books(3, "四大名著西游記111", "著名的神話小說"));/*** 修改 跟新增是相同。若id已存在，覆蓋其他所有字段，* 若某個字段沒有值，則為null。無法修改單個字段*/elasticsearchRestTemplate.save(new Books(3, "四大名著西游記222", null));//修改部分字段Document document = Document.create();document.put("name", "三國演義");document.put("describe", "著名的小說");//需要修改的id和參數UpdateQuery updateQuery = UpdateQuery.builder(String.valueOf(id)).withDocument(document).build();UpdateResponse response = elasticsearchRestTemplate.update(updateQuery, IndexCoordinates.of("books"));//批量修改部分字段List<UpdateQuery> updateQueryList = new ArrayList<>();for (int i = 1; i <= 3; i++) {Document bulkDocument = Document.create();bulkDocument.put("name", "三國演義" + i);bulkDocument.put("describe", "著名的小說" + i);//索引i數據不存在會報錯UpdateQuery updateQueryBulk = UpdateQuery.builder(Long.toString(i)).withDocument(bulkDocument).build();updateQueryList.add(updateQueryBulk);}elasticsearchRestTemplate.bulkUpdate(updateQueryList, IndexCoordinates.of("books"));//查詢Books books = elasticsearchRestTemplate.get(id.toString(), Books.class, IndexCoordinates.of("books"));log.info("查詢數據：{}", books);//刪除String delete = elasticsearchRestTemplate.delete(id.toString(), Books.class);log.info("刪除數據id：{}", delete);//條件刪除NativeSearchQuery nativeSearchQuery = new NativeSearchQueryBuilder().withQuery(QueryBuilders.matchQuery("name", "三國")).build();ByQueryResponse queryResponse = elasticsearchRestTemplate.delete(nativeSearchQuery, Books.class, IndexCoordinates.of("books"));log.info("刪除queryResponse數據數量：{}", queryResponse.getDeleted());//全部刪除//直接執行可能會刪除時更新操作還未執行完，全部刪除時會導致更新的數據還在ByQueryResponse queryResponse1 = elasticsearchRestTemplate.delete(new NativeSearchQueryBuilder().withQuery(QueryBuilders.matchAllQuery()).build(),Books.class, IndexCoordinates.of("books"));log.info("刪除queryResponse1數據數量：{}", queryResponse1.getDeleted());return response;}@GetMapping("/query")public void query() {// 構建查詢條件(NativeSearchQueryBuilder更接近原生查詢)NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();//查詢全部 match_allqueryBuilder.withQuery(QueryBuilders.matchAllQuery());//查詢全部 過濾時間范圍queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withFilter(QueryBuilders.rangeQuery("time").timeZone("+08:00").format("yyyy-MM-dd HH:mm:ss").gt("2024-06-27 14:22:22").lt("2024-06-27 14:22:28"));//查詢全部 match_all 并按age升序queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withSort(Sort.by("age").ascending());//查詢全部 match_all 并按age升序 并分頁queryBuilder.withQuery(QueryBuilders.matchAllQuery()).withSort(Sort.by("age").ascending()).withPageable(PageRequest.of(2, 10));//term精確查詢，整體匹配// 查詢內容只是為數字時 推薦使用term 進行檢索,但是當使用term中進行文本內容的全量檢索時term不會檢索任何內容queryBuilder.withQuery(QueryBuilders.termQuery("age", "2"));//多匹配值查詢queryBuilder.withQuery(QueryBuilders.termsQuery("age", "2", "3"));//全文檢索 match_queryqueryBuilder.withQuery(QueryBuilders.matchQuery("address", "Beijing"));//or 只要有一個詞存在則就符合條件，and表示每個詞都需存在queryBuilder.withQuery(QueryBuilders.matchQuery("address", "Beijing shanghai").operator((Operator.OR)));//短語匹配 match_phrasequeryBuilder.withQuery(QueryBuilders.matchPhraseQuery("address", "Beijing aaa"));//短語匹配 match_phrase_prefix 它允許文本中最后一項使用前綴匹配queryBuilder.withQuery(QueryBuilders.matchPhrasePrefixQuery("address", "Beijing a"));//多字段匹配 multi_matchqueryBuilder.withQuery(QueryBuilders.multiMatchQuery("Beijing aaa", "address", "username"));queryBuilder.withQuery(QueryBuilders.multiMatchQuery("Beijing aaa", "address", "username")//提升該字段查詢匹配權重.field("address", 10));//match_bool_prefix 允許文本中最后一項使用前綴匹配 其它都是term query。queryBuilder.withQuery(QueryBuilders.matchBoolPrefixQuery("address", "b"));//id查詢queryBuilder.withQuery(QueryBuilders.idsQuery().addIds("1", "2"));//區間查詢queryBuilder.withQuery(QueryBuilders.rangeQuery("age").gte(2).lte(3));//bool復合查詢//must必須  mustNot必須不//should 條件可以滿足也可以不滿足,在查詢中如果有滿足should的條件就會增加相關性得分QueryBuilders.boolQuery().must(QueryBuilders.matchQuery("address", "Beijing")).must(QueryBuilders.matchQuery("username", "lisi")).mustNot(QueryBuilders.matchQuery("age", "1")).should(QueryBuilders.matchQuery("age", "2"))//minimumShouldMatch 最小匹配度，必須 匹配的should子句的數量或百分比。.minimumShouldMatch("50%");//filter結果過濾QueryBuilders.boolQuery().filter(QueryBuilders.rangeQuery("age").gte(1).lte(2));//與上面結果相等QueryBuilders.boolQuery().must(QueryBuilders.rangeQuery("age").gte(1).lte(2));//查詢queryBuilder.withQuery(QueryBuilders.matchQuery("username","lisi")).withSort(Sort.by("age").ascending());//高亮查詢HighlightBuilder highlightBuilder = new HighlightBuilder();highlightBuilder.field("username");//多個匹配項高亮關閉highlightBuilder.requireFieldMatch(false);highlightBuilder.preTags("<span style='color:red'>");highlightBuilder.postTags("</span>");//設置高亮queryBuilder.withHighlightBuilder(highlightBuilder);SearchHits<News> searchHits = elasticsearchRestTemplate.search(queryBuilder.build(), News.class);searchHits.forEach(e -> {log.info("全文檢索{}", e.getContent());Map<String, List<String>> highlightFields = e.getHighlightFields();List<String> list = highlightFields.get("username");if (list != null) {list.forEach(ex -> log.info("高亮{}", ex));}});}}