一、DSL查询文档
0.前言
Elasticsearch依然是基于JSON风格的DSL来定义查询。常见的查询类型包括:
-
查询所有:查询出所有数据,一般用于测试。例如:match_all
-
全文检索(full text)查询:先利用分词器对用户输入内容分词,然后再去倒排索引库中匹配查询。例如:
- match:根据单字段查询
- multi_match:根据多字段查询
-
精确查询:根据精确词条值查找数据,一般是查找keyword、数值、日期、boolean等类型字段,所以不会对搜索条件分词。例如:
- term:根据词条精确值查询
- range:根据值的范围查询
-
地理(geo)查询:根据经纬度查询。例如:
- geo_distance:查询到指定中心点小于某个距离值的所有文档。
- geo_bounding_box:查询坐标落在某个矩形范围的所有文档
-
复合(compound)查询:可以将上述各种查询条件组合起来,合并查询条件。例如:
- fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名
- bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索
各种查询的语法基本一致:
GET /indexName/_search
{
"query": {
"查询类型": {
"查询条件": "条件值"
}
}
}
1.查询所有
- 查询类型为match_all
- 没有查询条件
// 查询所有
GET /hotel/_search
{
"query": {
"match_all": {
}
}
}
类似的,其它查询无非就是查询类型、查询条件的变化。
2.全文检索查询
全文检索查询是先对用户输入的内容分词,再拿着词条去倒排索引库中检索匹配,因此参与搜索的字段也必须是可分词的text类型。
常见的有:
- match:根据单字段查询
- multi_match:根据多字段查询
(1)单字段查询
- 根据单字段
match查询,返回与倒排索引库中词条匹配的文档
语法如下(Field为字段,Text为值):
GET /hotel/_search
{
"query": {
"match": {
"FIELD": "TEXT"
}
}
}
注:all字段并不在查询结果中显示,但我们创建索引库时设置了all字段,通过copy_to实现多字段查询
(2)多字段查询
根据多字段multi_match查询,符合其中任意一个字段就算满足查询条件,返回与倒排索引库中词条匹配的文档
语法如下:
GET /hotel/_search
{
"query": {
"multi_match": {
"query": "TEXT",
"fields": ["FIELD1", " FIELD12"]
}
}
}
搜索字段越多,对查询性能影响越大,因此建议采用copy_to,然后使用单字段allmatch查询的方式。
3.精确查询
精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有:
- term:根据词条精确值查询
- range:根据值的范围查询
常用于对数据的精确筛选,例如:
- 商城搜索结果筛选
因为精确term查询的字段是不分词的字段,因此查询的条件也必须是不分词的词条。查询时,只有用户输入的内容跟字段值完全匹配时才认为符合条件。因此如果用户输入的内容过多,反而搜索不到数据。
(1)精确查询
语法说明:
// term查询
GET /hotel/_search
{
"query": {
"term": {
"FIELD": {
"value": "VALUE"
}
}
}
}
(2)范围查询
范围range查询,一般应用在对数值类型做范围过滤的时候。比如对价格、日期范围过滤,。
基本语法:
// range查询
GET /indexName/_search
{
"query": {
"range": {
"FIELD": {
"gte": number, // gte 代表大于等于,gt 代表大于
"lte": number // lte 代表小于等于,lt 代表小于
}
}
}
}
4.地理坐标查询
所谓的地理坐标查询,其实就是根据经纬度查询,官方文档
常见的有:
- geo_distance:查询到指定中心点小于某个距离值的所有文档。
- geo_bounding_box:查询坐标落在某个矩形范围的所有文档
常见的使用场景包括:
- 携程:搜索我附近的酒店
- 滴滴:搜索我附近的出租车
- 微信:搜索我附近的人
(1)附近查询
附近查询,也叫做距离查询geo_distance:查询到指定中心点小于某个距离值的所有文档。
换句话来说,在地图上找一个点作为圆心,以指定距离为半径,画一个圆,落在圆内的坐标都算符合条件:
语法说明:
// geo_distance 查询
GET /indexName/_search
{
"query": {
"geo_distance": {
"distance": "15km", // 半径
"FIELD": "31.21,121.5" // 圆心
}
}
}
(2)矩形范围查询
矩形范围查询,也就是geo_bounding_box查询:
查询时,需要指定矩形的左上、右下两个点的坐标,es会据此画出一个矩形,落在该矩形内的都是符合条件的点。
语法说明:
// 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
}
}
}
}
}
这种并不符合“附近的人”这样的需求。
5.复合查询
复合(compound)查询:复合查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种:
-
fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名
-
bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索
-
常见的使用场景包括:
- 广告排名靠前
- 根据多字段组合进行过滤
(1)相关性算分
当我们利用match查询时,文档结果会根据与搜索词条的关联度打分(_score),返回结果时按照分值降序排列。
在elasticsearch中,早期使用的打分算法是TF-IDF算法,如图:
在后来的5.1版本升级中,elasticsearch将算法改进为BM25算法,公式如下:
TF-IDF算法有一各缺陷,就是词条频率越高,文档得分也会越高,单个词条对文档影响较大。而BM25则会让单个词条的算分有一个上限,曲线更加平滑:
(2)算分函数查询
以百度为例,在搜索的结果中,并不是相关度越高排名越靠前,而是谁掏的钱多排名就越靠前。
要想人为控制相关性算分,就需要利用elasticsearch中的算法函数function score 查询了。
基础语法
function score的运行流程如下:
-
1)根据原始条件查询搜索文档,并且计算相关性算分,称为原始算分(query score)
-
2)根据过滤条件,过滤文档
-
3)符合过滤条件的文档,基于算分函数运算,得到函数算分(function score)
-
4)将原始算分(query score)和函数算分(function score)基于运算模式做运算,得到最终结果,作为相关性算分。
因此,其中的关键点是:
- 过滤条件:决定哪些文档的算分被修改
- 算分函数:决定函数算分的算法
- 运算模式:决定最终算分结果
需求:给“如家”这个品牌的酒店排名靠前一些
翻译一下这个需求,转换为之前说的四个要点:
- 原始条件:不确定,可以任意变化
- 过滤条件:brand = “如家”
- 算分函数:可以简单粗暴,直接给固定的算分结果,weight
- 运算模式:比如求和
因此最终的DSL语句如下:
GET /hotel/_search
{
"query": {
"function_score": {
"query": { .... }, // 原始查询,可以是任意条件
"functions": [ // 算分函数
{
"filter": { // 满足的条件,品牌必须是如家
"term": {
"brand": "如家"
}
},
"weight": 2 // 算分权重为2
}
],
"boost_mode": "sum" // 加权模式,求和
}
}
}
(3)布尔查询
布尔查询是一个或多个查询子句的组合,每一个子句就是一个子查询。子查询的组合方式有:
must:必须匹配每个子查询,类似“与”should:选择性匹配子查询,类似“或”must_not:必须不匹配,不参与算分,类似“非”filter:必须匹配,不参与算分
比如在搜索商品时,除了关键字搜索外,我们还可能根据品牌、价格、作用等字段做过滤:
每一个不同的字段,其查询的条件、方式都不一样,必须是多个不同的查询,而要组合这些查询,就必须用bool查询了。
需要注意的是,搜索时,参与打分的字段越多,查询的性能也越差。因此这种多条件查询时,建议这样做:
- 搜索框的关键字搜索,是全文检索查询,使用must查询,参与算分
- 其它过滤条件,采用filter查询。不参与算分
基础语法
GET /hotel/_search
{
"query": {
"bool": {
"must": [
{"term": {"city": "上海" }} // 必须匹配字段
],
"should": [
{"term": {"brand": "皇冠假日" }}, // 选择性匹配字段
{"term": {"brand": "华美达" }} // 选择性匹配字段
],
"must_not": [
{ "range": { "price": { "lte": 500 } }} // 必须不匹配字段,不参与算分
],
"filter": [
{ "range": {"score": { "gte": 45 } }} // 必须匹配字段,不参与算分
]
}
}
}
需求:搜索名字包含“如家”,价格不高于400,在坐标31.21,121.5周围10km范围内的酒店。
分析:
- 名称搜索,属于全文检索查询,应该参与算分。放到must中
- 价格不高于400,用range查询,属于过滤条件,不参与算分。放到must_not中
- 周围10km范围内,用geo_distance查询,属于过滤条件,不参与算分。放到filter中
二.搜索结果处理
1.排序
Es搜索的结果可以按照用户指定的方式去处理或展示。
es默认是根据相关度算分(_score)来排序,但是也支持自定义方式对搜索结果排序。可以排序字段类型有:keyword类型、数值类型、地理坐标类型、日期类型等。
(1)普通字段排序
keyword、数值、日期类型排序的语法基本一致。
基本语法:
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"FIELD": "desc" // 排序字段、排序方式ASC升序、DESC降序
}
]
}
排序条件是一个数组,也就是可以写多个排序条件。按照声明的顺序,当第一个条件相等时,再按照第二个条件排序,以此类推。
需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序
(2)地理坐标排序
地理坐标排序略有不同。
基本语法:
GET /indexName/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"_geo_distance" : {
"FIELD" : "纬度,经度", // 文档中geo_point类型的字段名、目标坐标点
"order" : "asc", // 排序方式
"unit" : "km" // 排序的距离单位
}
}
]
}
这个查询的含义是:
- 指定一个坐标,作为目标点
- 计算每一个文档中,指定字段(必须是geo_point类型)的坐标 到目标点的距离是多少
- 根据距离排序
需求描述:实现对酒店数据按照到31.034661,121.612282坐标的距离升序排序
注:坐标字段信息可分开写,也可以字符串形式写在一起。unit为指定单位,会在查询结果返回离指定坐标的距离(单位为unit)
2.分页
es默认情况下只返回top10的数据。如果要查询更多数据则需要修改分页参数。可以通过修改from、size参数来控制要返回的分页结果:
- from:从第几个文档开始
- size:总共查询几个文档
类似于mysql中的limit ?, ?
(1)基本分页
语法如下:
GET /hotel/_search
{
"query": {
"match_all": {}
},
"from": 0, // 从第几个文档开始,默认为0
"size": 10, // 总共查询几个文档
"sort": [
{"price": "asc"}
]
}
(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形成快照,保存在内存。官方已经不推荐使用。
3.使用对比
分页查询的常见实现方案以及优缺点
-
from + size:- 优点:支持随机翻页
- 缺点:深度分页问题,默认查询上限(from + size)是10000
- 场景:百度、京东、谷歌、淘宝这样的随机翻页搜索
-
after search:- 优点:没有查询上限(单次查询的size不超过10000)
- 缺点:只能向后逐页查询,不支持随机翻页
- 场景:没有随机翻页需求的搜索,例如手机向下滚动翻页
-
scroll:- 优点:没有查询上限(单次查询的size不超过10000)
- 缺点:会有额外内存消耗,并且搜索结果是非实时的
- 场景:海量数据的获取和迁移。从ES7.1开始不推荐,建议用 after search方案。
3.高亮
什么是高亮显示呢?
我们在百度,京东搜索时,关键字会变成红色,比较醒目,这叫高亮显示。
高亮显示的实现分为两步:
- 1)服务端(es)给文档中的所有关键字都添加一个标签,例如
<em>标签 - 2)前端提前给
<em>标签编写CSS样式
基本语法:
GET /hotel/_search
{
"query": {
"match": {
"FIELD": "TEXT" // 查询条件,高亮一定要使用全文检索查询
}
},
"highlight": {
"fields": { // 指定要高亮的字段
"FIELD": {
"pre_tags": "<em>", // 用来标记高亮字段的前置标签
"post_tags": "</em>" // 用来标记高亮字段的后置标签
}
}
}
}
注意:
-
高亮是对关键字高亮,因此搜索条件必须带有关键字,而不能是match_all之类的查询。
-
默认情况下,高亮的字段(highlight中指定的字段),必须与搜索指定的字段(query中指定的字段)一致,否则无法高亮
-
如果要对非搜索字段高亮,则需要添加一个属性:required_field_match=false
-
高亮字段可指定多个
三、RestClient查询文档
文档的查询同样是使用上一站学习到的RestHighLevelClient对象,其基本步骤也是类似的,包括:
- 1)准备Request对象
- 2)准备请求参数
- 3)发起请求
- 4)解析响应
1.查询所有match_all
-
第一步,创建
SearchRequest对象,指定索引库名 -
第二步,利用
request.source()构建DSL,DSL中可以包含查询、分页、排序、高亮等query():代表查询条件,利用QueryBuilders.matchAllQuery()构建一个match_all查询的DSL
-
第三步,利用client.search()发送请求,得到响应
这里关键的API有两个,一个是request.source(),其中包含了查询、排序、分页、高亮等所有功能:
另一个是QueryBuilders,其中包含match、term、function_score、bool等各种查询:
解析响应
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文档数据
-
@Test
void testMatchAll() throws IOException {
//1.准备request,指定hotel索引库名
SearchRequest request = new SearchRequest("hotel");
//2.准备DSL, 使用QueryBuilders实现类,而不是QueryBuilder接口
request.source().query(QueryBuilders.matchAllQuery());
//3.发送请求
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
//4.查询返回结果与es返回结果一致,重要信息在hits字段中(数据,响应时间,总条数等)
SearchHits hits = search.getHits();
long totol = hits.getTotalHits().value; //总条数
SearchHit[] hotels = hits.getHits(); //hits.hits存放查询单条结果返回值的集合
for(SearchHit hit : hotels) {
//hit获取单条数据,文档对象在_source对象中,解析_source得到文档信息
String json = hit.getSourceAsString();
System.out.println(json);
}
}
2.全文检索match multi_match
全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件,也就是query的部分。
因此,Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法:
而结果解析代码则完全一致,可以抽取并共享。
完整代码如下:
match单字段查询
@Test
void testMatch() throws IOException {
SearchRequest request = new SearchRequest("hotel");
request.source().query(QueryBuilders.matchQuery("all", "如家"));
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
multi_match多字段查询
@Test
void testMultiMatch() throws IOException {
SearchRequest request = new SearchRequest("hotel");
request.source().query(QueryBuilders.multiMatchQuery("如家外滩", "name", "brand", "business"));
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
3.精确查询term、range
精确查询主要是两者:
- term:词条精确匹配
- range:范围查询
与之前的查询相比,差异同样在查询条件,其它都一样。
查询条件构造的API如下:
完整代码如下:
term词条查询
@Test
void testTerm() throws IOException {
SearchRequest request = new SearchRequest("hotel");
request.source().query(QueryBuilders.termQuery("city", "杭州"));
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
range范围查询
@Test
void testRange() throws IOException {
SearchRequest request = new SearchRequest("hotel");
request.source().query(QueryBuilders.rangeQuery("price").gte(1000).lte(3000));
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
4.布尔查询
布尔查询是用must、must_not、filter等方式组合其它查询,代码示例如下:
可以看到,API与其它查询的差别同样是在查询条件的构建,QueryBuilders,结果解析等其他代码完全不变。
完整代码如下:
@Test
void testBool() throws IOException {
SearchRequest request = new SearchRequest("hotel");
//准备BoolQueryBuilder
BoolQueryBuilder boolQueryBuilder = new BoolQueryBuilder();
//添加must条件
boolQueryBuilder.must(QueryBuilders.termQuery("city", "上海"));
//添加filter过滤器
boolQueryBuilder.filter(QueryBuilders.rangeQuery("price").lte(250));
//准备DSL语句
request.source().query(boolQueryBuilder);
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
5.排序、分页
搜索结果的排序和分页是与query同级的参数,因此同样是使用request.source()来设置。
对应的API如下:
完整代码示例:
@Test
void testPageAndOrder() throws IOException {
int page = 1, size = 5; //第1页开始,页容量为5
SearchRequest request = new SearchRequest("hotel");
request.source().query(QueryBuilders.matchAllQuery());
//定义sort
request.source().sort("price", SortOrder.ASC);
//定义分页(从第五个数据开始,本次查询显示12个,本次查询显示5+12条数据)
//request.source().from(5).size(12);
request.source().from((page - 1) * size).size(size);
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
extracted(search);
}
6.高亮
高亮的代码与之前代码差异较大,有两点:
- 查询的DSL:其中除了查询条件,还需要添加高亮条件,同样是与query同级。
- 结果解析:结果除了要解析_source文档数据,还要解析高亮结果
上述图例省略了查询条件部分,但是大家不要忘了:高亮查询必须使用全文检索查询,并且要有搜索关键字,将来才可以对关键字高亮。
结果解析
高亮的结果与查询的文档结果默认是分离的,并不在一起。
因此解析高亮的代码需要额外处理:
完整代码如下:
@Test
void testHighLight() throws IOException {
SearchRequest request = new SearchRequest("hotel");
//准备全文检索
request.source().query(QueryBuilders.matchQuery("all", "如家"));
//指定高亮字段,与全文检索的字段不一致时,要将requireFieldMatch设为false
request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
SearchResponse search = client.search(request, RequestOptions.DEFAULT);
HighLightResponse(search);
}
private static void HighLightResponse(SearchResponse search) {
SearchHits hits = search.getHits();
long value = hits.getTotalHits().value;//总条数
SearchHit[] hits1 = hits.getHits();
for(SearchHit hit : hits1) {
String json = hit.getSourceAsString(); //获取每个文档的source内容即对应的hotelDoc对象部分
HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class); //解析HotelDoc对象
Map<String, HighlightField> highlightFields = hit.getHighlightFields(); //获取highlight高亮字段(key为高亮字段,value为对应值)
if(!CollectionUtils.isEmpty(highlightFields)) {
HighlightField name = highlightFields.get("name"); //获取高亮字段name对应的值,返回值为数组
if(name != null) {
String name1 = name.getFragments()[0].string(); //获取name数组中第一个元素,就是加上em标签后的值
hotelDoc.setName(name1);
}
}
System.out.println(hotelDoc);
}
}