RestClient查询文档、分页、高亮排序

RestClient查询文档

编写代码之前可以将Dev Tools编写DSL语言作为参考对象，方便我们才可能之间的关系

文档的查询同样适用昨天学习的 RestHighLevelClient对象，基本步骤包括：

• 1）准备Request对象
• 2）准备请求参数
• 3）发起请求
• 4）解析响应

1、快速入门

代码解读：

• 第一步，创建SearchRequest对象，指定索引库名

• 第二步，利用request.source()构建DSL，DSL中可以包含查询、分页、排序、高亮等

  • query()：代表查询条件，利用QueryBuilders.matchAllQuery()构建一个match_all查询的DSL

• 第三步，利用client.search()发送请求，得到响应

这里关键的API有两个，一个是request.source()，其中包含了查询、排序、分页、高亮等所有功能：

package cn.itcast.hotel;

import org.apache.http.HttpHost;
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.index.query.QueryBuilders;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.io.IOException;

/**
 * 项目名称：hotel-demo
 * 描述：酒店信息搜索
 *
 * @author zhong
 * @date 2022-06-04 10:29
 */
public class HotelSearchTest {
    
    
    private RestHighLevelClient client;

    /**
     * 执行之前进行连接
     */
    @BeforeEach
    void setUp(){
    
    
        this.client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.26.131:9200")
        ));
    }

    /**
     * 查询所有的数据
     */
    @Test
    void testSearch() throws IOException {
    
    
        // 1、获取
        SearchRequest request = new SearchRequest("hotel");
        // 2、设置请求
        request.source().query(QueryBuilders.matchAllQuery());
        // 3、发送请求
        SearchResponse search = client.search(request, RequestOptions.DEFAULT);
        // 4、解析响应数据
        SearchHits hits = search.getHits();
        // 4.1、获取总条数
        long value = hits.getTotalHits().value;
        System.out.println("共搜索到："+value+"条数据");
        // 4.2、获取文档数组
        SearchHit[] hitsArray = hits.getHits();
        // 4.3、遍历数组
        for (SearchHit documentFields : hitsArray) {
    
    
            // 获取文档
            String sourceAsString = documentFields.getSourceAsString();
            // 将文档放序列化为json对象
            JSONObject jsonObject = JSON.parseObject(sourceAsString);
            System.out.println("获取到的数组数据："+jsonObject);
        }
    }

    /**
     * 执行完之后销毁
     * @throws IOException
     */
    @AfterEach
    void tearDown() throws IOException {
    
    
        this.client.close();
    }
}

elasticsearch返回的结果是一个JSON字符串，结构包含：

• hits：命中的结果
  • total：总条数，其中的value是具体的总条数值
  • max_score：所有结果中得分最高的文档的相关性算分
  • hits：搜索结果的文档数组，其中的每个文档都是一个json对象
    • _source：文档中的原始数据，也是json对象

因此，我们解析响应结果，就是逐层解析JSON字符串，流程如下：

• SearchHits：通过response.getHits()获取，就是JSON中的最外层的hits，代表命中的结果
  • SearchHits#getTotalHits().value：获取总条数信息
  • SearchHits#getHits()：获取SearchHit数组，也就是文档数组
    • SearchHit#getSourceAsString()：获取文档结果中的_source，也就是原始的json文档数据

小结

查询的基本步骤是：

1. 创建SearchRequest对象

2. 准备Request.source()，也就是DSL。

   ① QueryBuilders来构建查询条件

   ② 传入Request.source() 的 query() 方法

3. 发送请求，得到结果

4. 解析结果（参考JSON结果，从外到内，逐层解析）

2、match查询

核心查询API是QueryBuilders

全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件，也就是query的部分。

因此，Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法：

而结果解析代码则完全一致，可以抽取并共享。

/**
 * 全局检索
 * @throws IOException
 */
@Test
void testMatch() throws IOException {
    
    
    // 1、获取request
    SearchRequest request = new SearchRequest("hotel");
    // 2、设置DSL
    request.source().query(QueryBuilders.matchQuery("all","如家"));
    // 多字段查询
    // request.source().query(QueryBuilders.multiMatchQuery("如家","name","business"));
    // 3、发送请求
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);
    extracted(search);
}

private void extracted(SearchResponse search) {
    
    
    // 4、解析响应数据
    SearchHits hits = search.getHits();
    // 4.1、获取总条数
    long value = hits.getTotalHits().value;
    System.out.println("共搜索到："+value+"条数据");
    // 4.2、获取文档数组
    SearchHit[] hitsArray = hits.getHits();
    // 4.3、遍历数组
    for (SearchHit documentFields : hitsArray) {
    
    
        // 获取文档
        String sourceAsString = documentFields.getSourceAsString();
        // 将文档放序列化为json对象
        JSONObject jsonObject = JSON.parseObject(sourceAsString);
        System.out.println("获取到的数组数据："+jsonObject);
    }
}

3、精确查询

精确查询主要是两者：

• term：词条精确匹配
• range：范围查询

与之前的查询相比，差异同样在查询条件，其它都一样。

查询条件构造的API如下：

4、布尔查询

布尔查询是用must、must_not、filter等方式组合其它查询，代码示例如下：

可以看到，API与其它查询的差别同样是在查询条件的构建，QueryBuilders，结果解析等其他代码完全不变。

完整代码如下：

/**
 * 布尔查询
 * @throws IOException
 */
@Test
void testMBoll() throws IOException {
    
    
    // 1、获取request
    SearchRequest request = new SearchRequest("hotel");
    // 2、设置DSL
    BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
    // 添加team
    boolQueryBuilder.must(QueryBuilders.termQuery("city","上海"));
    // 添加range
    boolQueryBuilder.filter(QueryBuilders.rangeQuery("price").lte(250));
    request.source().query(boolQueryBuilder);
    // 3、发送请求
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);
    extracted(search);
}

5、排序、分页

搜索结果的排序和分页是与query同级的参数，因此同样是使用request.source()来设置。

/**
 * 分页排序查询所有数据
 * @throws IOException
 */
@Test
void testPage() throws IOException {
    
    
    int page = 2;
    int size = 5;
    // 1、获取request
    SearchRequest request = new SearchRequest("hotel");
    // 2、设置DSL
    // 2.1、查询所有的数据
   request.source().query(QueryBuilders.matchAllQuery());
   // 2.2、设置排序
    request.source().sort("price", SortOrder.ASC);
    // 2.3、设置分页信息
    request.source().from((page-1)*size).size(5);
    // 3、发送请求
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);
    extracted(search);
}

6、高亮

高亮查询必须使用全文检索查询，并且要有搜索关键字，将来才可以对关键字高亮。

高亮的结果与查询的文档结果默认是分离的，并不在一起。

因此解析高亮的代码需要额外处理：

代码解读：

• 第一步：从结果中获取source。hit.getSourceAsString()，这部分是非高亮结果，json字符串。还需要反序列为HotelDoc对象
• 第二步：获取高亮结果。hit.getHighlightFields()，返回值是一个Map，key是高亮字段名称，值是HighlightField对象，代表高亮值
• 第三步：从map中根据高亮字段名称，获取高亮字段值对象HighlightField
• 第四步：从HighlightField中获取Fragments，并且转为字符串。这部分就是真正的高亮字符串了
• 第五步：用高亮的结果替换HotelDoc中的非高亮结果

/**
 * 分页排序查询所有数据
 * @throws IOException
 */
@Test
void testPage() throws IOException {
    
    
    int page = 2;
    int size = 5;
    // 1、获取request
    SearchRequest request = new SearchRequest("hotel");
    // 2、设置DSL
    // 2.1、查询所有的数据
   request.source().query(QueryBuilders.matchAllQuery());
   // 2.2、设置排序
    request.source().sort("price", SortOrder.ASC);
    // 2.3、设置分页信息
    request.source().from((page-1)*size).size(5);
    // 3、发送请求
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);
    extracted(search);
}

/**
 * 高亮显示
 * @throws IOException
 */
@Test
void testHi() throws IOException {
    
    
    // 1、获取request
    SearchRequest request = new SearchRequest("hotel");
    // 2、设置DSL
    // 2.1、查询所有的数据
    request.source().query(QueryBuilders.matchQuery("all","如家"));
    // 2.2、设置高亮的字段以及全局匹配
    request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
    // 3、发送请求
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);
    extracted(search);
}

/**
 * 封装的提统一使用的重构步骤
 * @param search
 */
private void extracted(SearchResponse search) {
    
    
    // 4、解析响应数据
    SearchHits hits = search.getHits();
    // 4.1、获取总条数
    long value = hits.getTotalHits().value;
    System.out.println("共搜索到："+value+"条数据");
    // 4.2、获取文档数组
    SearchHit[] hitsArray = hits.getHits();
    // 4.3、遍历数组
    for (SearchHit documentFields : hitsArray) {
    
    
        // 获取文档
        String sourceAsString = documentFields.getSourceAsString();
        // 将文档放序列化为json对象
        HotelDoc hotelDoc = JSON.parseObject(sourceAsString, HotelDoc.class);
        // 获取高亮结果
        Map<String, HighlightField> highlightFields = documentFields.getHighlightFields();
        // 判断是否为空
        if(!CollectionUtils.isEmpty(highlightFields)){
    
    
            // 根据字段名称获取高亮信息
            HighlightField name = highlightFields.get("name");
            if(name!=null){
    
    
                // 获取高亮值
                String naemStr = name.getFragments()[0].string();
                // 将高亮的值覆盖原来的name值
                hotelDoc.setName(naemStr);
            }
        }
        System.out.println("获取到的数组数据："+hotelDoc);
    }
}