ElasticSearch - 基于 JavaRestClient 查询文档（match、精确、复合查询，以及排序、分页、高亮）

女爷i 2024-02-29 07:42 14阅读 0赞

**目录**

一、基于 JavaRestClient 查询文档

1.1、查询 API 演示

1.1.1、查询基本框架

DSL 请求的对应格式

响应的解析

1.1.2、全文检索查询

1.1.3、精确查询

1.1.4、复合查询

1.1.5、排序和分页

1.1.6、高亮

--------------------

## 一、基于 JavaRestClient 查询文档 ##

--------------------

### 1.1、查询 API 演示 ###

#### 1.1.1、查询基本框架 ####

接下里通过一个 match\_all 查询所有，来演示以下基本的 API.

@Test
        public void testMatchAll() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.matchAllQuery());
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }
    
        /**
         * 处理响应
         * @param response
         */
        private void handlerResponse(SearchResponse response) {
            //1.解析结果
            SearchHits hits = response.getHits();
            //获取总条数
            long total = hits.getTotalHits().value;
            SearchHit[] hits1 = hits.getHits();
            for(SearchHit searchHit : hits1) {
                //获取source
                String json = searchHit.getSourceAsString();
                System.out.println(json);
            }
        }

由上可以看出查询的基本步骤如下：

1.  创建 SeaechRequest 对象，指定索引库.
2.  Request.source() 准备参数，也就是 DSL.
    
    1.  通过 QueryBuilders 构建查询条件.
    2.  传入 Request.source() 的 query() 方法，构建好完整的查询.
3.  发送请求，得到结果.
4.  解析结果（又外而内，逐层解析）.

##### DSL 请求的对应格式 #####

![dcc8dd3b095f4050bb24ef922a50553b.png][]

DSL 语句的构建是通过 HighLevelRestClient 中的 Resource 实现的，其中包含了 查询、排序】分页、高亮等所有功能.

![722459d221664f658a167fe5541e5e29.png][]

其中 query 表示查询的意思，他的查询条件的是由 QueryBuilders 的工具类提供的，包含了各种查询方法.

![75872e915df641829edf650ca2b28d6c.png][]

##### 响应的解析 #####

![91d6ef4d51df4c1a9bd2a00d6098cf74.png][]

响应解析这里，可以在 Kibana 上通过查询结果，对比着看出 API 的调用关系.

#### 1.1.2、全文检索查询 ####

全文检索的 match 和 multi\_match 查询和前面演示的 match\_all 调用的 API 基本一致，差别就是查询条件，也就是 query 部分（通过 QueryBuilders 构建的条件不一样）.

@Test
        public void testMatch() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.matchQuery("brand", "如家"));
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![6db349445f094246be98a79701f73776.png][]

multi\_match 也是如此，只是可以支持多个参数查询.

@Test
        public void testMultiMatch() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.multiMatchQuery("如家", "brand", "name"));
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![5dd0a2d022714ad29d190b0a525c0721.png][]

运行结果：

![a299f1fa64f34d8384d63d8d74034342.png][]

#### 1.1.3、精确查询 ####

精确查询常见的有 term 查询 和 range 查询，同样利用 QueryBuilders 实现.

@Test
        public void testTerm() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.termQuery("city", "上海"));
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![b5e1b623e8084ab1899cd2e4547d6370.png][]

range 查询也是如此.

@Test
        public void testRange() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.rangeQuery("price").gte(100).lte(200)); //链式调用
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![977413cc2741492d8f0f8c7b03f25f07.png][]

#### 1.1.4、复合查询 ####

布尔查询是一个或多个查询子句的组合. 子查询的组合方式有：

*  must：必须匹配的查询条件，类似 “与”.
 *  should：选择性匹配的查询条件，类似 “或”.
 *  must\_not：必须不匹配，不参与算分，类似 “非”.
 *  filter：必须匹配，不参与算分

RestAPI 中也提供 BoolQueryBuilder 条件构建方法，用来添加上述条件.

@Test
        public void testBoolQuery() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            BoolQueryBuilder booleanQuery = QueryBuilders.boolQuery();
            booleanQuery.must(QueryBuilders.termQuery("city", "上海"));
            booleanQuery.filter(QueryBuilders.rangeQuery("price").lte("200"));
            request.source().query(booleanQuery); //链式调用
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![73e0bd1c437142dcaf6bdfd019c477be.png][]

#### 1.1.5、排序和分页 ####

对于搜索结果的排序和分页与 query 是同级参数，对应 API 如下.

@Test
        public void testFromSize() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.matchAllQuery());
            //分页 offset=20 size=10
            request.source().from(20).size(10);
            //降序排序
            request.source().sort("price", SortOrder.DESC);
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![daadf8441f7541a6be6686cfe7cd0391.png][]

#### 1.1.6、高亮 ####

高亮的 API 包括请求构建 DSL 语句 和 结果解析 两个部分.

请求构建如下：

@Test
        public void testHighLighter() throws IOException {
            //1.准备 SearchRequest
            SearchRequest request = new SearchRequest("hotel");
            //2.准备参数
            request.source().query(QueryBuilders.matchQuery("brand", "如家"));
            request.source().highlighter(new HighlightBuilder()
                    .field("name")
                    .requireFieldMatch(false));
            //3.发送请求，并接收响应
            SearchResponse response = client.search(request, RequestOptions.DEFAULT);
            //4.解析响应
            handlerResponse(response);
        }

![deb647969493431a89176f1c819795d7.png][]

响应解析如下 ：

private void handlerResponse(SearchResponse response) throws JsonProcessingException {
            //1.解析结果
            SearchHits hits = response.getHits();
            //获取总条数
            long total = hits.getTotalHits().value;
            SearchHit[] hits1 = hits.getHits();
            for(SearchHit searchHit : hits1) {
                //获取source
                String json = searchHit.getSourceAsString();
                System.out.println(json);
                //2.处理高亮
                //获取高亮
                Map<String, HighlightField> highlightFieldMap = searchHit.getHighlightFields();
                if(!CollectionUtils.isEmpty(highlightFieldMap)) {
                    //获取高亮字段的 value
                    HighlightField highlightField = highlightFieldMap.get("name");
                    if(highlightField != null) {
                        //取出高亮结果数组中的第一个，这里是酒店名称
                        String name = highlightField.getFragments()[0].string();
                        //对高亮字段的处理(这里打印做演示)
                        System.out.println(name);
                    }
                }
            }
        }

![9b1c83ebc0f542e38ee77735c540ef95.png][]

运行后可以看到通过 sout 打印出的“高亮”字段（最后会传输给前端 ，让前端处理高亮. 后端只是标记出了哪些字段需要高亮处理）

![bf4f8ec2e2d94ec9ad4b37c619b6fb5f.png][]

![5bae5293e50141afa9c117f53f010e87.gif][]

[dcc8dd3b095f4050bb24ef922a50553b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/b3bf46135ff84ccdbb8234efdfc63c3d.png
[722459d221664f658a167fe5541e5e29.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/dbc9146516514c4ebedaa75c76a40adb.png
[75872e915df641829edf650ca2b28d6c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/5da6084c8c8b48a59cadf6d07848f98c.png
[91d6ef4d51df4c1a9bd2a00d6098cf74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/65576bceecf24c9ba69149338d8bed43.png
[6db349445f094246be98a79701f73776.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/06f809d6dbf6431f8868c97cd0d2f3b9.png
[5dd0a2d022714ad29d190b0a525c0721.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/e234bb33292b4601b8910280e1923fbd.png
[a299f1fa64f34d8384d63d8d74034342.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/f6b5efc9275941a986911a37aaa5eaaa.png
[b5e1b623e8084ab1899cd2e4547d6370.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/971084776fba4c9a9e9357db0d2779c1.png
[977413cc2741492d8f0f8c7b03f25f07.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/ab577ab2d62849fbabfb1821d5a8638d.png
[73e0bd1c437142dcaf6bdfd019c477be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/bcaa66694bdd4d5e87911f26895258b9.png
[daadf8441f7541a6be6686cfe7cd0391.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/6201f7792e48489bacfc1cc9be61b559.png
[deb647969493431a89176f1c819795d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/454b965fb6314e30a142d74835f44f1e.png
[9b1c83ebc0f542e38ee77735c540ef95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/403943655ab24c45a473a6ef33348395.png
[bf4f8ec2e2d94ec9ad4b37c619b6fb5f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/6d53b368b445480fa7181ea44df94fcf.png
[5bae5293e50141afa9c117f53f010e87.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/29/6d9c497931204a8d8935cb9c52859063.png