Java利用ElasticSearch實現(xiàn)自動補全功能

更新時間：2023年08月09日 09:02:30 作者：Awbeci

這篇文章主要為大家詳細介紹了Java如何利用ElasticSearch實現(xiàn)跟谷歌和百度類似的下拉補全提示功能，文中的示例代碼講解詳細，需要的可以參考一下

前言

最近在學(xué)習(xí)elasticsearch，想實現(xiàn)跟谷歌和百度類似的功能：下拉補全提示，如圖所示：

準備

我使用的版本和依賴包，如下所示：

<properties>
    <java.version>17</java.version>
    <spring-boot.version>3.0.2</spring-boot.version>
    <spring-cloud.version>2022.0.0</spring-cloud.version>
    <spring-cloud-alibaba.version>2022.0.0.0-RC2</spring-cloud-alibaba.version>
</properties>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>
<dependency>
    <groupId>co.elastic.clients</groupId>
    <artifactId>elasticsearch-java</artifactId>
    <version>8.7.1</version>
</dependency>

devtools操作

首先，我們必須先創(chuàng)建index并設(shè)置成想要設(shè)置成下拉補全提示的字段為completion類型，如下所示：

PUT index_urls
{
  "mappings": {
    "properties": {
      "suggest": {
        "type": "completion",
        "analyzer": "ik_smart"
      }
    }
  }
}

這樣我們創(chuàng)建了index_urls，并且設(shè)置好了suggest字段是completion類型。

接著，我們往里面加點數(shù)據(jù)，并且使用completion suggester進行查詢，如下所示：

// 自動補全查詢
GET /index_urls/_search
{
  "suggest": {
    "title_suggest": {
      "text": "n", // 關(guān)鍵字
      "completion": {
        "field": "suggest", // 補全查詢的字段
        "skip_duplicates": true, // 跳過重復(fù)的
        "size": 10 // 獲取前10條結(jié)果
      }
    }
  }
}

查詢結(jié)果如下所示：

{
  "took": 1,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 0,
      "relation": "eq"
    },
    "max_score": null,
    "hits": []
  },
  "suggest": {
    "title_suggest": [
      {
        "text": "n",
        "offset": 0,
        "length": 1,
        "options": [
          {
            "text": "npm、yarn的安裝和設(shè)置淘寶鏡像源_yarn設(shè)置淘寶鏡像_cn_ljr的博客-CSDN博客",
            "_index": "index_urls",
            "_id": "64d0548bd8239d21cb9fe4e5",
            "_score": 1,
            "_source": {
              "_class": "com.seaurl.searchservice.document.UrlIndex",
              "id": "64d0548bd8239d21cb9fe4e5",
              "uid": "6461e6ac25d966329b7d7642",
              "categoryId": "64b89acfaf50e77e53ef89ef",
              "categoryName": "戶外運動",
              "categoryParentId": "",
              "categoryParentName": "",
              "title": "npm、yarn的安裝和設(shè)置淘寶鏡像源_yarn設(shè)置淘寶鏡像_cn_ljr的博客-CSDN博客",
              "suggest": {
                "input": [
                  "npm、yarn的安裝和設(shè)置淘寶鏡像源_yarn設(shè)置淘寶鏡像_cn_ljr的博客-CSDN博客"
                ]
              },
              "url": "https://blog.csdn.net/cn_ljr/article/details/126319130",
              "domain": "blog.csdn.net",
              "description": "安裝npm和yarn，配置npm和yarn的鏡像源為淘寶鏡像源_yarn設(shè)置淘寶鏡像",
              "favicon": "https://cdn.seaurl.com/space/url/blog.csdn.net/favicon.ico",
              "env": "dev",
              "createdDt": 1691374731421,
              "updatedDt": 1691374731421
            }
          }
        ]
      }
    ]
  }
}

這樣就完成了自動補全提示查詢了，接下來我們使用java再實現(xiàn)一遍。

java操作

首先，我們創(chuàng)建實體類，并且定義completion類型的字段，如下所示：

@Data
public class UrlIndex {
    private String id;
    private String uid;
    // 分類id
    private String categoryId;
    private String categoryName;
    private String categoryParentId;
    private String categoryParentName;
    private String title;
    // 下拉提示建議使用的字段，注意：Completion類型字段，不能做篩選用
//    @CompletionField(analyzer="ik_smart",searchAnalyzer="ik_smart", maxInputLength = 100)
    private Completion suggest;
    private String url;
    private String domain;
    private String description;
    //如果沒獲取前端顯示domain首字母
    private String favicon;
    private Date createdDt;//創(chuàng)建時間
    private Date updatedDt;//更新時間
}

接著，我們往es中添加數(shù)據(jù)，并且把查詢轉(zhuǎn)化成java代碼，如下所示：

private SearchResponse getEsSuggestionData(String filedName, String fieldValue) {
        try {
            String index = getEsIndexByEnv();
            Suggester suggester = Suggester.of(s -> s
                    .suggesters("title-suggest", FieldSuggester.of(fs -> fs
                            .completion(cs -> cs.skipDuplicates(true)
                                    .size(10)
                                    .field(filedName)
                            )
                    ))
                    .text(fieldValue)
            );
            return elasticsearchClient.search(s ->
                            s.index(index)
                                    // 使用source可以返回固定字段
//                                    .source()
                                    .suggest(suggester)
                    , Map.class);
        } catch (Exception ex) {
            log.info("getEsSuggestionData error={}", ex.getMessage());
            return null;
        }
    }

這樣就完成了查詢的功能，接下來，我們要把返回的數(shù)據(jù)拿出來，并轉(zhuǎn)換之后返回給前端顯示，如下所示：

@Override
    public List<UrlIndexDto> searchSuggestionDataBy(String fieldName, String fieldValue) {
        SearchResponse response = getEsSuggestionData(fieldName, fieldValue);
        if (response != null) {
            Map suggestMap = response.suggest();
            if (suggestMap != null) {
                List<?> titleSuggestionList = (List<?>) suggestMap.get("title-suggest");
                if (titleSuggestionList != null) {
                    for (Object titleSuggestion : titleSuggestionList) {
                        if (titleSuggestion instanceof Suggestion) {
                            Suggestion suggestion = (Suggestion) titleSuggestion;
                            if (suggestion.isCompletion()) {
                                CompletionSuggest completionSuggest = suggestion.completion();
                                List<co.elastic.clients.elasticsearch.core.search.CompletionSuggestOption> options = completionSuggest.options();
                                List<UrlIndexDto> urlIndexDtos = new ArrayList<>();
                                for (co.elastic.clients.elasticsearch.core.search.CompletionSuggestOption option : options) {
                                    Object obj = option.source();
                                    ObjectMapper objectMapper = new ObjectMapper();
                                    UrlIndexDto urlIndexDto = objectMapper.convertValue(obj, UrlIndexDto.class);
                                    urlIndexDtos.add(urlIndexDto);
                                }
                                return urlIndexDtos;
                            }
                        }
                    }
                }
            }
        }
        return null;
    }

這樣就完成了查詢并返回的操作，下面我們講解下前端如何實現(xiàn)。

前端操作

我們使用react和antd來實現(xiàn)，先定義組件和相關(guān)方法，如下所示：

<AutoComplete allowClear className={styles.input} options={options} onSelect={onSelect} value={input} onChange={async (e) => {
              setInput(e)
              debouncedOnChange(e);
            }}>
    <Input placeholder={'請輸入搜索內(nèi)容'} prefix={<SearchOutlined/>} size={'large'}
           onPressEnter={onSearch} />
</AutoComplete>

相關(guān)方法：

const [input, setInput] = useState('')
const [options, setOptions] = useState([])
// 在組件外部定義防抖函數(shù)
const debouncedOnChange = _.debounce(async (e) => {
    // 調(diào)用自動補全接口
    const res = await dispatch(webSearchSuggestion({
        q: e
    }))
    const resData = res.payload.data
    if (resData && resData.length>0){
        let list = []
        resData.forEach(item =>{
            console.log('item resData=', item)
            list.push({
                label: item.title,
                value: item.title,
                url: item.url
            })
        })
        // 將數(shù)據(jù)設(shè)置到options中 
        setOptions(list)
    }else{
        setOptions([])
    }
}, 500);
// 搜索框回車事件，調(diào)用查詢接口(非自動補全接口)
async function onSelect(value, option){
    dispatch(webSearch({
        q: option.value,
        pageNum: 1,
        pageSize: 20
    }))
}

我們使用了ladash的防抖函數(shù)來實現(xiàn)搜索。

完成了準備工作，我們來看看實現(xiàn)效果，如下所示：