【ElasticSearch】JavaRestClient实现文档查询、排序、分页、高亮

男娘i 2023-10-13 13:13 95阅读 0赞

#### 文章目录 ####

*  1、入门案例
 *  2、全文检索
 *  3、精确查询
 *  4、复合查询-boolean query
 *  5、排序和分页
 *  6、高亮

## 1、入门案例 ##

先初始化JavaRestClient对象：

@SpringBootTest
    public class HotelSearchTest {
        
    
        private RestHighLevelClient client;
    
        @Test
        void testInit() {
        
    
            System.out.println(client);
        }
    
        @BeforeEach
        void setUp() {
        
            this.client = new RestHighLevelClient(RestClient.builder(
                    HttpHost.create("http://10.4.130.220:9200")
            ));
        }
    
        @AfterEach
        void tearDown() throws IOException {
        
            this.client.close();
        }
    }

用match_all来演示基本的API使用：

代码和DSL对应上就是：

![在这里插入图片描述][67a430e4b4244a9a9233186c3f0fb3cf.png]

运行结果：

![在这里插入图片描述][9333f0ff32d741ddb274b3132fd6d079.png]

然后是对结果的解析，对照响应结果：

![在这里插入图片描述][0e3a352e9e044f6ca9722b9a4ba8e3ab.png]

示例代码：

@Test
    void testMatchAll() throws IOException {
        
        SearchRequest request = new SearchRequest("hotel");
        request.source()
                .query(QueryBuilders.matchAllQuery());
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        SearchHits searchHits = response.getHits();
        long total = searchHits.getTotalHits().value;
        SearchHit[] hits = searchHits.getHits();
        for (SearchHit hit : hits) {
        
            String json = hit.getSourceAsString();
            HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
            System.out.println(hotelDoc);
        }
    }

运行结果：

![在这里插入图片描述][9dddc6bc2e714fa89e24c8cefa3a9f74.png]

总结：

*  构建DSL是通过HighLevelRestClient中的resource()方法来实现的，这里包含了查询、排序、分页、高亮等操作  
    ![在这里插入图片描述][349dfb9692df4beb980777b0cbf26b63.png]
 *  构建查询条件的核心部分，即查询类型，是用一个名为`QueryBuilders的工具类`实现的，它包含了各种查询方法  
    ![在这里插入图片描述][2247dc53fc724be8aab772770c669e39.png]
 *  查询的基本步骤总结：  
    ![在这里插入图片描述][9f6fe82ad20d4919acd8c30d94663be7.png]

## 2、全文检索 ##

和match\_all一样，不同的是在QueryBuildes工具类中选的方法不同：

// 单字段查询
    QueryBuilders.matchQuery("all", "如家");
    // 多字段查询
    QueryBuilders.multiMatchQuery("如家", "name", "business");

对比下DSL语句：  
![在这里插入图片描述][fa05c5e990a6488fa0441ca387ac18fe.png]

@Test
    void testMatch() throws IOException {
        
        SearchRequest request = new SearchRequest("hotel");
        request.source()
                .query(QueryBuilders.matchQuery("all", "如家"));
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        handleResponse(response);//对响应的处理代码相同，做抽取
    }
    
    private void handleResponse(SearchResponse response) {
        
        SearchHits searchHits = response.getHits();
        long total = searchHits.getTotalHits().value;
        SearchHit[] hits = searchHits.getHits();
        for (SearchHit hit : hits) {
        
            String json = hit.getSourceAsString();
            HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
            System.out.println(hotelDoc);
        }
    }

对响应的处理代码相同，这里做个抽取，Ctrl + Alt +M（没用的话Ctrl + Alt + Shift + T，再选Extract Method）， 再不行就Settings -> Keymap来打开快捷键设置对话框

![在这里插入图片描述][eef0a590ce364f96b1a4eed954b04762.png]

运行：

![在这里插入图片描述][6c5e8dc2ab584ad486f2c1b53d2054b2.png]

## 3、精确查询 ##

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

// 词条查询
    QueryBuilders.termQuery("city", "杭州"); 
    // 范围查询
    QueryBuilders.rangeQuery("price").gte(100).lte(150);

与DSL对比：

![在这里插入图片描述][1c2a73dc425d47218c25d8a8983b64ee.png]

@Test
    void testRangeQuery() throws IOException {
        
        SearchRequest request = new SearchRequest("hotel");
        request.source()
                .query(QueryBuilders.rangeQuery("price").gte(100).lte(300));
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        handleResponse(response);
    }

运行：

![在这里插入图片描述][8b165b50d63342ffb1ed0a022b5aeb59.png]

## 4、复合查询-boolean query ##

// 创建布尔查询
    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    // 添加must条件
    boolQuery.must(QueryBuilders.termQuery("city", "杭州")); 
    // 添加filter条件
    boolQuery.filter(QueryBuilders.rangeQuery("price").lte(250));

和DSL的对比：

![在这里插入图片描述][bfb074898159430c909b3327db97e441.png]

@Test
    void testBooleanQuery() throws IOException {
        
        //准备Request
        SearchRequest request = new SearchRequest("hotel");
        //准备DSL
        //2.1 准备BooleanQuery
        BoolQueryBuilder booleanQuery = QueryBuilders.boolQuery();
        //2.2 添加term，用must
        booleanQuery.must(QueryBuilders.termQuery("city", "上海"));
        //2.3 添加range，用filter
        booleanQuery.filter(QueryBuilders.rangeQuery("price").gt(100));  //大于300，lt是小于，less than
        //2.4 测试下mustNot
        booleanQuery.mustNot(QueryBuilders.rangeQuery("price").gte(500)); //大于等于500取反，小于500
        //2.5 玩玩should，或
        booleanQuery.should(QueryBuilders.termQuery("name", "北京宝辰饭店"));
        request.source().query(booleanQuery);
        //3.发送请求
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        //4.调用上面抽取的方法解析响应
        handleResponse(response);
    }

运行：

![在这里插入图片描述][426f1eb283144cb0958289919d134927.png]

## 5、排序和分页 ##

// 查询
    request.source().query(QueryBuilders.matchAllQuery());
    // 分页
    request.source().from(0).size(5);
    // 价格排序
    request.source().sort("price", SortOrder.ASC);

和DSL的对应关系：

![在这里插入图片描述][15a36288f5174cadb124f6d4d14effb5.png]

//pageNum和pageSize从前端Dto获取，
    //则起点为(pageNum-1)*pageSize
    
    request.source().from((pageNum - 1)*pageSize).size(pageSize);

@Test
    void testPage() throws IOException {
        
        int pageNum = 2;
        int pageSize = 3;
        SearchRequest request = new SearchRequest("hotel");
        request.source()
                .query(QueryBuilders.matchQuery("name", "如家"));
        request.source().from((pageNum - 1) * pageSize).size(pageSize);
        request.source().sort("price", SortOrder.ASC);
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        handleResponse(response);
    }

运行：

![在这里插入图片描述][2d60fce1048243e582fe492414f70cb2.png]

## 6、高亮 ##

高亮API包括请求DSL构建和结果解析两部分，DSL构建为：

request.source().highlighter(new HighlightBuilder()        
    		.field("name")        
    		// 是否需要与查询字段匹配
           .requireFieldMatch(false)
    );

![在这里插入图片描述][9b0cb5cd95854ebeb7851abadab7a2c9.png]  
不用默认标签的话也可以，继续链式编程，后面调postTags()等方法即可。

发现结果并未高亮，因为上面抽取的handleResponse方法是对\_source下处理的，这里的数据是原数据，本就不会被修改，因此要继续拿highlight下的数据，即解析高亮结果

![在这里插入图片描述][d0839d4274494ea99022a2caa01980db.png]

@Test
    void testHighLighter() throws IOException {
        
        SearchRequest request = new SearchRequest("hotel");
        request.source()
                .query(QueryBuilders.matchQuery("all","如家"))
                .highlighter(new HighlightBuilder().field("name")
                        .requireFieldMatch(false)
                        .preTags("<strong>")
                        .postTags("</strong")
                );
        SearchResponse response = client.search(request,RequestOptions.DEFAULT);
        SearchHits searchHits = response.getHits();
        SearchHit[] hits = searchHits.getHits();
        for(SearchHit hit : hits){
        
            String hotelDocString = hit.getSourceAsString();
            HotelDoc hotelDoc = JSON.parseObject(hotelDocString,HotelDoc.class);
            Map<String, HighlightField> highlightFieldMap = hit.getHighlightFields();
            if(! CollectionUtils.isEmpty(highlightFieldMap)){
        
                HighlightField highlightField = highlightFieldMap.get("name");
                if(highlightField != null){
        
                    String name = highlightField.getFragments()[0].string();
                    hotelDoc.setName(name);
                    System.out.println(hotelDoc);
                }
            }
        }
    }

运行：

![在这里插入图片描述][882c76c21cdb4239b416eed9206c27b8.png]

[67a430e4b4244a9a9233186c3f0fb3cf.png]: https://img-blog.csdnimg.cn/67a430e4b4244a9a9233186c3f0fb3cf.png
[9333f0ff32d741ddb274b3132fd6d079.png]: https://img-blog.csdnimg.cn/9333f0ff32d741ddb274b3132fd6d079.png
[0e3a352e9e044f6ca9722b9a4ba8e3ab.png]: https://img-blog.csdnimg.cn/0e3a352e9e044f6ca9722b9a4ba8e3ab.png
[9dddc6bc2e714fa89e24c8cefa3a9f74.png]: https://img-blog.csdnimg.cn/9dddc6bc2e714fa89e24c8cefa3a9f74.png
[349dfb9692df4beb980777b0cbf26b63.png]: https://img-blog.csdnimg.cn/349dfb9692df4beb980777b0cbf26b63.png
[2247dc53fc724be8aab772770c669e39.png]: https://img-blog.csdnimg.cn/2247dc53fc724be8aab772770c669e39.png
[9f6fe82ad20d4919acd8c30d94663be7.png]: https://img-blog.csdnimg.cn/9f6fe82ad20d4919acd8c30d94663be7.png
[fa05c5e990a6488fa0441ca387ac18fe.png]: https://img-blog.csdnimg.cn/fa05c5e990a6488fa0441ca387ac18fe.png
[eef0a590ce364f96b1a4eed954b04762.png]: https://img-blog.csdnimg.cn/eef0a590ce364f96b1a4eed954b04762.png
[6c5e8dc2ab584ad486f2c1b53d2054b2.png]: https://img-blog.csdnimg.cn/6c5e8dc2ab584ad486f2c1b53d2054b2.png
[1c2a73dc425d47218c25d8a8983b64ee.png]: https://img-blog.csdnimg.cn/1c2a73dc425d47218c25d8a8983b64ee.png
[8b165b50d63342ffb1ed0a022b5aeb59.png]: https://img-blog.csdnimg.cn/8b165b50d63342ffb1ed0a022b5aeb59.png
[bfb074898159430c909b3327db97e441.png]: https://img-blog.csdnimg.cn/bfb074898159430c909b3327db97e441.png
[426f1eb283144cb0958289919d134927.png]: https://img-blog.csdnimg.cn/426f1eb283144cb0958289919d134927.png
[15a36288f5174cadb124f6d4d14effb5.png]: https://img-blog.csdnimg.cn/15a36288f5174cadb124f6d4d14effb5.png
[2d60fce1048243e582fe492414f70cb2.png]: https://img-blog.csdnimg.cn/2d60fce1048243e582fe492414f70cb2.png
[9b0cb5cd95854ebeb7851abadab7a2c9.png]: https://img-blog.csdnimg.cn/9b0cb5cd95854ebeb7851abadab7a2c9.png
[d0839d4274494ea99022a2caa01980db.png]: https://img-blog.csdnimg.cn/d0839d4274494ea99022a2caa01980db.png
[882c76c21cdb4239b416eed9206c27b8.png]: https://img-blog.csdnimg.cn/882c76c21cdb4239b416eed9206c27b8.png