Elastic-JavaApi SpringBoot布尔查询

- 日理万妓 2022-05-21 09:36 266阅读 0赞

> 最近在写Es的Java查询Api，发现从部署到Api没有很好的资料，所以整理记录一下，配置就不发了，直接分析代码和需求。

## Es复杂查询 ##

基于 `SpringBoot + EsTransportClient`

### 需求分析 ###

这个查询的需求是，满足中文分词 `与查询` 标题和描述（同时满足），也可以 `或查询` 多组条件拼出来的 `查询条件`（满足一个或多个） 。比如：查询：`同时满足黄色和好吃和产地为南京的水果` 或 `同时满足蓝色和难吃和产地为北京` 这样的组查询。 这些查询条件大概是这样的 `Json` :

[
        {"BULLETIN_TYPE_NAME":"xxx公示",
        "NOTICE_INDUSTRIES_NAME": "其他",
        "REGION_PROVINCE": "江苏xx" },
        {"BULLETIN_TYPE_NAME":"xxxx",
        "NOTICE_INDUSTRIES_NAME": "市政xx",
        "REGION_PROVINCE": "江苏xx",
        "REGION_NAME": "江苏省xxx" }
    ]

还要满足默认用某个字段进行排序、支持分页，返回所有和限制条件下的搜索数目，这里用布尔查询可以解决。

### 查询代码 ###

// 查询
        @RequestMapping(value = "Query", method = RequestMethod.POST)
        public ResponseEntity query(
                @RequestParam(name = "NOTICE_CONTENT", required = false) String NOTICE_CONTENT,
                @RequestParam(name = "NOTICE_NAME", required = false) String NOTICE_NAME,
                @RequestParam(name = "Index", required = true) String index,
                @RequestParam(name = "PageSize", required = false, defaultValue = "20") int PageSize,
                @RequestParam(name = "CurrentPage", required = false, defaultValue = "1") int CurrentPage,
                @RequestParam(name = "Type", required = true) String type,
                @RequestParam(name = "BoolQueryJson", required = true) String BoolQueryJson) {
    
    
            BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    
            if (NOTICE_NAME != null) {
                boolQuery.must(QueryBuilders.matchQuery("NOTICE_NAME", NOTICE_NAME));
            }
    
            if (NOTICE_CONTENT != null) {
                boolQuery.must(QueryBuilders.matchQuery("NOTICE_CONTENT", NOTICE_CONTENT));
            }
    
    
            JSONArray jsonArray = JSONArray.fromObject(BoolQueryJson);
    
            if (jsonArray != null && jsonArray.size() > 0) {
                for (int i = 0; i < jsonArray.size(); i++) { 
                    int j = 0;
                    BoolQueryBuilder boolQueryParam = QueryBuilders.boolQuery();
    
                    if (jsonArray.getJSONObject(i).has("BULLETIN_TYPE_NAME")) {
                        String BULLETIN_TYPE_NAMEI = jsonArray.getJSONObject(i).getString("BULLETIN_TYPE_NAME");
                        MatchPhraseQueryBuilder BULLETIN_TYPE_NAMEMP = QueryBuilders.matchPhraseQuery("BULLETIN_TYPE_NAME", BULLETIN_TYPE_NAMEI);
                        boolQueryParam.should(BULLETIN_TYPE_NAMEMP);
                        j++;
                    }
    
                    if (jsonArray.getJSONObject(i).has("NOTICE_INDUSTRIES_NAME")) {
                        String NOTICE_INDUSTRIES_NAMEI = jsonArray.getJSONObject(i).getString("NOTICE_INDUSTRIES_NAME");
                        MatchPhraseQueryBuilder NOTICE_INDUSTRIES_NAMEMP = QueryBuilders.matchPhraseQuery("NOTICE_INDUSTRIES_NAME", NOTICE_INDUSTRIES_NAMEI);
                        boolQueryParam.should(NOTICE_INDUSTRIES_NAMEMP);
                        j++;
                    }
    
                    if (jsonArray.getJSONObject(i).has("REGION_PROVINCE")) {
                        String REGION_PROVINCEI = jsonArray.getJSONObject(i).getString("REGION_PROVINCE");
                        MatchPhraseQueryBuilder REGION_PROVINCEMP = QueryBuilders.matchPhraseQuery("REGION_PROVINCE", REGION_PROVINCEI);
                        boolQueryParam.should(REGION_PROVINCEMP);
                        j++;
                    }
    
                    if (jsonArray.getJSONObject(i).has("REGION_NAME")) {
                        String REGION_NAMEI = jsonArray.getJSONObject(i).getString("REGION_NAME");
                        MatchPhraseQueryBuilder REGION_NAMEMP = QueryBuilders.matchPhraseQuery("REGION_NAME", REGION_NAMEI);
                        boolQueryParam.should(REGION_NAMEMP);
                        j++;
                    }
    
                    if (jsonArray.getJSONObject(i).has("TRADE_PLAT")) {
                        String TRADE_PLATI = jsonArray.getJSONObject(i).getString("TRADE_PLAT");
                        MatchPhraseQueryBuilder TRADE_PLATMP = QueryBuilders.matchPhraseQuery("TRADE_PLAT", TRADE_PLATI);
                        boolQueryParam.should(TRADE_PLATMP);
                        j++;
                    }
                    boolQueryParam.minimumShouldMatch(j);
                    boolQuery.should(boolQueryParam);
                }
                boolQuery.minimumShouldMatch(1);
            }
    
            SearchRequestBuilder builder = this.client.prepareSearch(index)
                    .setTypes(type)
                    .setSearchType(SearchType.DFS_QUERY_THEN_FETCH)
                     .setFetchSource(null,new String[]{
       "NOTICE_CONTENT"})
                    .setQuery(boolQuery)
                    .addSort("NOTICE_SEND_TIME", SortOrder.DESC)
                    .setFrom((CurrentPage - 1) * PageSize)
                    .setSize(PageSize);
    
            SearchResponse response = builder.get();
            List<Map<String, Object>> result = new ArrayList<Map<String, Object>>();
    
            int sum = 0;
            for (SearchHit hit : response.getHits()) {
                result.add(hit.getSource());
                // 限制条件内的总数
                sum++;
            }
    
            // 所有文档查询的总数
            SearchHits searchHits = response.getHits();
            long AllSum = searchHits.getTotalHits();
    
            return new ResponseEntity(result, HttpStatus.OK);
    
        }

### DSL 结构 ###

生成的 ES DSL 查询 结构

{
      "from" : 0,
      "size" : 10,
      "query" : { "bool" : { "must" : [ { "match" : { "NOTICE_NAME" : { "query" : "中国石油", "operator" : "OR", "prefix_length" : 0, "max_expansions" : 50, "fuzzy_transpositions" : true, "lenient" : false, "zero_terms_query" : "NONE", "boost" : 1.0 } } }, { "match" : { "NOTICE_CONTENT" : { "query" : "中国石油", "operator" : "OR", "prefix_length" : 0, "max_expansions" : 50, "fuzzy_transpositions" : true, "lenient" : false, "zero_terms_query" : "NONE", "boost" : 1.0 } } } ], "should" : [ { "bool" : { "should" : [ { "match_phrase" : { "BULLETIN_TYPE_NAME" : { "query" : "中标候选人公示", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "NOTICE_INDUSTRIES_NAME" : { "query" : "其他", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "REGION_PROVINCE" : { "query" : "江苏", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "REGION_NAME" : { "query" : "江苏省", "slop" : 0, "boost" : 1.0 } } } ], "disable_coord" : false, "adjust_pure_negative" : true, "minimum_should_match" : "4", "boost" : 1.0 } }, { "bool" : { "should" : [ { "match_phrase" : { "BULLETIN_TYPE_NAME" : { "query" : "招标公告", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "NOTICE_INDUSTRIES_NAME" : { "query" : "市政", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "REGION_PROVINCE" : { "query" : "江苏", "slop" : 0, "boost" : 1.0 } } }, { "match_phrase" : { "REGION_NAME" : { "query" : "江苏省,南京市", "slop" : 0, "boost" : 1.0 } } } ], "disable_coord" : false, "adjust_pure_negative" : true, "minimum_should_match" : "4", "boost" : 1.0 } } ], "disable_coord" : false, "adjust_pure_negative" : true, "minimum_should_match" : "1", "boost" : 1.0 } },
      "stored_fields" : "NOTICE_SEND_TIME",
      "sort" : [ { "NOTICE_SEND_TIME" : { "order" : "desc" } } ] }

### Es客户端Bean Config ###

@Configuration
    public class MyConfig { 
    
        @Bean
        public TransportClient client() throws UnknownHostException {
            InetSocketTransportAddress node = new InetSocketTransportAddress(
                    InetAddress.getByName("192.168.1.21"),
                    9300
            );
    
            Settings settings = Settings.builder()
                    .put("cluster.name","leon")
                    .build();
    
            TransportClient client = new PreBuiltTransportClient(settings);
            client.addTransportAddress(node);
            return client;
        }
    }

### 查询结果 ###

![这里写图片描述][70]

## 总结 ##

1.  注意引入的 `jar` 包版本一致性
2.  多个条件一起拼凑组成了 一个 `should` ，嵌套构成了 `bool` 查询，要注意循环的顺序，即：添加到外层的时机。  
    比如 `if` 中的

boolQueryParam.should(REGION_NAMEMP);
    boolQuery.should(boolQueryParam);

如果我合并写成

boolQuery.should(boolQueryParam.should(REGION_NAMEMP));

构造的 `builder` 就会出现8个should ，显然不是我要的结果  
3. 如果熟悉 `Es` ，以前用过 `Kirbna` 查询结果和预期不一致，可以打印 `builder` 通过查看 `Es` 生成的 Json 查询体来查错。  
4. `searchHits.getTotalHits();` 并不等于 `response.getHits()` 的 数目  
5. `.setFetchSource(null,new String[]{"NOTICE_CONTENT"})` 设置不反回某个字段，当然`inclunde`部分可以设置返回，具体参考 `SearchRequestBuilder` 方法，可以指定 `inclunde` 和 `exclude` 。

[70]: /images/20220521/c26cf2b85f594db0a0e7e7deaf8242f4.png