本文将会完整的讲述ES中搜索建议的程序实现。在网上搜索的教程当中大部分都是使用的ES的
TransportClient的接口实现该功能。根据官方文档的说法，这个接口将会在ES 7.0之后逐步取消。但是现在使用的JAVA High Level Rest Client又没有像样的文档和教程啊。所以自己写了一个简陋版的。
编程环境
1.Spring Boot
2.Elastic Search 6.2.3
搜索建议实现
1.基本思路
搜索建议是ES的重要功能。首先呢，我们想一想，如果ES没有提供搜索建议的功能，我们也是能够使用ES的基本功能进行实现的。实现呢，其实只需要建立一个搜索建议索引（index），然后定义一个text字段用来存储搜索字符串，每次搜索一次就存储一次搜索字符串；每次进行搜索的时候，都将输入文字实时传到后台，然后查询匹配的（通常是前缀匹配）搜索字符串，返回到前台进行展示。
从思路上来说是非常简单的，但是ES中对搜索建议的功能进行了封装。上一段中加粗的地方就是封装的点。通过使用ES封装的搜索建议和Bootstrap Autocomplete的功能，可以比较完整的实现整个搜索建议的流程。
2.实现过程
2.1建立搜索建议索引
搜索索引的建立和建立一个普通索引是没什么特别大的区别的，只需要把额外定义一个类型（type）为completion的字段即可。建立索引的过程可以采用以下的两种方法中任意一种：
①在程序中定义
//######################################### 搜索记录的索引 ########################################################
CreateIndexRequest request = new CreateIndexRequest("***"); //创建的index名称为jq_es
// 创建搜索历史index
CreateIndexRequest historyRequest=new CreateIndexRequest("search_history");
//设置index中type的数据映射，即每一条document的mapping数据类型
try {
XContentBuilder search_history= XContentFactory.jsonBuilder();
search_history.startObject();
{
search_history.startObject("history");
{
search_history.startObject("properties");
{
search_history.startObject("search_string");
{
search_history.field("type","text");
}
search_history.endObject();
search_history.startObject("search_time");
{
search_history.field("type","date");
}
search_history.endObject();
search_history.startObject("operator");
{
search_history.field("type","text");
}
search_history.endObject();
search_history.startObject(("operator_dw"));
{
search_history.field("type","text");
}
search_history.endObject();
search_history.startObject("suggestions");
{
search_history.field("type","completion");
}
search_history.endObject();
}
search_history.endObject();
}
search_history.endObject();
}
search_history.endObject();
historyRequest.mapping("history",search_history);
//同步执行创建请求
CreateIndexResponse createIndexResponse = client.indices().create(request);
CreateIndexResponse createIndexResponse1=client.indices().create(historyRequest);
程序的执行过程是非常清晰的，典型的ES接口的逻辑：不管执行什么操作，ES是面向json的指令的，所以呢，需要想方设法的将命令转换成json，然后传递到后台。具体来说，就是用各种builder来构造json，然后用request向后台发送请求，用各种response接收请求。
②用ES脚本定义（可以使用官方推荐工具Kibana）。除了上述的在java中直接进行初始化，我们也可以从es端建立索引。下面这个例子呢，是一个简单的demo.但是“麻雀虽小，五脏俱全”，可以清楚的看到我们定义了一个completion字段。我们通过观察 completion类型的说明可以发现，这是一个object对象，包含了至少input（搜索触发词），和weight（权重）这样两个域，这一点很重要，涉及到我们下面更新插入搜索历史的方法。
PUT music
{
"mappings": {
"_doc" : {
"properties" : {
"suggest" : {
"type" : "completion"
},
"title" : {
"type": "keyword"
}
}
}
}
}
2.2 插入搜索历史记录字符串
现在，搜索记录在ES中的索引已经建立好基本框架啦，但是里面还没有数据。数据是来自于哪里呢？数据是用户在前台每做一次搜索就会产生一条搜索查询语句，我们就会把这条语句存入到我们的ES索引当中，那么具体是怎么存储的呢？前文中提到了，搜索建议（suggester）的定义和普通的字段是没有什么特别大的区别的，所以我们仍然是惯用套路，就是使用XContentBuilder来进行json字符串的构造，然后使用request发送请求。在这里连结果都不用接收的其实。附上具体代码：
// 构造json用于插入索引，增加了搜索人，搜索时间，搜索字符串等等其他信息
XContentBuilder xContentBuilder = getSearchInfoJson(query, "admin");
IndexRequest indexRequest = new IndexRequest(historyIndex, historyType);
indexRequest.source(xContentBuilder);
restHighLevelClient.index(indexRequest);
2.3 获取搜索历史
在2.2中我们已经成功的在ES中存储了用户搜索的字符串，那么就需要在用户下一次搜索的时候，取出相应的（匹配）字符串，对用户进行提示。我们假设用户此时输入了字符串为query，希望提示的呢是所有以query为前缀的所有搜索记录。那么这就成为了一个ES的查询问题。查询的话就用SearchRequest去查呗？但是不行！就豆麻袋！我们的ES在这里对查询过程有了一步封装，首先需要把我们用来查询的前缀query封装成CompletionSuggestionBuilder,其实就封装了查询域和前缀这两个信息在一起。然后呢吧这个CompletionSuggestionBuilder扔进一个SuggestionBuilder中去，因为有可能不只是一个搜索建议哇，所以需要用SuggestionBuilder装一下，然后扔进request当中进行查询。同样，需要用一个SearchResponse去接住结果。但是，在结果的解析当中又有所不同。suggestion的解析要使用专门的response.getSuggest而不是我们之前常用的getHits()方法，然后返回值也挺麻烦，就是下面代码中那种方式。最终返回一个列表的建议字符串干干净净的传递给前台。
RestHighLevelClient restHighLevelClient = elasticSearchClientFactory.getClient();
// 数据清洗
query = this.cleanString(query);
SuggestBuilder suggestBuilder=new SuggestBuilder();
System.out.println("query string ="+query);
CompletionSuggestionBuilder csb=SuggestBuilders.completionSuggestion("suggestions").prefix(query).skipDuplicates(true);
suggestBuilder.addSuggestion("suggestions",csb);
SearchRequest searchRequest = new SearchRequest(historyIndex);
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder()
.suggest(suggestBuilder);
// 发送es 请求
searchRequest.source(searchSourceBuilder);
SearchResponse getResponse = null;
try {
getResponse = restHighLevelClient.search(searchRequest);
elasticSearchClientFactory.destroyClient();
} catch (java.io.IOException e) {
e.getLocalizedMessage();
}
assert getResponse != null;
// 获取建议
ArrayList<String> res=new ArrayList<>();
for( Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option> entry : getResponse.getSuggest().getSuggestion("suggestions").getEntries()) {
System.out.println("Check for: " + entry.getText() + ". Options:");
for( Suggest.Suggestion.Entry.Option option : entry.getOptions()) {
System.out.println("\t" + option.getText());
res.add(option.getText().toString());
}
}
return res;
2.4 前台展示
可以用来展示搜索记录的前台输入框插件多了去啦。在本项目中由于使用的是Bootstrap作为前台页面的基本框架，所以在这里，我也找了一个用于Bootstrap的插件。最简单的一个插件，插件教程的链接在文章的一开始就进行了介绍。使用的方法呢，同样很简单啦：
①定义一个input作为搜索框。
<form >
<input class="form-control basicAutoComplete" id="search" type="text" autocomplete="on"/>
</form>
②在js中，填入后台获取搜索建议的controller的方法，该方法应该能够根据前台传回的搜索字符串，查询ES，获取对应的搜索建议字符串列表，然后返回到前台。这里是有个坑的，我们注意到我得代码里是没有传递参数这样一个过程的，这个过程实际上是由插件完成的。我们只需要提供一个url，这个插件就会自动的在我们的url后面加上?q={此处是搜索字符串}这样的后缀
<script>
$(document).ready(function () {
$('.basicAutoComplete').autoComplete({
resolverSettings: {
//假如搜索我爱“北京天安门”，插件会自动加个后缀成为：'/rest/test/autocomplete/suggestions?q=我爱北京天安门'
url: '/rest/test/autocomplete/suggestions'
}
});
});
</script>
总结
&esmp; 好啦，至此，我们的搜索建议就完成啦。总结一下的话，首先需要总结的是ES的基本套路：用各种builder构建json，然后使用request发送请求，最后使用response进行接收。此外，还需要总结一下搜索建议的不同之处，就是更新的时候需要注意completion类型的定义方法，查询的时候需要使用suggestionBuilder进行封装，返回结果需要getSuggest进行解析。啦啦啦，over~
网友评论