SpringCloud：ElasticSearch之RestClient查询文档

偏执的太偏执、 2024-03-23 13:02 77阅读 0赞

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

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

### 1.快速入门 ###

我们以`match_all`查询为例

#### 1.1.发起查询请求 ####

![在这里插入图片描述][38038e690a0d4601a6d78c37f9b13998.png_pic_center]

代码解读：

*  第一步，创建`SearchRequest`对象，指定索引库名
 *  第二步，利用`request.source()`构建DSL，DSL中可以包含查询、分页、排序、高亮等
    
     *  `query()`：代表查询条件，利用`QueryBuilders.matchAllQuery()`构建一个`match_all`查询的`DSL`
 *  第三步，利用`client.search()`发送请求，得到响应

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

![在这里插入图片描述][6f44a3405edd4477a61049fc55df3a53.png_pic_center]

另一个是`QueryBuilders`，其中包含`match`、`term`、`function_score`、`bool`等各种查询：

![在这里插入图片描述][3f79a42ebf964e5caa80c3c0964b77a3.png_pic_center]

#### 1.2.解析响应 ####

响应结果的解析：

![在这里插入图片描述][4ce0c6bac5b2442198b6f04a8a0f7bdc.png_pic_center]

`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.3.完整代码 ####

完整代码如下：

@Test
    void testMatchAll() throws IOException {
        
        // 1.准备Request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备DSL
        request.source().query(QueryBuilders.matchAllQuery());
        // 3.发送请求
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    
        // 4.解析响应
        handleResponse(response);
    }
    
    private void handleResponse(SearchResponse response) {
        
        // 4.解析响应
        SearchHits searchHits = response.getHits();
        // 4.1.获取总条数
        long total = searchHits.getTotalHits().value;
        System.out.println("共搜索到" + total + "条数据");
        // 4.2.文档数组
        SearchHit[] hits = searchHits.getHits();
        // 4.3.遍历
        for (SearchHit hit : hits) {
        
            // 获取文档source
            String json = hit.getSourceAsString();
            // 反序列化
            HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
            System.out.println("hotelDoc = " + hotelDoc);
        }
    }

#### 1.4.小结 ####

查询的基本步骤是：

1.  创建`SearchRequest`对象
2.  准备`Request.source()`，也就是`DSL`。
    
    ① `QueryBuilders`来构建查询条件
    
    ② 传入`Request.source()`的`query()`方法
3.  发送请求，得到结果
4.  解析结果（参考`JSON`结果，从外到内，逐层解析）

### 2.`match`查询 ###

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

![在这里插入图片描述][9e6960f5c03541f594f0fda561f098ed.png_pic_center]

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

![在这里插入图片描述][33ec990ab23e4e118bfe81f0eac849e5.png_pic_center]

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

完整代码如下：

@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("外滩如家", "brand","name","business"));
            // 3.发送请求
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            // 4.解析响应
            handleResponse(response);
        }

### 3.精确查询 ###

精确查询主要是两者：

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

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

查询条件构造的`API`如下：

![在这里插入图片描述][41e22e930f5142d982705670a60edce7.png_pic_center]

### 4.布尔查询 ###

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

![在这里插入图片描述][2035d02c8e404190af17214c3f10806a.png_pic_center]

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

完整代码如下：

@Test
        void testBool() throws IOException{
        
            //  1.准备Request
            SearchRequest request = new SearchRequest("hotel");
            // 2.准备DSL
            // 2.1.准备BooleanQuery
            BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
            // 2.2.添加term
            boolQuery.must(QueryBuilders.termQuery("city", "上海"));
            // 2.3.添加range
            boolQuery.filter(QueryBuilders.rangeQuery("price").lte(400));
    
            request.source().query(boolQuery);
            // 3.发送请求
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            // 4.解析响应
            handleResponse(response);
        }

### 5.排序、分页 ###

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

对应的`API`如下：

![在这里插入图片描述][e3ca67a9e64d4a26888fde7005c65f22.png_pic_center]

完整代码示例：

@Test
        void testPageAndSort() throws IOException{
        
            // 页码，每页大小
            int page = 1;
            int size = 5;
    
            // 1.准备Request
            SearchRequest request = new SearchRequest("hotel");
            // 2.准备DSL
            // 2.1.query
            request.source().query(QueryBuilders.matchAllQuery());
            // 2.2.排序 sort
            request.source().sort("price", SortOrder.ASC);
            // 2.3.分页 from、size
            request.source().from((page - 1) * size).size(5);
            // 3.发送请求
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            // 4.解析响应]
            handleResponse(response);
        }

### 6.高亮 ###

高亮的代码与之前代码差异较大，有两点：

*  查询的`DSL`：其中除了查询条件，还需要添加高亮条件，同样是与`query`同级。
 *  结果解析：结果除了要解析`_source`文档数据，还要解析高亮结果

#### 6.1.高亮请求构建 ####

高亮请求的构建`API`如下：

![在这里插入图片描述][2d760fb942ca4b5c8aec13b28b479094.png_pic_center]

上述代码省略了查询条件部分，但是大家不要忘了：高亮查询必须使用全文检索查询，并且要有搜索关键字，将来才可以对关键字高亮。

完整代码如下：

@Test
        void testHighlight() throws IOException {
        
            // 1.准备Request
            SearchRequest request = new SearchRequest("hotel");
            // 2.准备DSL
            // 2.1.query
            request.source().query(QueryBuilders.matchQuery("all", "如家"));
            // 2.2.高亮
            request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
            // 3.发送请求
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            // 4.解析响应
            handleResponse(response);
        }

#### 6.2.高亮结果解析 ####

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

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

![在这里插入图片描述][51ea182d64fc4d2980e465ec705d22bd.png_pic_center]

代码解读：

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

完整代码如下：

private void handleResponse(SearchResponse response){
        
            // 4.解析响应
            SearchHits searchHits = response.getHits();
            // 4.1.获取总条数
            long total = searchHits.getTotalHits().value;
            System.out.println("共搜索到" + total + "条数据");
            // 4.2.文档数组
            SearchHit[] hits = searchHits.getHits();
            // 4.3.遍历
            for (SearchHit hit : hits) {
        
                // 获取文档source
                String json = hit.getSourceAsString();
                // 反序列化
                HotelDoc hotelDoc = JSONObject.parseObject(json, HotelDoc.class);
                // 获取高亮结果
                Map<String, HighlightField> highlightFields = hit.getHighlightFields();
                if (!MapUtils.isEmpty(highlightFields)){
        
                    // 根据字段名获取高亮结果
                    HighlightField highlightField = highlightFields.get("name");
                    if (highlightField != null) {
        
                        // 获取高亮值
                        String name = highlightField.getFragments()[0].string();
                        // 覆盖非高亮结果
                        hotelDoc.setName(name);
                    }
                }
                System.out.println("hotelDoc = " + hotelDoc);
            }
        }

![在这里插入图片描述][6468090d4c2946b2908ba7f266fe8046.png_pic_center]

[38038e690a0d4601a6d78c37f9b13998.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/3cd3f583559b4611a258340ad04d3142.png
[6f44a3405edd4477a61049fc55df3a53.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/54b981ef67484f95aa5ef3952a3cff21.png
[3f79a42ebf964e5caa80c3c0964b77a3.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/aea20ec665f5459b8d877a5c8bbb082c.png
[4ce0c6bac5b2442198b6f04a8a0f7bdc.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/079a6656d9824f5894644df3afe33913.png
[9e6960f5c03541f594f0fda561f098ed.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/c49db5ac43784ad6b91f6519a2ce8ce9.png
[33ec990ab23e4e118bfe81f0eac849e5.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/102830e532ed4f9fa72cf6ffef84a8fa.png
[41e22e930f5142d982705670a60edce7.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/1cb778c5e3c8482ea06d4f0df29ddfb4.png
[2035d02c8e404190af17214c3f10806a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/7463c68143394421979568846ece33fe.png
[e3ca67a9e64d4a26888fde7005c65f22.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/7b5d7bbdce494b6a81dd5343386132d8.png
[2d760fb942ca4b5c8aec13b28b479094.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/97ca76edb7c84a7ab9ba64e3f97a9200.png
[51ea182d64fc4d2980e465ec705d22bd.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/61b8e7da4c514e70ba402f177cf05c38.png
[6468090d4c2946b2908ba7f266fe8046.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/889ba0da113442cc80febbef91c3bee3.png