• ElasticSearch(二)


    1.DSL查询文档

    elasticsearch的查询依然是基于JSON风格的DSL来实现的。

    1.1.DSL查询分类

    Elasticsearch提供了基于JSON的DSL(Domain Specific Language)来定义查询。常见的查询类型包括:

    查询所有:查询出所有数据,一般测试用。例如:match_all

    全文检索(full text)查询:利用分词器对用户输入内容分词,然后去倒排索引库中匹配。例如:

    • match_query

    • multi_match_query

    精确查询:根据精确词条值查找数据,一般是查找keyword、数值、日期、boolean等类型字段。例如:

    • ids

    • range

    • term

    地理(geo)查询:根据经纬度查询。例如:

    • geo_distance

    • geo_bounding_box

    复合(compound)查询:复合查询可以将上述各种查询条件组合起来,合并查询条件。例如:

    • bool

    • function_score

    查询的语法基本一致:

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "查询类型": {
    5.       "查询条件": "条件值"
    6.     }
    7.   }
    8. }

    我们以查询所有为例,其中:

    • 查询类型为match_all

    • 没有查询条件

    1. // 查询所有
    2. GET /indexName/_search
    3. {
    4.   "query": {
    5.     "match_all": {
    6.   }
    7.   }
    8. }

    其它查询无非就是查询类型查询条件的变化。

    1.2.全文检索查询

    1.使用场景

    全文检索查询的基本流程如下:

    • 对用户搜索的内容做分词,得到词条

    • 根据词条去倒排索引库中匹配,得到文档id

    • 根据文档id找到文档,返回给用户

    比较常用的场景包括:

    • 商城的输入框搜索

    • 百度输入框搜索

    例如京东:

    因为是拿着词条去匹配,因此参与搜索的字段也必须是可分词的text类型的字段。

    2.基本语法

    常见的全文检索查询包括:

    • match查询:单字段查询

    • multi_match查询:多字段查询,任意一个字段符合条件就算符合查询条件

    match查询语法如下:

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "match": {
    5.       "FIELD": "TEXT"
    6.     }
    7.   }
    8. }

    mulit_match语法如下:

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "multi_match": {
    5.       "query": "TEXT",
    6.       "fields": ["FIELD1", " FIELD12"]
    7.     }
    8.   }
    9. }

    3.示例

    match查询示例:

    multi_match查询示例:

    可以看到,两种查询结果是一样的,为什么?

    因为我们将brand、name、business值都利用 copy_to 复制到了 all 字段中。因此你根据三个字段搜索,和根据all字段搜索效果当然一样了。

    但是,搜索字段越多,对查询性能影响越大,因此建议采用 copy_to,然后单字段查询的方式。

    1.3.精准查询

    精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有:

    • term:根据词条精确值查询

    • range:根据值的范围查询

    1.3.1.term查询

    因为精确查询的字段搜是不分词的字段,因此查询的条件也必须是不分词的词条。查询时,用户输入的内容跟自动值完全匹配时才认为符合条件。如果用户输入的内容过多,反而搜索不到数据。

    语法说明:

    1. // term查询
    2. GET /indexName/_search
    3. {
    4.   "query": {
    5.     "term": {
    6.       "FIELD": {
    7.         "value": "VALUE"
    8.       }
    9.     }
    10.   }
    11. }

    示例:

    当我搜索的是精确词条时,能正确查询出结果:

    但是,当我搜索的内容不是词条,而是多个词语形成的短语时,反而搜索不到:

    1.3.2.range查询

    范围查询,一般应用在对数值类型做范围过滤的时候。比如做价格范围过滤。

    基本语法:

    1. // range查询
    2. GET /indexName/_search
    3. {
    4.   "query": {
    5.     "range": {
    6.       "FIELD": {
    7.         "gte": 10, // 这里的gte代表大于等于,gt则代表大于
    8.         "lte": 20 // lte代表小于等于,lt则代表小于
    9.       }
    10.     }
    11.   }
    12. }

    示例:

    1.4.地理坐标查询

    所谓的地理坐标查询,其实就是根据经纬度查询,官方文档:Geo queries | Elasticsearch Guide [8.10] | Elastic

    常见的使用场景包括:

    • 携程:搜索我附近的酒店

    • 滴滴:搜索我附近的出租车

    • 微信:搜索我附近的人

    附近的酒店:

    附近的车:

    1.4.1.矩形范围查询

    矩形范围查询,也就是geo_bounding_box查询,查询坐标落在某个矩形范围的所有文档:

    查询时,需要指定矩形的左上右下两个点的坐标,然后画出一个矩形,落在该矩形内的都是符合条件的点。

    语法如下:

    1. // geo_bounding_box查询
    2. GET /indexName/_search
    3. {
    4.   "query": {
    5.     "geo_bounding_box": {
    6.       "FIELD": {
    7.         "top_left": { // 左上点
    8.           "lat": 31.1,
    9.           "lon": 121.5
    10.         },
    11.         "bottom_right": { // 右下点
    12.           "lat": 30.9,
    13.           "lon": 121.7
    14.         }
    15.       }
    16.     }
    17.   }
    18. }

    这种并不符合“附近的人”这样的需求,所以我们就不做了。

    1.4.2.附近查询

    附近查询,也叫做距离查询(geo_distance):查询到指定中心点小于某个距离值的所有文档。

    换句话来说,在地图上找一个点作为圆心,以指定距离为半径,画一个圆,落在圆内的坐标都算符合条件:

    语法说明:

    1. // geo_distance 查询
    2. GET /indexName/_search
    3. {
    4.   "query": {
    5.     "geo_distance": {
    6.       "distance": "15km", // 半径
    7.       "FIELD": "31.21,121.5" // 圆心
    8.     }
    9.   }
    10. }

    示例:

    我们先搜索陆家嘴附近15km的酒店:

    发现共有47家酒店。然后把半径缩短到3公里:

    可以发现,搜索到的酒店数量减少到了5家。

    1.5.复合查询

    复合(compound)查询:复合查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种:

    • fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名

    • bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索

    1.5.1.相关性算分

    当我们利用match查询时,文档结果会根据与搜索词条的关联度打分(_score),返回结果时按照分值降序排列。例如,我们搜索 "虹桥如家",结果如下:

    1. [
    2.   {
    3.     "_score" : 17.850193,
    4.     "_source" : {
    5.       "name" : "虹桥如家酒店真不错",
    6.     }
    7.   },
    8.   {
    9.     "_score" : 12.259849,
    10.     "_source" : {
    11.       "name" : "外滩如家酒店真不错",
    12.     }
    13.   },
    14.   {
    15.     "_score" : 11.91091,
    16.     "_source" : {
    17.       "name" : "迪士尼如家酒店真不错",
    18.     }
    19.   }
    20. ]

    在elasticsearch中,早期使用的打分算法是TF-IDF算法,公式如下:

    在后来的5.1版本升级中,elasticsearch将算法改进为BM25算法,公式如下:

    TF-IDF算法有一各缺陷,就是词条频率越高,文档得分也会越高,单个词条对文档影响较大。而BM25则会让单个词条的算分有一个上限,曲线更加平滑:

    1.5.2.算分函数查询

    根据相关度打分是比较合理的需求,但合理的不一定是产品经理需要的。

    以百度为例,你搜索的结果中,并不是相关度越高排名越靠前,而是谁掏的钱多排名就越靠前。如图:

    要想认为控制相关性算分,就需要利用 elasticsearch 中的 function score 查询了。

    1)语法说明

    function score 查询中包含四部分内容:

    原始查询条件:query部分,基于这个条件搜索文档,并且基于BM25算法给文档打分,原始算分(query score)

    过滤条件:filter部分,符合该条件的文档才会重新算分

    算分函数:符合filter条件的文档要根据这个函数做运算,得到的函数算分(function score),有四种函数

    • weight:函数结果是常量

    • field_value_factor:以文档中的某个字段值作为函数结果

    • random_score:以随机数作为函数结果

    • script_score:自定义算分函数算法

    运算模式:算分函数的结果、原始查询的相关性算分,两者之间的运算方式,包括:

    • multiply:相乘

    • replace:用function score替换query score

    • 其它,例如:sum、avg、max、min

    function score的运行流程如下:

    • 1)根据原始条件查询搜索文档,并且计算相关性算分,称为原始算分(query score)

    • 2)根据过滤条件,过滤文档

    • 3)符合过滤条件的文档,基于算分函数运算,得到函数算分(function score)

    • 4)将原始算分(query score)和函数算分(function score)基于运算模式做运算,得到最终结果,作为相关性算分。

    因此,其中的关键点是:

    • 过滤条件:决定哪些文档的算分被修改

    • 算分函数:决定函数算分的算法

    • 运算模式:决定最终算分结果

    2)示例

    需求:给“如家”这个品牌的酒店排名靠前一些

    翻译一下这个需求,转换为之前说的四个要点:

    • 原始条件:不确定,可以任意变化

    • 过滤条件:brand = "如家"

    • 算分函数:可以简单粗暴,直接给固定的算分结果,weight

    • 运算模式:比如求和

    因此最终的DSL语句如下:

    1. GET /hotel/_search
    2. {
    3.   "query": {
    4.     "function_score": {
    5.       "query": {  .... }, // 原始查询,可以是任意条件
    6.       "functions": [ // 算分函数
    7.         {
    8.           "filter": { // 满足的条件,品牌必须是如家
    9.             "term": {
    10.               "brand": "如家"
    11.             }
    12.           },
    13.           "weight": 2 // 算分权重为2
    14.         }
    15.       ],
    16.      "boost_mode": "sum" // 加权模式,求和
    17.     }
    18.   }
    19. }

    测试,在未添加算分函数时,如家得分如下:

    添加了算分函数后,如家得分就提升了:

    1.5.3.布尔查询

    布尔查询是一个或多个查询子句的组合,每一个子句就是一个子查询。子查询的组合方式有:

    • must:必须匹配每个子查询,类似“与”

    • should:选择性匹配子查询,类似“或”

    • must_not:必须不匹配,不参与算分,类似“非”

    • filter:必须匹配,不参与算分

    比如在搜索酒店时,除了关键字搜索外,我们还可能根据品牌、价格、城市等字段做过滤:

    每一个不同的字段,其查询的条件、方式都不一样,必须是多个不同的查询,而要组合这些查询,就必须用bool查询了。

    需要注意的是,搜索时,参与打分的字段越多,查询的性能也越差。因此这种多条件查询时,建议这样做:

    • 搜索框的关键字搜索,是全文检索查询,使用must查询,参与算分

    • 其它过滤条件,采用filter查询。不参与算分

    1)语法

    1. GET /hotel/_search
    2. {
    3.   "query": {
    4.     "bool": {
    5.       "must": [
    6.         {"term": {"city": "上海" }}
    7.       ],
    8.       "should": [
    9.         {"term": {"brand": "皇冠假日" }},
    10.       {"term": {"brand": "华美达" }}
    11.       ],
    12.       "must_not": [
    13.         { "range": { "price": { "lte": 500 } }}
    14.       ],
    15.       "filter": [
    16.         { "range": {"score": { "gte": 45 } }}
    17.       ]
    18.     }
    19.   }
    20. }

    2)示例

    需求:搜索名字包含“如家”,价格不高于400,在坐标31.21,121.5周围10km范围内的酒店。

    分析:

    • 名称搜索,属于全文检索查询,应该参与算分。放到must中

    • 价格不高于400,用range查询,属于过滤条件,不参与算分。放到must_not中

    • 周围10km范围内,用geo_distance查询,属于过滤条件,不参与算分。放到filter中

    2.搜索结果处理

    搜索的结果可以按照用户指定的方式去处理或展示。

    2.1.排序

    elasticsearch默认是根据相关度算分(_score)来排序,但是也支持自定义方式对搜索结果排序。可以排序字段类型有:keyword类型、数值类型、地理坐标类型、日期类型等。

    1.普通字段排序

    keyword、数值、日期类型排序的语法基本一致。

    语法

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "match_all": {}
    5.   },
    6.   "sort": [
    7.     {
    8.       "FIELD": "desc"  // 排序字段、排序方式ASC、DESC
    9.     }
    10.   ]
    11. }

    排序条件是一个数组,也就是可以写多个排序条件。按照声明的顺序,当第一个条件相等时,再按照第二个条件排序,以此类推

    示例

    需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序

    2.地理坐标排序

    地理坐标排序略有不同。

    语法说明

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "match_all": {}
    5.   },
    6.   "sort": [
    7.     {
    8.       "_geo_distance" : {
    9.           "FIELD" : "纬度,经度", // 文档中geo_point类型的字段名、目标坐标点
    10.           "order" : "asc", // 排序方式
    11.           "unit" : "km" // 排序的距离单位
    12.       }
    13.     }
    14.   ]
    15. }

    这个查询的含义是:

    • 指定一个坐标,作为目标点

    • 计算每一个文档中,指定字段(必须是geo_point类型)的坐标 到目标点的距离是多少

    • 根据距离排序

    示例:

    需求描述:实现对酒店数据按照到你的位置坐标的距离升序排序

    提示:获取你的位置的经纬度的方式:获取鼠标点击经纬度-地图属性-示例中心-JS API 2.0 示例 | 高德地图API

    假设我的位置是:31.034661,121.612282,寻找我周围距离最近的酒店。

    2.2.分页

    elasticsearch 默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数。

    elasticsearch中通过修改from、size参数来控制要返回的分页结果:

    • from:从第几个文档开始

    • size:总共查询几个文档

    类似于mysql中的limit ?, ?

    1.基本的分页

    分页的基本语法如下:

    1. GET /hotel/_search
    2. {
    3.   "query": {
    4.     "match_all": {}
    5.   },
    6.   "from": 0, // 分页开始的位置,默认为0
    7.   "size": 10, // 期望获取的文档总数
    8.   "sort": [
    9.     {"price": "asc"}
    10.   ]
    11. }

    2.深度分页问题

    现在,我要查询990~1000的数据,查询逻辑要这么写:

    1. GET /hotel/_search
    2. {
    3.   "query": {
    4.     "match_all": {}
    5.   },
    6.   "from": 990, // 分页开始的位置,默认为0
    7.   "size": 10, // 期望获取的文档总数
    8.   "sort": [
    9.     {"price": "asc"}
    10.   ]
    11. }

    这里是查询990开始的数据,也就是 第990~第1000条 数据。

    不过,elasticsearch内部分页时,必须先查询 0~1000条,然后截取其中的990 ~ 1000的这10条:

    查询TOP1000,如果es是单点模式,这并无太大影响。

    但是elasticsearch将来一定是集群,例如我集群有5个节点,我要查询TOP1000的数据,并不是每个节点查询200条就可以了。

    因为节点A的TOP200,在另一个节点可能排到10000名以外了。

    因此要想获取整个集群的TOP1000,必须先查询出每个节点的TOP1000,汇总结果后,重新排名,重新截取TOP1000。

    那如果我要查询9900~10000的数据呢?是不是要先查询TOP10000呢?那每个节点都要查询10000条?汇总到内存中?

    当查询分页深度较大时,汇总数据过多,对内存和CPU会产生非常大的压力,因此elasticsearch会禁止from+ size 超过10000的请求。

    针对深度分页,ES提供了两种解决方案,官方文档

    • search after:分页时需要排序,原理是从上一次的排序值开始,查询下一页数据。官方推荐使用的方式。

    • scroll:原理将排序后的文档id形成快照,保存在内存。官方已经不推荐使用。

    2.3.高亮

    1.高亮原理

    什么是高亮显示呢?

    我们在百度,京东搜索时,关键字会变成红色,比较醒目,这叫高亮显示:

    高亮显示的实现分为两步:

    • 1)给文档中的所有关键字都添加一个标签,例如标签

    • 2)页面给标签编写CSS样式

    2.实现高亮

    高亮的语法

    1. GET /hotel/_search
    2. {
    3.   "query": {
    4.     "match": {
    5.       "FIELD": "TEXT" // 查询条件,高亮一定要使用全文检索查询
    6.     }
    7.   },
    8.   "highlight": {
    9.     "fields": { // 指定要高亮的字段
    10.       "FIELD": {
    11.         "pre_tags": "<em>",  // 用来标记高亮字段的前置标签
    12.         "post_tags": "em>" // 用来标记高亮字段的后置标签
    13.       }
    14.     }
    15.   }
    16. }

    注意:

    • 高亮是对关键字高亮,因此搜索条件必须带有关键字,而不能是范围这样的查询。

    • 默认情况下,高亮的字段,必须与搜索指定的字段一致,否则无法高亮

    • 如果要对非搜索字段高亮,则需要添加一个属性:required_field_match=false

    示例

    2.4 总结

    查询的DSL是一个大的JSON对象,包含下列属性:

    • query:查询条件

    • from和size:分页条件

    • sort:排序条件

    • highlight:高亮条件

    示例:

    3.RestClient查询文档

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

    • 1)准备Request对象

    • 2)准备请求参数

    • 3)发起请求

    • 4)解析响应

    3.1.快速入门

    我们以match_all查询为例

    1.发起查询请求

    代码解读:

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

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

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

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

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

    另一个是QueryBuilders,其中包含match、term、function_score、bool等各种查询:

    2.解析响应

    响应结果的解析:

    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文档数据

    3.完整代码

    完整代码如下:

    1. @Test
    2. void testMatchAll() throws IOException {
    3.    // 1.准备Request
    4.    SearchRequest request = new SearchRequest("hotel");
    5.    // 2.准备DSL
    6.    request.source()
    7.       .query(QueryBuilders.matchAllQuery());
    8.    // 3.发送请求
    9.    SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    10.    // 4.解析响应
    11.    handleResponse(response);
    12. }
    13. private void handleResponse(SearchResponse response) {
    14.    // 4.解析响应
    15.    SearchHits searchHits = response.getHits();
    16.    // 4.1.获取总条数
    17.    long total = searchHits.getTotalHits().value;
    18.    System.out.println("共搜索到" + total + "条数据");
    19.    // 4.2.文档数组
    20.    SearchHit[] hits = searchHits.getHits();
    21.    // 4.3.遍历
    22.    for (SearchHit hit : hits) {
    23.        // 获取文档source
    24.        String json = hit.getSourceAsString();
    25.        // 反序列化
    26.        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
    27.        System.out.println("hotelDoc = " + hotelDoc);
    28.   }
    29. }

    3.2.match查询

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

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

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

    完整代码如下:

    1. @Test
    2. void testMatch() throws IOException {
    3.    // 1.准备Request
    4.    SearchRequest request = new SearchRequest("hotel");
    5.    // 2.准备DSL
    6.    request.source()
    7.       .query(QueryBuilders.matchQuery("all", "如家"));
    8.    // 3.发送请求
    9.    SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    10.    // 4.解析响应
    11.    handleResponse(response);
    12. }

    3.3.精确查询

    精确查询主要是两者:

    • term:词条精确匹配

    • range:范围查询

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

    查询条件构造的API如下:

    3.4.布尔查询

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

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

    完整代码如下:

    1. @Test
    2. void testBool() throws IOException {
    3.    // 1.准备Request
    4.    SearchRequest request = new SearchRequest("hotel");
    5.    // 2.准备DSL
    6.    // 2.1.准备BooleanQuery
    7.    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    8.    // 2.2.添加term
    9.    boolQuery.must(QueryBuilders.termQuery("city", "杭州"));
    10.    // 2.3.添加range
    11.    boolQuery.filter(QueryBuilders.rangeQuery("price").lte(250));
    12.    request.source().query(boolQuery);
    13.    // 3.发送请求
    14.    SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    15.    // 4.解析响应
    16.    handleResponse(response);
    17. }

    3.5.排序、分页

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

    对应的API如下:

    完整代码示例:

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

    3.6.高亮

    高亮的代码与之前代码差异较大,有两点:

    • 查询的DSL:其中除了查询条件,还需要添加高亮条件,同样是与query同级。

    • 结果解析:结果除了要解析_source文档数据,还要解析高亮结果

    1.高亮请求构建

    高亮请求的构建API如下:

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

    完整代码如下:

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

    2.高亮结果解析

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

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

    代码解读:

    • 第一步:从结果中获取source。hit.getSourceAsString(),这部分是非高亮结果,json字符串。还需要反序列为HotelDoc对象

    • 第二步:获取高亮结果。hit.getHighlightFields(),返回值是一个Map,key是高亮字段名称,值是HighlightField对象,代表高亮值

    • 第三步:从map中根据高亮字段名称,获取高亮字段值对象HighlightField

    • 第四步:从HighlightField中获取Fragments,并且转为字符串。这部分就是真正的高亮字符串了

    • 第五步:用高亮的结果替换HotelDoc中的非高亮结果

    完整代码如下:

    1. private void handleResponse(SearchResponse response) {
    2.    // 4.解析响应
    3.    SearchHits searchHits = response.getHits();
    4.    // 4.1.获取总条数
    5.    long total = searchHits.getTotalHits().value;
    6.    System.out.println("共搜索到" + total + "条数据");
    7.    // 4.2.文档数组
    8.    SearchHit[] hits = searchHits.getHits();
    9.    // 4.3.遍历
    10.    for (SearchHit hit : hits) {
    11.        // 获取文档source
    12.        String json = hit.getSourceAsString();
    13.        // 反序列化
    14.        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
    15.        // 获取高亮结果
    16.        Map highlightFields = hit.getHighlightFields();
    17.        if (!CollectionUtils.isEmpty(highlightFields)) {
    18.            // 根据字段名获取高亮结果
    19.            HighlightField highlightField = highlightFields.get("name");
    20.            if (highlightField != null) {
    21.                // 获取高亮值
    22.                String name = highlightField.getFragments()[0].string();
    23.                // 覆盖非高亮结果
    24.                hotelDoc.setName(name);
    25.           }
    26.       }
    27.        System.out.println("hotelDoc = " + hotelDoc);
    28.   }
    29. }

    4.黑马旅游案例

    下面,我们通过黑马旅游的案例来实战演练下之前学习的知识。

    我们实现四部分功能:

    • 酒店搜索和分页

    • 酒店结果过滤

    • 我周边的酒店

    • 酒店竞价排名

    启动我们提供的hotel-demo项目,其默认端口是8089,访问http://localhost:8090,就能看到项目页面了:

    4.1.酒店搜索和分页

    案例需求:实现黑马旅游的酒店搜索功能,完成关键字搜索和分页

    1.需求分析

    在项目的首页,有一个大大的搜索框,还有分页按钮:

    点击搜索按钮,可以看到浏览器控制台发出了请求:

    请求参数如下:

    由此可以知道,我们这个请求的信息如下:

    • 请求方式:POST

    • 请求路径:/hotel/list

    • 请求参数:JSON对象,包含4个字段:

      • key:搜索关键字

      • page:页码

      • size:每页大小

      • sortBy:排序,目前暂不实现

    • 返回值:分页查询,需要返回分页结果PageResult,包含两个属性:

      • total:总条数

      • List:当前页的数据

    因此,我们实现业务的流程如下:

    • 步骤一:定义实体类,接收请求参数的JSON对象

    • 步骤二:编写controller,接收页面的请求

    • 步骤三:编写业务实现,利用RestHighLevelClient实现搜索、分页

    2.定义实体类

    实体类有两个,一个是前端的请求参数实体,一个是服务端应该返回的响应结果实体。

    1)请求参数

    前端请求的json结构如下:

    1. {
    2.    "key": "搜索关键字",
    3.    "page": 1,
    4.    "size": 3,
    5.    "sortBy": "default"
    6. }

    因此,我们在cn.itcast.hotel.pojo包下定义一个实体类:

    1. package cn.itcast.hotel.pojo;
    2. import lombok.Data;
    3. @Data
    4. public class RequestParams {
    5.    private String key;
    6.    private Integer page;
    7.    private Integer size;
    8.    private String sortBy;
    9. }

    2)返回值

    分页查询,需要返回分页结果PageResult,包含两个属性:

    • total:总条数

    • List:当前页的数据

    因此,我们在cn.itcast.hotel.pojo中定义返回结果:

    1. package cn.itcast.hotel.pojo;
    2. import lombok.Data;
    3. import java.util.List;
    4. @Data
    5. public class PageResult {
    6.    private Long total;
    7.    private List hotels;
    8.    public PageResult() {
    9.   }
    10.    public PageResult(Long total, List hotels) {
    11.        this.total = total;
    12.        this.hotels = hotels;
    13.   }
    14. }

    3.定义controller

    定义一个HotelController,声明查询接口,满足下列要求:

    • 请求方式:Post

    • 请求路径:/hotel/list

    • 请求参数:对象,类型为RequestParam

    • 返回值:PageResult,包含两个属性

      • Long total:总条数

      • List hotels:酒店数据

    因此,我们在cn.itcast.hotel.web中定义HotelController:

    1. @RestController
    2. @RequestMapping("/hotel")
    3. public class HotelController {
    4.    @Autowired
    5.    private IHotelService hotelService;
    6. // 搜索酒店数据
    7.    @PostMapping("/list")
    8.    public PageResult search(@RequestBody RequestParams params){
    9.        return hotelService.search(params);
    10.   }
    11. }

    4.实现搜索业务

    我们在controller调用了IHotelService,并没有实现该方法,因此下面我们就在IHotelService中定义方法,并且去实现业务逻辑。

    1)在cn.itcast.hotel.service中的IHotelService接口中定义一个方法:

    /**
     * 根据关键字搜索酒店信息
     * @param params 请求参数对象,包含用户输入的关键字 
     * @return 酒店文档列表
     */
    PageResult search(RequestParams params);
    

    2)实现搜索业务,肯定离不开RestHighLevelClient,我们需要把它注册到Spring中作为一个Bean。在cn.itcast.hotel中的HotelDemoApplication中声明这个Bean:

    1. @Bean
    2. public RestHighLevelClient client(){
    3.    return  new RestHighLevelClient(RestClient.builder(
    4.        HttpHost.create("http://192.168.150.101:9200")
    5.   ));
    6. }

    3)在cn.itcast.hotel.service.impl中的HotelService中实现search方法:

    1. @Override
    2. public PageResult search(RequestParams params) {
    3.    try {
    4.        // 1.准备Request
    5.        SearchRequest request = new SearchRequest("hotel");
    6.        // 2.准备DSL
    7.        // 2.1.query
    8.        String key = params.getKey();
    9.        if (key == null || "".equals(key)) {
    10.            boolQuery.must(QueryBuilders.matchAllQuery());
    11.       } else {
    12.            boolQuery.must(QueryBuilders.matchQuery("all", key));
    13.       }
    14.        // 2.2.分页
    15.        int page = params.getPage();
    16.        int size = params.getSize();
    17.        request.source().from((page - 1) * size).size(size);
    18.        // 3.发送请求
    19.        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    20.        // 4.解析响应
    21.        return handleResponse(response);
    22.   } catch (IOException e) {
    23.        throw new RuntimeException(e);
    24.   }
    25. }
    26. // 结果解析
    27. private PageResult handleResponse(SearchResponse response) {
    28.    // 4.解析响应
    29.    SearchHits searchHits = response.getHits();
    30.    // 4.1.获取总条数
    31.    long total = searchHits.getTotalHits().value;
    32.    // 4.2.文档数组
    33.    SearchHit[] hits = searchHits.getHits();
    34.    // 4.3.遍历
    35.    List hotels = new ArrayList<>();
    36.    for (SearchHit hit : hits) {
    37.        // 获取文档source
    38.        String json = hit.getSourceAsString();
    39.        // 反序列化
    40.        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
    41. // 放入集合
    42.        hotels.add(hotelDoc);
    43.   }
    44.    // 4.4.封装返回
    45.    return new PageResult(total, hotels);
    46. }

    4.2.酒店结果过滤

    需求:添加品牌、城市、星级、价格等过滤功能

    1.需求分析

    在页面搜索框下面,会有一些过滤项:

    传递的参数如图:

    包含的过滤条件有:

    • brand:品牌值

    • city:城市

    • minPrice~maxPrice:价格范围

    • starName:星级

    我们需要做两件事情:

    • 修改请求参数的对象RequestParams,接收上述参数

    • 修改业务逻辑,在搜索条件之外,添加一些过滤条件

    2.修改实体类

    修改在cn.itcast.hotel.pojo包下的实体类RequestParams:

    1. @Data
    2. public class RequestParams {
    3.    private String key;
    4.    private Integer page;
    5.    private Integer size;
    6.    private String sortBy;
    7.    // 下面是新增的过滤条件参数
    8.    private String city;
    9.    private String brand;
    10.    private String starName;
    11.    private Integer minPrice;
    12.    private Integer maxPrice;
    13. }

    3.修改搜索业务

    在HotelService的search方法中,只有一个地方需要修改:requet.source().query( ... )其中的查询条件。

    在之前的业务中,只有match查询,根据关键字搜索,现在要添加条件过滤,包括:

    • 品牌过滤:是keyword类型,用term查询

    • 星级过滤:是keyword类型,用term查询

    • 价格过滤:是数值类型,用range查询

    • 城市过滤:是keyword类型,用term查询

    多个查询条件组合,肯定是boolean查询来组合:

    • 关键字搜索放到must中,参与算分

    • 其它过滤条件放到filter中,不参与算分

    因为条件构建的逻辑比较复杂,这里先封装为一个函数:

    buildBasicQuery的代码如下:

    1. private void buildBasicQuery(RequestParams params, SearchRequest request) {
    2.    // 1.构建BooleanQuery
    3.    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    4.    // 2.关键字搜索
    5.    String key = params.getKey();
    6.    if (key == null || "".equals(key)) {
    7.        boolQuery.must(QueryBuilders.matchAllQuery());
    8.   } else {
    9.        boolQuery.must(QueryBuilders.matchQuery("all", key));
    10.   }
    11.    // 3.城市条件
    12.    if (params.getCity() != null && !params.getCity().equals("")) {
    13.        boolQuery.filter(QueryBuilders.termQuery("city", params.getCity()));
    14.   }
    15.    // 4.品牌条件
    16.    if (params.getBrand() != null && !params.getBrand().equals("")) {
    17.        boolQuery.filter(QueryBuilders.termQuery("brand", params.getBrand()));
    18.   }
    19.    // 5.星级条件
    20.    if (params.getStarName() != null && !params.getStarName().equals("")) {
    21.        boolQuery.filter(QueryBuilders.termQuery("starName", params.getStarName()));
    22.   }
    23. // 6.价格
    24.    if (params.getMinPrice() != null && params.getMaxPrice() != null) {
    25.        boolQuery.filter(QueryBuilders
    26.                         .rangeQuery("price")
    27.                         .gte(params.getMinPrice())
    28.                         .lte(params.getMaxPrice())
    29.                       );
    30.   }
    31. // 7.放入source
    32.    request.source().query(boolQuery);
    33. }

    4.3.我周边的酒店

    需求:我附近的酒店

    1.需求分析

    在酒店列表页的右侧,有一个小地图,点击地图的定位按钮,地图会找到你所在的位置:

    并且,在前端会发起查询请求,将你的坐标发送到服务端:

    我们要做的事情就是基于这个location坐标,然后按照距离对周围酒店排序。实现思路如下:

    • 修改RequestParams参数,接收location字段

    • 修改search方法业务逻辑,如果location有值,添加根据geo_distance排序的功能

    2.修改实体类

    修改在cn.itcast.hotel.pojo包下的实体类RequestParams:

    1. package cn.itcast.hotel.pojo;
    2. import lombok.Data;
    3. @Data
    4. public class RequestParams {
    5.    private String key;
    6.    private Integer page;
    7.    private Integer size;
    8.    private String sortBy;
    9.    private String city;
    10.    private String brand;
    11.    private String starName;
    12.    private Integer minPrice;
    13.    private Integer maxPrice;
    14.    // 我当前的地理坐标
    15.    private String location;
    16. }

    3.距离排序API

    我们以前学习过排序功能,包括两种:

    • 普通字段排序

    • 地理坐标排序

    我们只讲了普通字段排序对应的java写法。地理坐标排序只学过DSL语法,如下:

    1. GET /indexName/_search
    2. {
    3.   "query": {
    4.     "match_all": {}
    5.   },
    6.  "sort": [
    7.     {
    8.       "price": "asc"  
    9.     },
    10.     {
    11.       "_geo_distance" : {
    12.           "FIELD" : "纬度,经度",
    13.           "order" : "asc",
    14.           "unit" : "km"
    15.       }
    16.     }
    17.   ]
    18. }

    对应的java代码示例:

    4.添加距离排序

    cn.itcast.hotel.service.implHotelServicesearch方法中,添加一个排序功能:

    完整代码:

    1. @Override
    2. public PageResult search(RequestParams params) {
    3.    try {
    4.        // 1.准备Request
    5.        SearchRequest request = new SearchRequest("hotel");
    6.        // 2.准备DSL
    7.        // 2.1.query
    8.        buildBasicQuery(params, request);
    9.        // 2.2.分页
    10.        int page = params.getPage();
    11.        int size = params.getSize();
    12.        request.source().from((page - 1) * size).size(size);
    13.        // 2.3.排序
    14.        String location = params.getLocation();
    15.        if (location != null && !location.equals("")) {
    16.            request.source().sort(SortBuilders
    17.                                 .geoDistanceSort("location", new GeoPoint(location))
    18.                                 .order(SortOrder.ASC)
    19.                                 .unit(DistanceUnit.KILOMETERS)
    20.                                 );
    21.       }
    22.        // 3.发送请求
    23.        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    24.        // 4.解析响应
    25.        return handleResponse(response);
    26.   } catch (IOException e) {
    27.        throw new RuntimeException(e);
    28.   }
    29. }

    5.排序距离显示

    重启服务后,测试我的酒店功能:

    发现确实可以实现对我附近酒店的排序,不过并没有看到酒店到底距离我多远,这该怎么办?

    排序完成后,页面还要获取我附近每个酒店的具体距离值,这个值在响应结果中是独立的:

    因此,我们在结果解析阶段,除了解析source部分以外,还要得到sort部分,也就是排序的距离,然后放到响应结果中。

    我们要做两件事:

    • 修改HotelDoc,添加排序距离字段,用于页面显示

    • 修改HotelService类中的handleResponse方法,添加对sort值的获取

    1)修改HotelDoc类,添加距离字段

    1. package cn.itcast.hotel.pojo;
    2. import lombok.Data;
    3. import lombok.NoArgsConstructor;
    4. @Data
    5. @NoArgsConstructor
    6. public class HotelDoc {
    7.    private Long id;
    8.    private String name;
    9.    private String address;
    10.    private Integer price;
    11.    private Integer score;
    12.    private String brand;
    13.    private String city;
    14.    private String starName;
    15.    private String business;
    16.    private String location;
    17.    private String pic;
    18.    // 排序时的 距离值
    19.    private Object distance;
    20.    public HotelDoc(Hotel hotel) {
    21.        this.id = hotel.getId();
    22.        this.name = hotel.getName();
    23.        this.address = hotel.getAddress();
    24.        this.price = hotel.getPrice();
    25.        this.score = hotel.getScore();
    26.        this.brand = hotel.getBrand();
    27.        this.city = hotel.getCity();
    28.        this.starName = hotel.getStarName();
    29.        this.business = hotel.getBusiness();
    30.        this.location = hotel.getLatitude() + ", " + hotel.getLongitude();
    31.        this.pic = hotel.getPic();
    32.   }
    33. }

    2)修改HotelService中的handleResponse方法

    重启后测试,发现页面能成功显示距离了:

    4.4.酒店竞价排名

    需求:让指定的酒店在搜索结果中排名置顶

    1.需求分析

    要让指定酒店在搜索结果中排名置顶,效果如图:

    页面会给指定的酒店添加广告标记。那怎样才能让指定的酒店排名置顶呢?

    我们之前学习过的function_score查询可以影响算分,算分高了,自然排名也就高了。而function_score包含3个要素:

    • 过滤条件:哪些文档要加分

    • 算分函数:如何计算function score

    • 加权方式:function score 与 query score如何运算

    这里的需求是:让指定酒店排名靠前。因此我们需要给这些酒店添加一个标记,这样在过滤条件中就可以根据这个标记来判断,是否要提高算分

    比如,我们给酒店添加一个字段:isAD,Boolean类型:

    • true:是广告

    • false:不是广告

    这样function_score包含3个要素就很好确定了:

    • 过滤条件:判断isAD 是否为true

    • 算分函数:我们可以用最简单暴力的weight,固定加权值

    • 加权方式:可以用默认的相乘,大大提高算分

    因此,业务的实现步骤包括:

    1. 给HotelDoc类添加isAD字段,Boolean类型

    2. 挑选几个你喜欢的酒店,给它的文档数据添加isAD字段,值为true

    3. 修改search方法,添加function score功能,给isAD值为true的酒店增加权重

    2.修改HotelDoc实体

    cn.itcast.hotel.pojo包下的HotelDoc类添加isAD字段:

    3.添加广告标记

    接下来,我们挑几个酒店,添加isAD字段,设置为true:

    1. POST /hotel/_update/1902197537
    2. {
    3.    "doc": {
    4.        "isAD": true
    5.   }
    6. }
    7. POST /hotel/_update/2056126831
    8. {
    9.    "doc": {
    10.        "isAD": true
    11.   }
    12. }
    13. POST /hotel/_update/1989806195
    14. {
    15.    "doc": {
    16.        "isAD": true
    17.   }
    18. }
    19. POST /hotel/_update/2056105938
    20. {
    21.    "doc": {
    22.        "isAD": true
    23.   }
    24. }

    4.添加算分函数查询

    接下来我们就要修改查询条件了。之前是用的boolean 查询,现在要改成function_socre查询。

    function_score查询结构如下:

    对应的JavaAPI如下:

    我们可以将之前写的boolean查询作为原始查询条件放到query中,接下来就是添加过滤条件算分函数加权模式了。所以原来的代码依然可以沿用。

    修改cn.itcast.hotel.service.impl包下的HotelService类中的buildBasicQuery方法,添加算分函数查询:

    1. private void buildBasicQuery(RequestParams params, SearchRequest request) {
    2.    // 1.构建BooleanQuery
    3.    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    4.    // 关键字搜索
    5.    String key = params.getKey();
    6.    if (key == null || "".equals(key)) {
    7.        boolQuery.must(QueryBuilders.matchAllQuery());
    8.   } else {
    9.        boolQuery.must(QueryBuilders.matchQuery("all", key));
    10.   }
    11.    // 城市条件
    12.    if (params.getCity() != null && !params.getCity().equals("")) {
    13.        boolQuery.filter(QueryBuilders.termQuery("city", params.getCity()));
    14.   }
    15.    // 品牌条件
    16.    if (params.getBrand() != null && !params.getBrand().equals("")) {
    17.        boolQuery.filter(QueryBuilders.termQuery("brand", params.getBrand()));
    18.   }
    19.    // 星级条件
    20.    if (params.getStarName() != null && !params.getStarName().equals("")) {
    21.        boolQuery.filter(QueryBuilders.termQuery("starName", params.getStarName()));
    22.   }
    23.    // 价格
    24.    if (params.getMinPrice() != null && params.getMaxPrice() != null) {
    25.        boolQuery.filter(QueryBuilders
    26.                         .rangeQuery("price")
    27.                         .gte(params.getMinPrice())
    28.                         .lte(params.getMaxPrice())
    29.                       );
    30.   }
    31.    // 2.算分控制
    32.    FunctionScoreQueryBuilder functionScoreQuery =
    33.        QueryBuilders.functionScoreQuery(
    34.        // 原始查询,相关性算分的查询
    35.        boolQuery,
    36.        // function score的数组
    37.        new FunctionScoreQueryBuilder.FilterFunctionBuilder[]{
    38.            // 其中的一个function score 元素
    39.            new FunctionScoreQueryBuilder.FilterFunctionBuilder(
    40.                // 过滤条件
    41.                QueryBuilders.termQuery("isAD", true),
    42.                // 算分函数
    43.                ScoreFunctionBuilders.weightFactorFunction(10)
    44.           )
    45.       });
    46.    request.source().query(functionScoreQuery);
    47. }

  • 相关阅读:
    LVM_基本操作
    Docker仓库
    【Python3】函数相关应用
    2023牛客OI赛前集训营-提高组(第二场) 集合
    TCP协议之《乱序队列Out-Of-Order》
    [MAUI]在.NET MAUI中复刻苹果Cover Flow
    编译原理实验三、 词法分析实验报告
    解决办法‘npm‘ 不是内部或外部命令,也不是可运行的程序或批处理文件。
    软件测评中心测试项目及测试过程简析,CMA、CNAS软件测试报告获取
    JVM教程
  • 原文地址:https://blog.csdn.net/m0_59749089/article/details/133097353