1、DSL查询文档
1.1 分类
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)查询:复合查询可以将上述各种查询条件组合起来,合并查询条件。例如:
对用户搜索的内容做分词,得到词条
- 根据词条去倒排索引库中匹配,得到文档id
- 根据文档id找到文档,返回给用户
比较常用的场景包括:
- 商城的输入框搜索
- 百度输入框搜索
- match:根据一个字段查询
multi_match:根据多个字段查询,参与查询字段越多,查询性能越差
1.3 精准查询
精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有:
term查询:根据词条精确匹配,一般搜索keyword类型、数值类型、布尔类型、日期类型字段
- range查询:根据数值范围查询,可以是数值、日期的范围
//term
GET /indexName/_search
{
“query”: {
“term”: {
“FIELD”: {
“value”: “VALUE”
}
}
}
}
// range查询
GET /indexName/_search
{
“query”: {
“range”: {
“FIELD”: {
“gte”: 10, // 这里的gte代表大于等于,gt则代表大于
“lte”: 20 // lte代表小于等于,lt则代表小于
}
}
}
}
1.4 地理坐标查询
1.4.1 矩形范围查询
矩形范围查询,也就是geo_bounding_box查询,查询坐标落在某个矩形范围的所有文档:
查询时,需要指定矩形的左上、右下两个点的坐标,然后画出一个矩形,落在该矩形内的都是符合条件的点。
GET hotel/_search
{
“query”:{
“geo_bounding_box”:{
“location”:{
“top_left”: {
“lat”: 31.1,
“lon”: 121.5
},
“bottom_right”:{
“lat”: 30.9,
“lon”: 121.7
}
}
}
}
}
1.4.2 附近查询
附近查询,也叫做距离查询(geo_distance):查询到指定中心点小于某个距离值的所有文档。换句话来说,在地图上找一个点作为圆心,以指定距离为半径,画一个圆,落在圆内的坐标都算符合条件
// geo_distance 查询
GET /indexName/_search
{
“query”: {
“geo_distance”: {
“distance”: “15km”, // 半径
“FIELD”: “31.21,121.5” // 圆心
}
}
}
1.5 复合查询
复合(compound)查询:复合查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种:
- fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名
- bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索
当我们利用match查询时,文档结果会根据与搜索词条的关联度打分(_score),返回结果时按照分值降序排列。
[
{
“_score” : 17.850193,
“_source” : {
“name” : “虹桥如家酒店真不错”,
}
},
{
“_score” : 12.259849,
“_source” : {
“name” : “外滩如家酒店真不错”,
}
},
{
“_score” : 11.91091,
“_source” : {
“name” : “迪士尼如家酒店真不错”,
}
}
]
1.5.2 算分函数查询
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)基于运算模式做运算,得到最终结果,作为相关性算分。
因此,其中的关键点是:
- 过滤条件:决定哪些文档的算分被修改
- 算分函数:决定函数算分的算法
-
1.5.3 布尔查询
布尔查询是一个或多个查询子句的组合,每一个子句就是一个子查询。子查询的组合方式有:
must:必须匹配每个子查询,类似“与”
- should:选择性匹配子查询,类似“或”
- must_not:必须不匹配,不参与算分,类似“非”
- filter:必须匹配,不参与算分
2.对搜索结果进行处理
2.1排序
elasticsearch默认是根据相关度算分(score)来排序,但是也支持自定义方式对搜索结果排序。可以排序字段类型有:keyword类型、数值类型、地理坐标类型、日期类型等。
2.1.1普通字段排序
keyword、数值、日期类型排序的语法基本一致。
语法:
GET /indexName/_search
{
“query”: {
“match_all”: {}
},
“sort”: [
{
“FIELD”: “desc” // 排序字段、排序方式ASC、DESC
}
]
}
排序条件是一个数组,也就是可以写多个排序条件。按照声明的顺序,当第一个条件相等时,再按照第二个条件排序,以此类推
示例:
需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序
2.1.2.地理坐标排序
地理坐标排序略有不同。
语法说明:
GET /indexName/_search
{
“query”: {
“match_all”: {}
},
“sort”: [
{
“_geo_distance” : {
“FIELD” : “纬度,经度”, // 文档中geo_point类型的字段名、目标坐标点
“order” : “asc”, // 排序方式
“unit” : “km” // 排序的距离单位
}
}
]
}
查询的含义是:
● 指定一个坐标,作为目标点
● 计算每一个文档中,指定字段(必须是geo_point类型)的坐标 到目标点的距离是多少
● 根据距离排序
2.2.页
elasticsearch 默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数了。elasticsearch中通过修改from、size参数来控制要返回的分页结果:
● from:从第几个文档开始
● size:总共查询几个文档
类似于mysql中的limit ?, ?
2.2.1基本的分页
分页的基本语法如下:
GET /hotel/_search
{
“query”: {
“match_all”: {}
},
“from”: 0, // 分页开始的位置,默认为0
“size”: 10, // 期望获取的文档总数
“sort”: [
{“price”: “asc”}
]
}
2.2.2深度分页问题
查询990~1000的数据:
GET /hotel/_search
{
“query”: {
“match_all”: {}
},
“from”: 990, // 分页开始的位置,默认为0
“size”: 10, // 期望获取的文档总数
“sort”: [
{“price”: “asc”}
]
}
查询990开始的数据,也就是 第990~第1000条 数据。
不过,elasticsearch内部分页时,必须先查询 0~1000条,然后截取其中的990 ~ 1000的这10条:
查询TOP1000,如果es是单点模式,这并无太大影响。
但是elasticsearch将来一定是集群,例如我集群有5个节点,我要查询TOP1000的数据,并不是每个节点查询200条就可以了。
因为节点A的TOP200,在另一个节点可能排到10000名以外了。
因此要想获取整个集群的TOP1000,必须先查询出每个节点的TOP1000,汇总结果后,重新排名,重新截取TOP1000。
当查询分页深度较大时,汇总数据过多,对内存和CPU会产生非常大的压力,因此elasticsearch会禁止from+ size 超过10000的请求。
针对深度分页,ES提供了两种解决方案:
● search after:分页时需要排序,原理是从上一次的排序值开始,查询下一页数据。官方推荐使用的方式。
● scroll:原理将排序后的文档id形成快照,保存在内存。官方已经不推荐使用。
2.2.3小结
分页查询的常见实现方案以及优缺点:
● from + size:
○ 优点:支持随机翻页
○ 缺点:深度分页问题,默认查询上限(from + size)是10000
○ 场景:百度、京东、谷歌、淘宝这样的随机翻页搜索
● after search:
○ 优点:没有查询上限(单次查询的size不超过10000)
○ 缺点:只能向后逐页查询,不支持随机翻页
○ 场景:没有随机翻页需求的搜索,例如手机向下滚动翻页
● scroll:
○ 优点:没有查询上限(单次查询的size不超过10000)
○ 缺点:会有额外内存消耗,并且搜索结果是非实时的
○ 场景:海量数据的获取和迁移。从ES7.1开始不推荐,建议用 after search方案。
2.3高亮
2.3.1高亮原理
在百度,京东搜索时,关键字会变成红色,比较醒目,这叫高亮显示:
高亮显示的实现分为两步:
● 1)给文档中的所有关键字都添加一个标签,例如标签
● 2)页面给标签编写CSS样式
2.3.2实现高亮
高亮的语法:
GET /hotel/search
{
“query”: {
“match”: {
“FIELD”: “TEXT” // 查询条件,高亮一定要使用全文检索查询
}
},
“highlight”: {
“fields”: { // 指定要高亮的字段
“FIELD”: {
“pre_tags”: “”, // 用来标记高亮字段的前置标签
“post_tags”: “” // 用来标记高亮字段的后置标签
}
}
}
}
注意:
● 高亮是对关键字高亮,因此搜索条件必须带有关键字,而不能是范围这样的查询。
● 默认情况下,高亮的字段,必须与搜索指定的字段一致,否则无法高亮
● 如果要对非搜索字段高亮,则需要添加一个属性:required_field_match=false
3RestClient查询文档
文档的查询同样适用昨天学习的 RestHighLevelClient对象,基本步骤包括:
● 1)准备Request对象
● 2)准备请求参数
● 3)发起请求
● 4)解析响应
3.1快速入门
3.1.1发起查询请求
代码解读:
● 第一步,创建SearchRequest对象,指定索引库名
● 第二步,利用request.source()构建DSL,DSL中可以包含查询、分页、排序、高亮等
○ query():代表查询条件,利用QueryBuilders.matchAllQuery()构建一个match_all查询的DSL
● 第三步,利用client.search()发送请求,得到响应
这里关键的API有两个,一个是request.source(),其中包含了查询、排序、分页、高亮等所有功能:
另一个是QueryBuilders,其中包含match、term、function_score、bool等各种查询:
3.1.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.2match查询
全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件,也就是query的部分。
因此,Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法:
而结果解析代码则完全一致,可以抽取并共享。
3.3精确查询
精确查询主要是两者:
● term:词条精确匹配
● range:范围查询
与之前的查询相比,差异同样在查询条件,其它都一样。
查询条件构造的API如下:
3.4布尔查询
布尔查询是用must、must_not、filter等方式组合其它查询,代码示例如下:
可以看到,API与其它查询的差别同样是在查询条件的构建,QueryBuilders,结果解析等其他代码完全不变。
3.5排序、分页
搜索结果的排序和分页是与query同级的参数,因此同样是使用request.source()来设置。
对应的API如下
3.6.高亮
高亮的代码与之前代码差异较大,有两点:
● 查询的DSL:其中除了查询条件,还需要添加高亮条件,同样是与query同级。
● 结果解析:结果除了要解析_source文档数据,还要解析高亮结果
3.6.1高亮请求构建
高亮请求的构建API如下:
上述代码省略了查询条件部分,但是大家不要忘了:高亮查询必须使用全文检索查询,并且要有搜索关键字,将来才可以对关键字高亮。
3.6.2高亮结果解析
高亮的结果与查询的文档结果默认是分离的,并不在一起。
因此解析高亮的代码需要额外处理:
代码解读:
● 第一步:从结果中获取source。hit.getSourceAsString(),这部分是非高亮结果,json字符串。还需要反序列为HotelDoc对象
● 第二步:获取高亮结果。hit.getHighlightFields(),返回值是一个Map,key是高亮字段名称,值是HighlightField对象,代表高亮值
● 第三步:从map中根据高亮字段名称,获取高亮字段值对象HighlightField
● 第四步:从HighlightField中获取Fragments,并且转为字符串。这部分就是真正的高亮字符串了
● 第五步:用高亮的结果替换HotelDoc中的非高亮结果
4黑马旅游案例
下面,我们通过黑马旅游的案例来实战演练下之前学习的知识。
我们实现四部分功能:
● 酒店搜索和分页
● 酒店结果过滤
● 我周边的酒店
● 酒店竞价排名
启动我们提供的hotel-demo项目,其默认端口是8089,访问http://localhost:8090,就能看到项目页面了:
4.1酒店搜索和分页
4.1.1需求分析
在项目的首页,有一个大大的搜索框,还有分页按钮:
点击搜索按钮,可以看到浏览器控制台发出了请求:
请求参数如下:
由此可以知道,我们这个请求的信息如下:
● 请求方式:POST
● 请求路径:/hotel/list
● 请求参数:JSON对象,包含4个字段:
○ key:搜索关键字
○ page:页码
○ size:每页大小
○ sortBy:排序,目前暂不实现
● 返回值:分页查询,需要返回分页结果PageResult,包含两个属性:
○ total:总条数
○ List:当前页的数据
实现业务的流程如下:
● 步骤一:定义实体类,接收请求参数的JSON对象
● 步骤二:编写controller,接收页面的请求
● 步骤三:编写业务实现,利用RestHighLevelClient实现搜索、分页
4.1.2定义实体类
实体类有两个,一个是前端的请求参数实体,一个是服务端应该返回的响应结果实体。
1)请求参数
前端请求的json结构如下:
{
“key”: “搜索关键字”,
“page”: 1,
“size”: 3,
“sortBy”: “default”
}
因此,我们在cn.itcast.hotel.pojo包下定义一个实体类
2)返回值
分页查询,需要返回分页结果PageResult,包含两个属性:
● total:总条数
● List:当前页的数据
因此,我们在cn.itcast.hotel.pojo中定义返回结果
4.1.3定义controller
定义一个HotelController,声明查询接口,满足下列要求:
● 请求方式:Post
● 请求路径:/hotel/list
● 请求参数:对象,类型为RequestParam
● 返回值:PageResult,包含两个属性
○ Long total:总条数
○ List hotels:酒店数据
因此,我们在cn.itcast.hotel.web中定义HotelController
4.1.4.实现搜索业务
在controller调用了IHotelService,并没有实现该方法,因此下面就在IHotelService中定义方法,并且去实现业务逻辑。
1)在cn.itcast.hotel.service中的IHotelService接口中定义一个方法
2)实现搜索业务,肯定离不开RestHighLevelClient,我们需要把它注册到Spring中作为一个Bean。在cn.itcast.hotel中的HotelDemoApplication中声明这个Bean
3)在cn.itcast.hotel.service.impl中的HotelService中实现search方法
4.2酒店结果过滤
4.2.1需求分析
在页面搜索框下面,会有一些过滤项:
传递的参数如图:
包含的过滤条件有:
● brand:品牌值
● city:城市
● minPrice~maxPrice:价格范围
● starName:星级
需要做两件事情:
● 修改请求参数的对象RequestParams,接收上述参数
● 修改业务逻辑,在搜索条件之外,添加一些过滤条件
4.2.2.修改实体类
修改在cn.itcast.hotel.pojo包下的实体类RequestParams
4.2.3修改搜索业务
在HotelService的search方法中,只有一个地方需要修改:requet.source().query( … )其中的查询条件。
在之前的业务中,只有match查询,根据关键字搜索,现在要添加条件过滤,包括:
● 品牌过滤:是keyword类型,用term查询
● 星级过滤:是keyword类型,用term查询
● 价格过滤:是数值类型,用range查询
● 城市过滤:是keyword类型,用term查询
多个查询条件组合,肯定是boolean查询来组合:
● 关键字搜索放到must中,参与算分
● 其它过滤条件放到filter中,不参与算分
因为条件构建的逻辑比较复杂,这里先封装为一个函数:buildBasicQuery
4.3我周边的酒店
4.3.1需求分析
在酒店列表页的右侧,有一个小地图,点击地图的定位按钮,地图会找到你所在的位置:
并且,在前端会发起查询请求,将你的坐标发送到服务端:
我们要做的事情就是基于这个location坐标,然后按照距离对周围酒店排序。实现思路如下:
● 修改RequestParams参数,接收location字段
● 修改search方法业务逻辑,如果location有值,添加根据geo_distance排序的功能
4.3.2修改实体类
修改在cn.itcast.hotel.pojo包下的实体类RequestParams
4.3.3.距离排序API
排序功能,包括两种:
● 普通字段排序
● 地理坐标排序
地理坐标排序只学过DSL语法,如下:
GET /indexName/_search
{
“query”: {
“match_all”: {}
},
“sort”: [
{
“price”: “asc”
},
{
“_geo_distance” : {
“FIELD” : “纬度,经度”,
“order” : “asc”,
“unit” : “km”
}
}
]
}
4.3.4添加距离排序
在cn.itcast.hotel.service.impl的HotelService的search方法中,添加一个排序功能
4.3.5排序距离显示
排序完成后,页面还要获取我附近每个酒店的具体距离值,这个值在响应结果中是独立的:
在结果解析阶段,除了解析source部分以外,还要得到sort部分,也就是排序的距离,然后放到响应结果中。
要做两件事:
● 修改HotelDoc,添加排序距离字段,用于页面显示
● 修改HotelService类中的handleResponse方法,添加对sort值的获取
1)修改HotelDoc类,添加距离字段
2)修改HotelService中的handleResponse方法
4.4.酒店竞价排名
需求:让指定的酒店在搜索结果中排名置顶
4.4.1需求分析
要让指定酒店在搜索结果中排名置顶
页面会给指定的酒店添加广告标记
让指定的酒店排名置顶?
function_score包含3个要素:
● 过滤条件:哪些文档要加分
● 算分函数:如何计算function score
● 加权方式:function score 与 query score如何运算
这里的需求是:让指定酒店排名靠前。因此我们需要给这些酒店添加一个标记,这样在过滤条件中就可以根据这个标记来判断,是否要提高算分。
比如,我们给酒店添加一个字段:isAD,Boolean类型:
● true:是广告
● false:不是广告
这样function_score包含3个要素就很好确定了:
● 过滤条件:判断isAD 是否为true
● 算分函数:我们可以用最简单暴力的weight,固定加权值
● 加权方式:可以用默认的相乘,大大提高算分
因此,业务的实现步骤包括:
- 给HotelDoc类添加isAD字段,Boolean类型
- 挑选几个你喜欢的酒店,给它的文档数据添加isAD字段,值为true
- 修改search方法,添加function score功能,给isAD值为true的酒店增加权重
4.4.2修改HotelDoc实体
给cn.itcast.hotel.pojo包下的HotelDoc类添加isAD字段
4.4.3添加广告标记
酒店,添加isAD字段,设置为true:
POST /hotel/_update/1902197537
{
“doc”: {
“isAD”: true
}
}
POST /hotel/_update/2056126831
{
“doc”: {
“isAD”: true
}
}
POST /hotel/_update/1989806195
{
“doc”: {
“isAD”: true
}
}
POST /hotel/_update/2056105938
{
“doc”: {
“isAD”: true
}
}
4.4.4添加算分函数查询
修改查询条件了。之前是用的boolean 查询,现在要改成function_socre查询。
function_score查询结构如下:
对应的JavaAPI如下:
我们可以将之前写的boolean查询作为原始查询条件放到query中,接下来就是添加过滤条件、算分函数、加权模式了。所以原来的代码依然可以沿用。
修改cn.itcast.hotel.service.impl包下的HotelService类中的buildBasicQuery方法,添加算分函数查询.