springboot整合ElasticSearch使用completion實現補全功能

刘大猫26發表於2024-11-02

Spring BootElasticsearch

摘要
springboot程式碼
- 依賴
- 程式碼
kibana程式碼
- 第一部分：設定index、type、mapping
- 第二部分：批次插入
- 第三部分：執行
- 第四部分：結果展示
本人先關其他文章連結

摘要

所謂自動補全功能就是“百度搜尋框”中每敲下一個字元下面的提示框就會動態改變提示的功能，就是下面的效果：↓

說明：使用RestHighLevelClient 即可實現輸入框補全功能

springboot程式碼
kibana程式碼

springboot程式碼

依賴

<!--ES-->
<dependency>
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
    <version>6.8.12</version>
    <exclusions>
        <exclusion>
            <artifactId>elasticsearch</artifactId>
            <groupId>org.elasticsearch</groupId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.elasticsearch</groupId>
    <artifactId>elasticsearch</artifactId>
    <version>6.8.12</version>
</dependency>

程式碼

import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.common.unit.Fuzziness;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.index.query.BoolQueryBuilder;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightField;
import org.elasticsearch.search.sort.FieldSortBuilder;
import org.elasticsearch.search.sort.SortOrder;
import org.elasticsearch.search.suggest.Suggest;
import org.elasticsearch.search.suggest.SuggestBuilder;
import org.elasticsearch.search.suggest.completion.CompletionSuggestionBuilder;

@Autowired
private RestHighLevelClient client;
public static final int NINE = 9;
public static final int TEN = 10;

/**
     *  輸入框自動補全提示功能（ElasticSearch使用completion實現補全功能）
     * @param request request
     * @param suggestValue 輸入引數
     * @author liudz
     * @date 2021/4/19
     * @return 執行結果
     **/
    @GetMapping(value = "/completion")
    public Response<List<String>> getSuggestCompletion(@RequestParam String suggestValue, HttpServletRequest request) {
        log.info("--getSearchSuggest--begin--");
        Long userId = Long.valueOf(request.getUserPrincipal().getName());
        //指定在哪個欄位搜尋
        String suggestField = "region";

        SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
        //suggestField為指定在哪個欄位搜尋，suggestValue為輸入內容，TEN為10，代表輸出顯示最大條數
        CompletionSuggestionBuilder suggestionBuilderDistrict =
                new CompletionSuggestionBuilder(suggestField).prefix(suggestValue).size(TEN);
        SuggestBuilder suggestBuilder = new SuggestBuilder();
        suggestBuilder.addSuggestion("my_suggest", suggestionBuilderDistrict);
        searchSourceBuilder.suggest(suggestBuilder);
        SearchRequest searchRequest = new SearchRequest(userId + esIndex);
        searchRequest.types(esType);
        searchRequest.source(searchSourceBuilder);
        SearchResponse response = null;
        try {
            response = client.search(searchRequest, RequestOptions.DEFAULT);
        } catch (IOException e) {
            log.error("IOException:{}", e);
        }
        Suggest suggest = response.getSuggest();

        List<String> keywords = null;
        if (suggest != null) {
            keywords = new ArrayList<>();
            List<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>> entries =
                    suggest.getSuggestion("my_suggest").getEntries();
            for (Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option> entry: entries) {
                for (Suggest.Suggestion.Entry.Option option: entry.getOptions()) {
                    String keyword = option.getText().string();
                    if (!StringUtils.isEmpty(keyword)) {
                        if (keywords.contains(keyword)) {
                            continue;
                        }
                        keywords.add(keyword);
                        if (keywords.size() >= NINE) {
                            break;
                        }
                    }
                }
            }
        }
        return Response.success(keywords);
    }

kibana程式碼

第一部分：設定index、type、mapping

說明：設定某個欄位"type": "completion"即可

PUT 12_assets_directory_v1/
{
  "index_patterns": "test-logs-*",
  "settings": {
		"number_of_shards": 5,
		"number_of_replicas": 1,
		"analysis": {
      "analyzer": {
        "my_analyzer": {
          "type": "pattern",
          "pattern":["_","-"]
        }
      }
    }
	},
  "mappings": {
    "_doc":{
      "properties": {
				"file_name": {
					"type": "text",
					"copy_to": "region"
				},
				"file_type": {
				  "type": "keyword"
				},
				"database_name": {
					"type": "text",
					"analyzer": "ik_max_word",
					"copy_to": "region"
				},
				"table_name": {
					"type": "text",
					"analyzer": "ik_max_word",
					"copy_to": "region"
				},
				"include_fields": {
					"type": "text",
					"index": false
				},
				"source_business": {
					"type": "integer",
					"index": false
				},
				"store_type": {
					"type": "text",
					"index": false
				},
				"whether_online": {
					"type": "byte",
					"index": false
				},
				"foreign_id": {
					"type": "integer",
					"index": false
				},
				"update_time": {
					"type": "long",
					"index": false
				},
				"region": {
			          "type": "completion",
			          "analyzer": "ik_max_word"
      }
			}
    }
  }
}

第二部分：批次插入

批次插入每個json必須單獨存在一行

POST _bulk/?refresh=true
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "Lucene is cool","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 10,"update_time": 1618560193000}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "Lucene使用者檔案","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 11,"update_time": 1618560193010}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "103-is-cool","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 12,"update_time": 1618560193040}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "103_is_cool","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 20,"update_time": 1618560193120}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "103 is cool","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 17,"update_time": 1618560193070}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "test001","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 18,"update_time": 1618560193080}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "test002 ldz","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 19,"update_time": 1618560193090}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "美麗心之所想","file_type": "file","database_name": "","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 13,"update_time": 1618560193050}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "魅力","file_type": "file","database_name": "美好","table_name": "","include_fields": "","source_business": 1,"store_type": "hdfs","whether_online": 0,"foreign_id": 14,"update_time": 1618560193060}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "","file_type": "table","database_name": "geespace_bd_platform_dev","table_name": "12_mysql-1","include_fields": "","source_business": 1,"store_type": "mysql","whether_online": 0,"foreign_id": 10,"update_time": 1618560193020}
{ "index" : { "_index" : "12_assets_directory_v1","_type" : "_doc" }}
{ "file_name": "","file_type": "table","database_name": "geespace_bd_platform_dev","table_name": "103_addserialnumber_2","include_fields": "","source_business": 1,"store_type": "mysql","whether_online": 0,"foreign_id": 11,"update_time": 1618560193030}

第三部分：執行

“song-suggest”為自定義的別名，“field”為要查詢的欄位

POST 12_assets_directory_v1/_search?pretty
{
  "suggest": {
    "song-suggest": {
      "prefix": "g",
      "completion": {
        "field": "region"
      }
    }
  }
}

第四部分：結果展示

返回json中options集合中的text即為補全提示的內容

{
  "took" : 5,
  "timed_out" : false,
  "_shards" : {
    "total" : 5,
    "successful" : 5,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : 0,
    "max_score" : 0.0,
    "hits" : [ ]
  },
  "suggest" : {
    "song-suggest" : [
      {
        "text" : "g",
        "offset" : 0,
        "length" : 1,
        "options" : [
          {
            "text" : "geespace_bd_platform_dev",
            "_index" : "12_assets_directory_v1",
            "_type" : "_doc",
            "_id" : "jIkR6HgBdsS-EtqKoYwv",
            "_score" : 1.0,
            "_ignored" : [
              "region"
            ],
            "_source" : {
              "file_name" : "",
              "file_type" : "table",
              "database_name" : "geespace_bd_platform_dev",
              "table_name" : "12_mysql-1",
              "include_fields" : "",
              "source_business" : 1,
              "store_type" : "mysql",
              "whether_online" : 0,
              "foreign_id" : 10,
              "update_time" : 1618560193020
            }
          },
          {
            "text" : "geespace_bd_platform_dev",
            "_index" : "12_assets_directory_v1",
            "_type" : "_doc",
            "_id" : "jYkR6HgBdsS-EtqKoYwv",
            "_score" : 1.0,
            "_ignored" : [
              "region"
            ],
            "_source" : {
              "file_name" : "",
              "file_type" : "table",
              "database_name" : "geespace_bd_platform_dev",
              "table_name" : "103_addserialnumber_2",
              "include_fields" : "",
              "source_business" : 1,
              "store_type" : "mysql",
              "whether_online" : 0,
              "foreign_id" : 11,
              "update_time" : 1618560193030
            }
          }
        ]
      }
    ]
  }
}

本人先關其他文章連結

1.ElasticSearch7.6.x 模板及滾動索引建立及注意事項
https://blog.csdn.net/a924382407/article/details/115082265

2.ElasticSearch的IK分詞器
https://blog.csdn.net/a924382407/article/details/117255506

3.ElasticSearch核心概念：倒排索引
https://blog.csdn.net/a924382407/article/details/117255449

4.springboot整合ElasticSearch使用completion實現補全功能
https://blog.csdn.net/a924382407/article/details/115868167

5.ES Restful API講解使用
https://blog.csdn.net/a924382407/article/details/115085022

6.ES API，使用Kibana的開發工具用例說明
https://blog.csdn.net/a924382407/article/details/115084549

SpringBoot整合ElasticSearch實現多版本的相容
2018-05-08
Spring BootElasticsearch
SpringBoot 整合 elasticsearch
2019-02-28
Spring BootElasticsearch
SpringBoot整合elasticsearch
2018-05-04
Spring BootElasticsearch
ElasticSearch 整合 SpringBoot
2020-11-13
ElasticsearchSpring Boot
Qt：透過QCompleter類提供的補全框completion box，根據使用者輸入的內容提供可能的補全選項實現自動補全功能
2024-04-19
QT
ElasticSearch8 - SpringBoot整合ElasticSearch
2024-03-25
ElasticsearchSpring Boot
Elasticsearch學習（三）springboot整合ElasticSearch
2021-01-02
ElasticsearchSpring Boot
Roslyn 簡單實現程式碼智慧提示補全功能
2024-08-18
ROS
SpringBoot整合ElasticSearch7.6.2
2020-06-24
Spring BootElasticsearch
「Elasticsearch」SpringBoot快速整合ES
2020-12-07
ElasticsearchSpring Boot
PhpStorm 補全功能
2020-02-14
PHPORM
新手必學的使用命令列實現tab鍵自動補全功能
2021-09-11
命令列
ElasticSearch與SpringBoot的整合與JPA方法的使用
2019-01-03
ElasticsearchSpring Boot
Vue中實現輸入框的自動補全功能
2024-04-09
Vue
SpringBoot整合ElasticSearch（第八更）
2020-10-27
Spring BootElasticsearch
springboot整合FastDFS使用實現防盜鏈功能
2024-06-25
Spring BootAST
vim實現python補全功能--最新安裝成功經驗分享
2020-10-10
Python
Elasticsearch學習＜四＞SpringBoot整合es
2020-12-10
ElasticsearchSpring Boot
SpringBoot整合Redis使用Restful風格實現CRUD功能
2019-05-08
Spring BootRedisREST
SpringBoot整合Elasticsearch遊標查詢（scroll）
2020-10-16
Spring BootElasticsearch
手把手教你SpringBoot整合Elasticsearch（ES）
2021-03-07
Spring BootElasticsearch
SpringBoot 整合Mybatis + PageHelper 實現分頁
2020-07-22
Spring BootMyBatis
springboot整合shiro實現身份認證
2020-04-07
Spring Boot
elasticsearch7.6.x 整合springboot2(一)
2020-05-05
ElasticsearchSpring Boot
SpringBoot整合devtools實現熱部署除錯
2024-06-14
Spring Bootdev熱部署除錯
SpringBoot 整合 Shiro 實現登入攔截
2021-09-13
Spring Boot
SpringBoot整合atomikos實現跨庫事務
2022-11-24
Spring Boot
15.SpringBoot整合Redis快取實現
2020-12-15
Spring BootRedis快取
springboot整合使用JdbcTemplate
2020-12-26
Spring BootJDBC
SpringBoot整合ElasticSearch 入門demo學習筆記
2020-11-05
Spring BootElasticsearch筆記
SpringBoot 實戰 (十七) | 整合 WebSocket 實現聊天室
2019-03-05
Spring BootWeb
Spring Boot 整合 Elasticsearch 實戰
2020-08-07
Spring BootElasticsearch
SpringBoot 整合 JWT 實現 token 驗證，token 登出
2019-10-25
Spring BootJWT
SpringBoot框架整合SpringSecurity實現安全訪問控制
2019-01-28
Spring Boot框架Gse
SpringBoot 整合 RabbitMQ 實現訊息可靠傳輸
2022-05-25
Spring BootMQ
springboot整合elasticsearch7.2(基於官方high level client)
2019-07-30
Spring BootElasticsearchclient
SpringBoot 使用 Elasticsearch 問題彙總
2022-09-27
Spring BootElasticsearch
SpringBoot2 整合 SpringSecurity 框架，實現使用者許可權安全管理
2020-02-10
Spring BootGse框架