DSL查询文档

DSL查询分类

• 查询所有：查询出所有数据，一般测试用。例如：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. 对用户搜索的内容做分词，得到词条
2. 根据词条去倒排索引库中匹配，得到文档id
3. 根据文档id找到文档，返回给用户

使用场景

• 比较常用的场景包括：
1. 商城的输入框搜索。例如京东：因为是拿着词条去匹配，因此参与搜索的字段也必须是可分词的text类型的字段。
2. 百度输入框搜索

基本语法

• 常见的全文检索查询包括：
1. match查询：单字段查询
2. multi_match查询：多字段查询，任意一个字段符合条件就算符合查询条件（参与查询字段越多，查询性能越差）

示例

• match查询示例：

• multi_match查询示例：

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

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

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

精准查询

• 精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有：
1. term：根据词条精确值查询
2. range：根据值的范围查询

term查询

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

• 语法说明

• 示例：

range查询

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

• 基本语法：

• 示例：

地理坐标查询

• 所谓的地理坐标查询，其实就是根据经纬度查询，官方文档：https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-queries.html

• 常见的使用场景包括：
1. 携程：搜索我附近的酒店
2. 滴滴：搜索我附近的出租车
3. 微信：搜索我附近的人

矩形范围查询

• 矩形范围查询，也就是geo_bounding_box查询，查询坐标落在某个矩形范围的所有文档。查询时，需要指定矩形的左上、右下两个点的坐标，然后画出一个矩形，落在该矩形内的都是符合条件的点。但是这种并不符合“附近的人”这样的需求。

• 语法如下：

附近查询

• 附近查询，也叫做距离查询（geo_distance）：查询到指定中心点小于某个距离值的所有文档。换句话来说，在地图上找一个点作为圆心，以指定距离为半径，画一个圆，落在圆内的坐标都算符合条件。

• 语法说明：

• 示例：

复合查询

• 复合（compound）查询：复合查询可以将其它简单查询组合起来，实现更复杂的搜索逻辑。常见的有两种：
1. fuction score：算分函数查询，可以控制文档相关性算分，控制文档排名
2. bool query：布尔查询，利用逻辑关系组合多个其它的查询，实现复杂搜索

相关性算分

• 当我们利用match查询时，文档结果会根据与搜索词条的关联度打分（_score），返回结果时按照分值降序排列。

• 例如，我们搜索 "虹桥如家"，结果如下：

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

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

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

算分函数查询

根据相关度打分是比较合理的需求，但合理的不一定是产品经理需要的。以百度为例，你搜索的结果中，并不是相关度越高排名越靠前，而是谁掏的钱多排名就越靠前。要想人为控制相关性算分，就需要利用elasticsearch中的function score查询了。

语法说明

• function score 查询中包含四部分内容：
1. 原始查询条件：query部分，基于这个条件搜索文档，并且基于BM25算法给文档打分，原始算分（query score)
2. 过滤条件：filter部分，符合该条件的文档才会重新算分
3. 算分函数：符合filter条件的文档要根据这个函数做运算，得到的函数算分（function score），有四种函数
• weight：函数结果是常量
• field_value_factor：以文档中的某个字段值作为函数结果
• random_score：以随机数作为函数结果
• script_score：自定义算分函数算法
4. 运算模式：算分函数的结果、原始查询的相关性算分，两者之间的运算方式，包括：
• multiply：相乘
• replace：用function score替换query score
• 其它，例如：sum、avg、max、min

• function score的运行流程如下：
1. 根据原始条件查询搜索文档，并且计算相关性算分，称为原始算分（query score）
2. 根据过滤条件，过滤文档
3. 符合过滤条件的文档，基于算分函数运算，得到函数算分（function score）
4. 将原始算分（query score）和函数算分（function score）基于运算模式做运算，得到最终结果，作为相关性算分。

• 因此，其中的关键点是：
1. 过滤条件：决定哪些文档的算分被修改
2. 算分函数：决定函数算分的算法
3. 运算模式：决定最终算分结果

示例

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

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

• 原始条件：不确定，可以任意变化

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

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

• 运算模式：比如求和

因此最终的DSL语句如下：

测试，在未添加算分函数时，如家得分如下：

添加了算分函数后，如家得分就提升了：

布尔查询

• 布尔查询是一个或多个查询子句的组合，每一个子句就是一个子查询。子查询的组合方式有：
1. must：必须匹配每个子查询，类似“与”
2. should：选择性匹配子查询，类似“或”
3. must_not：必须不匹配，不参与算分，类似“非”
4. filter：必须匹配，不参与算分

• 比如在搜索酒店时，除了关键字搜索外，我们还可能根据品牌、价格、城市等字段做过滤：每一个不同的字段，其查询的条件、方式都不一样，必须是多个不同的查询，而要组合这些查询，就必须用bool查询了。

• 基本语法：

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

分析：

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

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

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

搜索结果处理

排序

普通字段排序

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

• 语法：

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

• 示例：
需求描述：酒店数据按照用户评价（score）降序排序，评价相同的按照价格（price）升序排序

地理坐标排序

• 语法说明：

这个查询的含义是：

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

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

• 根据距离排序

• 示例：
需求描述：实现对酒店数据按照到你的位置坐标的距离升序排序
💡
提示：获取你的位置的经纬度的方式：https://lbs.amap.com/demo/jsapi-v2/example/map/click-to-get-lnglat/
假设我的位置是：31.034661，121.612282，寻找我周围距离最近的酒店。

分页

elasticsearch 默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数了。elasticsearch中通过修改from、size参数来控制要返回的分页结果：

• from：从第几个文档开始

• size：总共查询几个文档

类似于mysql中的limit ?, ?

基本的分页

• 基本语法：

深度分页问题

• 现在，我要查询990~1000的数据，查询逻辑要这么写：

• 这里是查询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提供了两种解决方案，官方文档：
1. search after：分页时需要排序，原理是从上一次的排序值开始，查询下一页数据。官方推荐使用的方式。
2. scroll：原理将排序后的文档id形成快照，保存在内存。官方已经不推荐使用。

总结

• from + size：
• 优点：支持随机翻页
• 缺点：深度分页问题，默认查询上限（from + size）是10000
• 场景：百度、京东、谷歌、淘宝这样的随机翻页搜索

• after search：
• 优点：没有查询上限（单次查询的size不超过10000）
• 缺点：只能向后逐页查询，不支持随机翻页
• 场景：没有随机翻页需求的搜索，例如手机向下滚动翻页

• scroll：
• 优点：没有查询上限（单次查询的size不超过10000）
• 缺点：会有额外内存消耗，并且搜索结果是非实时的
• 场景：海量数据的获取和迁移。从ES7.1开始不推荐，建议用 after search方案。

高亮

高亮原理

• 什么是高亮显示呢？我们在百度，京东搜索时，关键字会变成红色，比较醒目，这叫高亮显示：

• 高亮显示的实现分为两步：
1. 给文档中的所有关键字都添加一个标签，例如<em>标签
2. 页面给<em>标签编写CSS样式

实现高亮

• 高亮的语法：
💡
注意：
• 高亮是对关键字高亮，因此搜索条件必须带有关键字（全文检索），而不能是范围这样的查询。
• 默认情况下，高亮的字段，必须与搜索指定的字段一致，否则无法高亮
• 如果要对非搜索字段高亮，则需要添加一个属性：required_field_match=false

• 示例：

总结

RestClient查询文档

match_all

发起查询请求

代码解读：

1. 第一步，创建SearchRequest对象，指定索引库名

2. 第二步，利用request.source()构建DSL，DSL中可以包含查询、分页、排序、高亮等
query()：代表查询条件，利用QueryBuilders.matchAllQuery()构建一个match_all查询的DSL

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

解析响应

• hits：命中的结果
• total：总条数，其中的value是具体的总条数值
• max_score：所有结果中得分最高的文档的相关性算分
• hits：搜索结果的文档数组，其中的每个文档都是一个json对象
• _source：文档中的原始数据，也是json对象

• SearchHits：通过response.getHits()获取，就是JSON中的最外层的hits，代表命中的结果
• SearchHits#getTotalHits().value：获取总条数信息
• SearchHits#getHits()：获取SearchHit数组，也就是文档数组
• SearchHit#getSourceAsString()：获取文档结果中的_source，也就是原始的json文档数据

代码

match查询

match

multimatch

精确查询

term

range

布尔查询

排序、分页查询

高亮

• 高亮的代码与之前代码差异较大，有两点：
1. 查询的DSL：其中除了查询条件，还需要添加高亮条件，同样是与query同级。
2. 结果解析：结果除了要解析_source文档数据，还要解析高亮结果

高亮请求构建

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

高亮结果解析

代码解读：

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

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

3. 第三步：从map中根据高亮字段名称，获取高亮字段值对象HighlightField

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

5. 第五步：用高亮的结果替换HotelDoc中的非高亮结果

旅游酒店项目

搜索和分页

需求分析

• 请求方式：POST

• 请求路径：/hotel/list

• 请求参数：JSON对象，包含4个字段：
• key：搜索关键字
• page：页码
• size：每页大小
• sortBy：排序，目前暂不实现

• 返回值：分页查询，需要返回分页结果PageResult，包含两个属性：
• total：总条数
• List<HotelDoc>：当前页的数据

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

• 步骤二：编写controller，接收页面的请求

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

定义实体类

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

• 请求参数实体类

• 响应结果实体类

定义controller

实现搜索业务

1. 在com.frank.hoteldemo.service中的IHotelService接口中定义一个方法：

2. 实现搜索业务，肯定离不开RestHighLevelClient，我们需要把它注册到Spring中作为一个Bean。在com.frank.hoteldemo中的HotelDemoApplication中声明这个Bean：

3. 在com.frank.hoteldemo.service.impl中的HotelService中实现search方法：

酒店结果过滤

需求分析

• 在页面搜索框下面，会有一些过滤项：

• 传递的参数如图：

• 包含的过滤条件有：
1. brand：品牌值
2. city：城市
3. minPrice~maxPrice：价格范围
4. starName：星级

• 我们需要做两件事情：
1. 修改请求参数的对象RequestParams，接收上述参数
2. 修改业务逻辑，在搜索条件之外，添加一些过滤条件

修改实体类

• 修改在com.frank.hoteldemo.pojo包下的实体类RequestParams：

修改搜索业务

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

• 在之前的业务中，只有match查询，根据关键字搜索，现在要添加条件过滤，包括：
1. 品牌过滤：是keyword类型，用term查询
2. 星级过滤：是keyword类型，用term查询
3. 价格过滤：是数值类型，用range查询
4. 城市过滤：是keyword类型，用term查询

• 多个查询条件组合，肯定是boolean查询来组合：
1. 关键字搜索放到must中，参与算分
2. 其它过滤条件放到filter中，不参与算分

• 因为条件构建的逻辑比较复杂，这里先封装为一个函数buildBasicQuery，代码如下：

• 业务搜索函数的代码：

周边酒店

需求分析

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

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

• 我们要做的事情就是基于这个location坐标，然后按照距离对周围酒店排序。实现思路如下：
1. 修改RequestParams参数，接收location字段
2. 修改search方法业务逻辑，如果location有值，添加根据geo_distance排序的功能

修改实体类

• 修改在com.frank.hoteldemo.pojo包下的实体类RequestParams：

距离排序API

• 普通字段排序

• 地理坐标排序

添加距离排序

排序距离显示

• 重启服务后，测试我的酒店功能：

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

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

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

• 我们要做两件事：
1. 修改HotelDoc，添加排序距离字段，用于页面显示
2. 修改HotelService类中的handleResponse方法，添加对sort值的获取

• 重启后测试，发现页面能成功显示距离了：

酒店竞价排名

需求分析

• 页面会给指定的酒店添加广告标记。

• 那怎样才能让指定的酒店排名置顶呢？

• 我们之前学习过的function_score查询可以影响算分，算分高了，自然排名也就高了。而function_score包含3个要素：
1. 过滤条件：哪些文档要加分
2. 算分函数：如何计算function score
3. 加权方式：function score 与 query score如何运算

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

• 比如，我们给酒店添加一个字段：isAD，Boolean类型：
1. true：是广告
2. false：不是广告

• 这样function_score包含3个要素就很好确定了：
1. 过滤条件：判断isAD 是否为true
2. 算分函数：我们可以用最简单暴力的weight，固定加权值
3. 加权方式：可以用默认的相乘，大大提高算分

• 因此，业务的实现步骤包括：
1. 给HotelDoc类添加isAD字段，Boolean类型
2. 挑选几个你喜欢的酒店，给它的文档数据添加isAD字段，值为true
3. 修改search方法，添加function score功能，给isAD值为true的酒店增加权重

修改HotelDoc实体

添加广告标记

添加算分函数查询

• function_score查询结构如下：

• 对应的JavaAPI如下：

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

• 修改com.frank.hoteldemo.service.impl包下的HotelService类中的buildBasicQuery方法，添加算分函数查询：

• 重启服务，效果如图：