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
- 查询的语法基本一致:
GET /indexName/_search
{
"query": {
"查询类型": {
"查询条件": "条件值"
}
}
}
我们以查询所有为例,其中:
- 查询类型为match_all
- 没有查询条件
// 查询所有
GET /indexName/_search
{
"query": {
"match_all": {
}
}
}
- 其它查询无非就是查询类型、查询条件的变化
- 案例
#查询所有
GET /hotel/_search
{
"query": {
"match_all": {}
}
}
1.全文检索查询
1.1 使用场景
全文检索查询的基本流程如下:
- 对用户搜索的内容做分词,得到词条
- 根据词条去倒排索引库中匹配,得到文档id
- 根据文档id找到文档,返回给用户
- 比较常用的场景包括:
- 商城的输入框搜索
- 百度输入框搜索
1.2 基本语法
- 常见的全文检索查询包括:
- match查询:单字段查询
- multi_match查询:多字段查询,任意一个字段符合条件就算符合查询条件
match查询语法如下:
GET /indexName/_search
{
"query": {
"match": {
"FIELD": "TEXT"
}
}
}
- 案例
#查询名称包含连锁的数据
GET /hotel/_search
{
"query": {
"match": {
"name": "连锁"
}
}
}
mulit_match语法如下:
GET /indexName/_search
{
"query": {
"multi_match": {
"query": "TEXT",
"fields": ["FIELD1", " FIELD12"]
}
}
}
#查询在name、brand、city字段中包含上海的数据
GET /hotel/_search
{
"query": {
"multi_match": {
"query": "上海",
"fields": ["name", "brand", "city"]
}
}
}
#下面的DSL也可以完成上面的工作,查询效率要比上面的高
GET /hotel/_search
{
"query": {
"match": {
"all": "上海如家"
}
}
}
1.3 示例
- 可以看到,两种查询结果是一样的,为什么?
- 因为我们将brand、name、business值都利用copy_to复制到了all字段中。因此你根据三个字段搜索,和根据all字段搜索效果当然一样了。 但是,搜索字段越多,对查询性能影响越大,因此建议采用copy_to。
- match和multi_match的区别是什么?
- match:根据一个字段查询
- multi_match:根据多个字段查询,参与查询字段越多,查询性能越差
2.精准查询
- 精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有:
- term:根据词条精确值查询
- range:根据值的范围查询
2.1 term查询
- 因为精确查询的字段搜是不分词的字段,因此查询的条件也必须是不分词的词条。查询时,用户输入的内容跟自动值完全匹配时才认为符合条件。如果用户输入的内容过多,反而搜索不到数据。
- 语法说明:
// term查询
GET /indexName/_search
{
"query": {
"term": {
"FIELD": {
"value": "VALUE"
}
}
}
}
- 案例
#查询城市是上海的数据
GET /hotel/_search
{
"query": {
"term": {
"city": {
"value": "上海"
}
}
}
}
- 示例:
2.2 range查询
- 范围查询,一般应用在对数值类型做范围过滤的时候。比如做价格范围过滤。
- 基本语法:
// range查询
GET /indexName/_search
{
"query": {
"range": {
"FIELD": {
"gte": 10, // 这里的gte代表大于等于,gt则代表大于
"lte": 20 // lte代表小于等于,lt则代表小于
}
}
}
}
- 案例
#查询price在[1000,3000]之间的数据
#范围查询。gte >= gt >,其他的以此类推
GET /hotel/_search
{
"query": {
"range": {
"price": {
"gte": 1000,
"lte": 3000
}
}
}
}
- 示例:
3.地理坐标查询
- 所谓的地理坐标查询,其实就是根据经纬度查询,官方文档:https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-queries.html
3.1矩形范围查询
- 矩形范围查询,也就是geo_bounding_box查询,查询坐标落在某个矩形范围的所有文档
- 查询时,需要指定矩形的左上、右下两个点的坐标,然后画出一个矩形,落在该矩形内的都是符合条件的点
- 语法如下:
// geo_bounding_box查询
GET /indexName/_search
{
"query": {
"geo_bounding_box": {
"FIELD": {
"top_left": { // 左上点
"lat": 31.1,
"lon": 121.5
},
"bottom_right": { // 右下点
"lat": 30.9,
"lon": 121.7
}
}
}
}
}
3.2 附近查询
- 附近查询,也叫做距离查询(geo_distance):查询到指定中心点小于某个距离值的所有文档。
- 换句话来说,在地图上找一个点作为圆心,以指定距离为半径,画一个圆,落在圆内的坐标都算符合条件
- 语法说明:
// geo_distance 查询
GET /indexName/_search
{
"query": {
"geo_distance": {
"distance": "15km", // 半径
"FIELD": "31.21,121.5" // 圆心
}
}
}
- 案例
#geo_distance 查询,以点为圆心,向周边辐射多少距离
GET /hotel/_search
{
"query": {
"geo_distance": {
"distance": "15km",
"location": "31.21,121.5"
}
}
}
- 示例:
4. 复合查询
- 复合(compound)查询:复合查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种
- fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名
- bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索
4.1 相关性算分
- 搜索的结果与搜索的内容相匹配,匹配度越高,分值就越高,排位就越高
- 当我们利用match查询时,文档结果会根据与搜索词条的关联度打分(_score),返回结果时按照分值降序排列。
- 例如,我们搜索 “虹桥如家”,结果如下
[
{
"_score" : 17.850193,
"_source" : {
"name" : "虹桥如家酒店真不错",
}
},
{
"_score" : 12.259849,
"_source" : {
"name" : "外滩如家酒店真不错",
}
},
{
"_score" : 11.91091,
"_source" : {
"name" : "迪士尼如家酒店真不错",
}
}
]
4.2 算分函数查询
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语句如下:
#需求:给“如家”这个品牌的酒店排名靠前一些
#原始条件:不确定,可以任意变化
#过滤条件:brand = "如家"
#算分函数:可以简单粗暴,直接给固定的算分结果,weight
#运算模式:比如求和
GET /hotel/_search
{
"query": {
"function_score": {
"query": {
"match": {
"all": "外滩"
}
},
"functions": [
{
"filter": {
"term": {
"brand": "如家"
}
},
"weight": 10
}
],
"boost_mode": "sum"
}
}
}
3)小结
- function score query定义的三要素是什么?
过滤条件【filter】:哪些文档要加分- 算分函数【weight】:如何计算function score
- 加权方式【sum】:function score 与 query score如何运算
5. 布尔查询
- 布尔查询是一个或多个查询子句的组合,每一个子句就是一个子查询。子查询的组合方式有:
- must:必须匹配每个子查询,类似“与”
- should:选择性匹配子查询,类似“或”
- must_not:必须不匹配,不参与算分,类似“非”
- filter:必须匹配,不参与算分
- 比如在搜索酒店时,除了关键字搜索外,我们还可能根据品牌、价格、城市等字段做过滤,每一个不同的字段,其查询的条件、方式都不一样,必须是多个不同的查询,而要组合这些查询,就必须用bool查询了。
- 需要注意的是,搜索时,参与打分的字段越多,查询的性能也越差。因此这种多条件查询时,建议这样做:
- 搜索框的关键字搜索,是全文检索查询,使用must查询,参与算分
- 其它过滤条件,采用filter查询。不参与算分
1)语法示例
GET /hotel/_search
{
"query": {
"bool": {
#城市必须是上海
"must": [
{"term": {"city": "上海" }}
],
#品牌可以 皇冠假日 或者 华美达
"should": [
{"term": {"brand": "皇冠假日" }},
{"term": {"brand": "华美达" }}
],
#价格必须不低于500
"must_not": [
{ "range": { "price": { "lte": 500 } }}
],
#评分必须大于等于45
"filter": [
{ "range": {"score": { "gte": 45 } }}
]
}
}
}
2)案例
- 需求:搜索名字包含“如家”,价格不高于400,在坐标31.21,121.5周围10km范围内的酒店。
- 分析:
- 名称搜索,属于全文检索查询,应该参与算分。放到must中
- 价格不高于400,用range查询,属于过滤条件,不参与算分。放到must_not中
- 周围10km范围内,用geo_distance查询,属于过滤条件,不参与算分。放到filter中
#搜索名字包含“如家”,价格不高于400,在坐标
#31.21,121.5周围10km范围内的酒店
GET /hotel/_search
{
"query": {
"bool": {
"must": [
{
"match": {
"name": "如家"
}
}
],
"must_not": [
{
"range": {
"price": {
"gte": 400
}
}
}
],
"filter": [
{
"geo_distance": {
"distance": "10km",
"location": "31.21,121.5"
}
}
]
}
}
}
3)小结
- bool查询有几种逻辑关系?
- must:必须匹配的条件,可以理解为“与”
- should:选择性匹配的条件,可以理解为“或”
- must_not:必须不匹配的条件,不参与打分
- filter:必须匹配的条件,不参与打分,效率比较高
6. 搜索结果处理
6.1 排序
- elasticsearch默认是根据相关度算分(_score)来排序,但是也支持自定义方式对搜索结果排序。可以排序字段类型有:keyword类型、数值类型、地理坐标类型、日期类型等。
6.1.1 普通字段排序
- keyword、数值、日期类型排序的语法基本一致。
- 语法:
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"FIELD": "desc" // 排序字段、排序方式ASC、DESC
}
]
}
- 排序条件是一个数组,也就是可以写多个排序条件。按照声明的顺序,当第一个条件相等时,再按照第二个条件排序,以此类推
- 示例:
- 需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序
- 需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序
6.1.2 地理坐标排序
- 语法说明
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"_geo_distance" : {
"FIELD" : "纬度,经度", // 文档中geo_point类型的字段名、目标坐标点
"order" : "asc", // 排序方式
"unit" : "km" // 排序的距离单位
}
}
]
}
- 这个查询的含义是:
- 指定一个坐标,作为目标点
- 计算每一个文档中,指定字段(必须是geo_point类型)的坐标 到目标点的距离是多少
- 根据距离排序
- 示例:
- 需求描述:实现对酒店数据按照到你的位置坐标的距离升序排序
#酒店数据按照用户评价(score)降序排序,
#评价相同的按照价格(price)升序排序
#根据坐标进行升序
GET /hotel/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"score": {
"order": "desc"
}
},
{
"price": {
"order": "asc"
}
},
{
"_geo_distance": {
"location": {
"lat": 31.034661,
"lon": 121.612282
},
"order": "asc",
"unit": "km"
}
}
]
}
6.1.3 分页
- elasticsearch
默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数了。elasticsearch中通过修改from、size参数来控制要返回的分页结果:- from:从第几个文档开始
- size:总共查询几个文档
6.1.3.1基本的分页
- 分页的基本语法如下:
GET /hotel/_search
{
"query": {
"match_all": {}
},
"from": 0, // 分页开始的位置,默认为0
"size": 10, // 期望获取的文档总数
"sort": [
{"price": "asc"}
]
}
6.1.3.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条:
- 示例
#酒店数据按照用户评价(score)降序排序,
#评价相同的按照价格(price)升序排序
#根据坐标进行升序
GET /hotel/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"score": {
"order": "desc"
}
},
{
"price": {
"order": "asc"
}
},
{
"_geo_distance": {
"location": {
"lat": 31.034661,
"lon": 121.612282
},
"order": "asc",
"unit": "km"
}
}
],
"from": 20,
"size": 10
}
7. 高亮
- 高亮显示的实现分为两步:
- 1)给文档中的所有关键字都添加一个标签,例如
<em>
标签 - 2)页面给
<em>
标签编写CSS样式
- 1)给文档中的所有关键字都添加一个标签,例如
- 示例
GET /hotel/_search
{
"query": {
"match": {
"FIELD": "TEXT" // 查询条件,高亮一定要使用全文检索查询
}
},
"highlight": {
"fields": { // 指定要高亮的字段
"FIELD": {
"pre_tags": "<em>", // 用来标记高亮字段的前置标签
"post_tags": "</em>" // 用来标记高亮字段的后置标签
}
}
}
}
- 注意:
- 高亮是对关键字高亮,因此搜索条件必须带有关键字,而不能是范围这样的查询。
- 默认情况下,高亮的字段,必须与搜索指定的字段一致,否则无法高亮
- 如果要对非搜索字段高亮,则需要添加一个属性:required_field_match=false
- 示例
#搜索all中有如家的数据
GET /hotel/_search
{
"query": {
"match": {
"all": "如家"
}
},
"highlight": {
"fields": {
"name": {
"require_field_match": "false"
}
}
}
}
#搜索名称中包含如家的酒店,且对名称进行高亮
GET /hotel/_search
{
"query": {
"match": {
"name": "如家"
}
},
"highlight": {
"fields": {
"name": {
"pre_tags": "<em>",
"post_tags": "</em>"
}
}
}
}
RestClient查询文档
- 文档的查询同样适用昨天学习的 RestHighLevelClient对象,基本步骤包括
1)准备Request对象
SearchRequest
2)准备请求参数
SearchRequest.source().query( 查询条件【QueryBuilders.xxxQuery()】 )
3)发起请求
SearchResponse = client.search(SearchRequest, default)
4)解析响应
SearchResponse.getHits().getHits() 得到集合结果
-
代码解读:
-
第一步,创建
SearchRequest
对象,指定索引库名 -
第二步,利用
request.source()
构建DSL,DSL中可以包含查询、分页、排序、高亮等 -
query()
:代表查询条件,利用QueryBuilders.matchAllQuery()
构建一个match_all查询的DSL -
第三步,利用client.search()发送请求,得到响应
-
-
这里关键的API有两个,一个是
request.source()
,其中包含了查询、排序、分页、高亮等所有功能 -
另一个是
QueryBuilders
,其中包含match、term、function_score、bool等各种查询:
1. match查询
- 全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件,也就是query的部分
- 因此,Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法
- 代码案例
@Test
public void testMatchAll() throws Exception {
//创建searchRequest对象
SearchRequest searchRequest = new SearchRequest(EsConstant.INDEX);
//准备DSL
searchRequest.source().query(QueryBuilders.matchAllQuery());
//发送请求
SearchResponse response = client.search(searchRequest, RequestOptions.DEFAULT);
//解析响应
SearchHits hits = response.getHits();
//获取查询的总条数
TotalHits totalHits = hits.getTotalHits();
//输出查询的总条数
System.out.println(totalHits);
//获取hitsJSON字符串
SearchHit[] hitsHits = hits.getHits();
//遍历hitsJSON字符串
for (SearchHit hitsHit : hitsHits) {
//获取source数据
String sourceAsString = hitsHit.getSourceAsString();
//格式转换
HotelDoc hotelDoc = JSON.parseObject(sourceAsString, HotelDoc.class);
System.out.println(hotelDoc);
}
}
- 解析响应
- 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文档数据
2. 精确查询
- 精确查询主要是两者:
- term:词条精确匹配
- range:范围查询
- 与之前的查询相比,差异同样在查询条件,其它都一样。查询条件构造的API如下:
3. 布尔查询
- 布尔查询是用must、must_not、filter等方式组合其它查询,代码示例如下
- 可以看到,API与其它查询的差别同样是在查询条件的构建QueryBuilders,结果解析等其他代码完全不变
- 代码案例
/**
* 布尔查询
*
* @throws Exception
*/
@Test
public void testBool() throws Exception {
//创建searchRequest对象
SearchRequest searchRequest = new SearchRequest(EsConstant.INDEX);
//调用布尔查询方法
BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
//设置查询的条件,根据字段进行查询,根据价格范围搜索
boolQuery.must(QueryBuilders.termQuery("city", "北京")).
filter(QueryBuilders.rangeQuery("price").lte(500));
//准备DSL
searchRequest.source().query(boolQuery);
//发送请求
SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
//获取查询的总条数
SearchHit[] hits = searchResponse.getHits().getHits();
for (SearchHit hit : hits) {
//获取source数据
String sourceAsString = hit.getSourceAsString();
//格式转换
HotelDoc hotelDoc = JSON.parseObject(sourceAsString, HotelDoc.class);
System.out.println(hotelDoc);
}
}
4. 排序、分页
- 搜索结果的排序和分页是与query同级的参数,因此同样是使用request.source()来设置。
5. 高亮
- 高亮的代码与之前代码差异较大,有两点:
- 查询的DSL:其中除了查询条件,还需要添加高亮条件,同样是与query同级。
- 结果解析:结果除了要解析_source文档数据,还要解析高亮结果
- 高亮请求构建
- 代码案例
/**
* 布尔查询,分页查询,排序,高亮显示
*
* @throws Exception
*/
@Test
public void testBoolAndSortAndPageAndHighLight() throws Exception {
//定义页码
int page = 1;
//每页展示的数据
int size = 5;
//创建searchRequest对象
SearchRequest searchRequest = new SearchRequest(EsConstant.INDEX);
//调用布尔查询方法
BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
//设置查询的条件,根据字段进行查询,根据价格范围搜索
boolQuery.must(QueryBuilders.termQuery("name", "如家")).
filter(QueryBuilders.rangeQuery("price").lte(500));
//准备DSL
searchRequest.source().query(boolQuery).
//分页
from((page - 1) * size).
//每页展示的数据
size(5).
//排序
sort("price", SortOrder.DESC).
//高亮显示
highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
//发送请求
SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
//获取查询的总条数
SearchHit[] hits = searchResponse.getHits().getHits();
for (SearchHit hit : hits) {
//获取source数据
String sourceAsString = hit.getSourceAsString();
//获取高亮的值
String name = hit.getHighlightFields().get("name").getFragments()[0].toString();
//格式转换
HotelDoc hotelDoc = JSON.parseObject(sourceAsString, HotelDoc.class);
//高亮的值把之前的值进行覆盖
hotelDoc.setName(name);
System.out.println(hotelDoc);
}
}
- 高亮结果解析
- 代码解读:
- 第一步:从结果中获取source。hit.getSourceAsString(),这部分是非高亮结果,json字符串。还需要反序列为HotelDoc对象
- 第二步:获取高亮结果。hit.getHighlightFields(),返回值是一个Map,key是高亮字段名称,值是HighlightField对象,代表高亮值
- 第三步:从map中根据高亮字段名称,获取高亮字段值对象HighlightField
- 第四步:从HighlightField中获取Fragments,并且转为字符串。这部分就是真正的高亮字符串了
- 第五步:用高亮的结果替换HotelDoc中的非高亮结果