备注:有误还望指正,本博客仅供学习参考,一起加油!
elasticSearch 的查询依然是基于JSON风格的DSL
来实现的。
elasticSearch 提供了基于 JSON的DSL(Domain Specific Language)
来定义查询。查询的语法基本一致:
GET /索引库名/_search
{
"query": {
"查询类型": {
"查询条件": "条件值"
}
}
}
常见的查询条件包括:
match_all
match_query
multi_match_query
ids
(根据id精确匹配)range
(根据数值范围查询)term
(按照词条精确值查询)geo_distance
geo_bounding_box
function_score
bool
我们以查询所有为例,其中:
// 查询所有
GET /索引库名/_search
{
"query": {
"match_all": {}
}
}
其它查询无非就是查询类型、查询条件的变化。
全文检索查询的基本流程如下:
比较常用的场景包括:
备注:因为是拿着词条去匹配,因此参与搜索的字段也必须是可分词的text类型的字段。
常见的全文检索查询包括:
match 查询
:单字段查询multi_match 查询
:多字段查询,任意一个字段符合条件就算符合查询条件match和multi_match的区别是什么?
match查询语法如下:
// 单字段查询
GET /索引库名/_search
{
"query": {
"match": {
"字段名": "值"
}
}
}
mulit_match语法如下:
// 多字段查询,任意一个字段符合条件就算符合查询条件
GET /索引库名/_search
{
"query": {
"multi_match": {
"query": "值",
"fields": ["字段名1", "字段名2", ...]
}
}
}
问题
:可以看到,两种查询结果是一样的,为什么?
- 答:因为我们将brand、name、city值都利用copy_to复制到了all字段中。因此你根据三个字段搜索,和根据all字段搜索效果当然一样了。
注意
:搜索字段越多,对查询性能影响越大,因此建议采用copy_to,然后单字段查询的方式。
精确查询一般是查找 keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有:
term
:根据词条精确值查询。一般搜索keyword类型、数值类型、布尔类型、日期类型字段。range
:根据值的范围查询。可以是数值、日期的范围。因为精确查询的字段是不分词的字段,因此查询的条件也必须是不分词的词条。查询时,用户输入的内容跟词条值完全匹配时才认为符合条件。如果用户输入的内容过多,反而搜索不到数据。
语法说明:
// term 查询
GET /索引库名/_search
{
"query": {
"term": {
"字段名": {
"value": "值"
}
}
}
}
示例:当我搜索的是精确词条时,能正确查询出结果:
但是,当我搜索的内容不是词条,而是多个词语形成的短语时,反而搜索不到:
范围查询,一般应用在对数值类型做范围过滤的时候。比如做价格范围过滤。
基本语法:
// range查询
GET /indexName/_search
{
"query": {
"range": {
"字段名": {
"gte": 10, // 这里的gte代表大于等于,gt则代表大于
"lte": 20 // lte代表小于等于,lt则代表小于
}
}
}
}
所谓的地理坐标查询,其实就是根据经纬度查询。
常见的使用场景包括:
矩形范围查询,也就是geo_bounding_box查询
,查询坐标落在某个矩形范围的所有文档;查询时,需要指定矩形的左上、右下两个点的坐标,然后画出一个矩形,落在该矩形内的都是符合条件的点。
语法如下:
// geo_bounding_box查询
GET /索引库名/_search
{
"query": {
"geo_bounding_box": {
"字段": {
"top_left": { // 左上点
"lat": 31.1,
"lon": 121.5
},
"bottom_right": { // 右下点
"lat": 30.9,
"lon": 121.7
}
}
}
}
}
附近查询,也叫做距离查询(geo_distance)
:查询到指定中心点小于某个距离值的所有文档。换句话来说,在地图上找一个点作为圆心,以指定距离为半径,画一个圆,落在圆内的坐标都算符合条件:
语法说明:
// geo_distance 查询
GET /索引库名/_search
{
"query": {
"geo_distance": {
"distance": "15km", // 半径
"字段名": "31.21,121.5" // 圆心
}
}
}
示例:我们先搜索上海市中心陆家嘴附近15km的酒店:(搜索显示有 47家)
复合(compound)查询:复合查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种:
fuction score
:算分函数查询,可以控制文档相关性算分,从而控制文档排名bool query
:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索 当我们利用 match 查询时,文档结果会根据与搜索词条的关联度打分(_score
),返回结果时按照分值降序排列。
例如,我们搜索 “虹桥如家”,结果如下:
[
{
"_score" : 17.850193,
"_source" : {
"name" : "虹桥如家酒店真不错",
}
},
{
"_score" : 12.259849,
"_source" : {
"name" : "外滩如家酒店真不错",
}
},
{
"_score" : 11.91091,
"_source" : {
"name" : "迪士尼如家酒店真不错",
}
}
]
小结:elasticSearch会根据词条和文档的相关度做打分,算法有两种:
注意
:TF-IDF算法有一个缺陷,就是词条频率越高,文档得分也会越高,单个词条对文档影响较大。而BM25则会让单个词条的算分有一个上限,曲线更加平滑。
根据相关度打分是比较合理的需求,但合理的不一定是产品经理需要的。
以百度为例,你搜索的结果中,并不是相关度越高排名越靠前,而是谁掏的钱多排名就越靠前。
要想人为控制相关性算分,就需要利用 elasticSearch 中的 function score
查询了。
1)语法说明:
function score 查询中包含四部分内容:
function score的运行流程如下:
因此,其中的关键点是:
2)示例:
需求:给“如家”这个品牌的酒店排名靠前一些
翻译一下这个需求,转换为之前说的四个要点:
因此最终的DSL语句如下:
GET /hotel/_search
{
"query": {
"function_score": {
"query": { .... }, // 原始查询,可以是任意条件
"functions": [ // 算分函数
{
"filter": { // 满足的条件,品牌必须是如家
"term": {
"brand": "如家"
}
},
"weight": 2 // 算分权重为2
}
],
"boost_mode": "sum" // 加权模式,求和
}
}
}
测试,在未添加算分函数时,如家得分如下:
添加了算分函数后,如家得分就提升了:
3)小结:
function score query 定义的三要素是什么?
过滤条件
:哪些文档要加分 (用filter把需要加分的文档筛选出来)。算分函数
:如何计算function score。加权方式
:function score 与 query score如何运算,常用的sum,multiply等,通过boost_mode来指定运算方式。布尔查询是一个或多个查询子句的组合,每一个子句就是一个子查询。子查询的组合方式有:
must
:必须匹配每个子查询,类似“与”should
:选择性匹配子查询,类似“或”must_not
:必须不匹配,不参与算分,类似“非”filter
:必须匹配,不参与算分比如在搜索酒店时,除了关键字搜索外,我们还可能根据品牌、价格、城市等字段做过滤:
每一个不同的字段,其查询的条件、方式都不一样,必须是多个不同的查询,而要组合这些查询,就必须用bool查询了。
需要注意的是,搜索时,参与打分的字段越多,查询的性能也越差。因此这种多条件查询时,建议这样做:
1)语法示例:
GET /hotel/_search
{
"query": {
"bool": {
"must": [
{"term": {"city": "上海" }}
],
"should": [
{"term": {"brand": "皇冠假日" }},
{"term": {"brand": "华美达" }}
],
"must_not": [
{ "range": { "price": { "lte": 500 } }}
],
"filter": [
{ "range": {"score": { "gte": 45 } }}
]
}
}
}
2)示例:
需求:搜索名字包含“如家”,价格不高于400,在坐标31.21,121.5周围10km范围内的酒店。
分析:
搜索的结果可以按照用户指定的方式去处理或展示。
elasticSearch 默认是根据相关度算分(_score)来排序,但是也支持自定义方式对搜索结果排序。可以排序字段类型有:keyword类型
、数值类型
、地理坐标类型
、日期类型
等。
keyword、数值、日期类型排序的语法基本一致。
语法:
GET /索引库名/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"字段名": "desc" // 排序字段、排序方式ASC、DESC
}
]
}
排序条件是一个数组,也就是可以写多个排序条件。按照声明的顺序,当第一个条件相等时,再按照第二个条件排序,以此类推。
示例:
需求描述:酒店数据按照用户评价(score)降序排序,评价相同的按照价格(price)升序排序
语法说明:
GET /索引库名/_search
{
"query": {
"match_all": {}
},
"sort": [
{
"_geo_distance" : {
"字段" : {
"lat": "纬度",
"lon": "经度"
}, // 文档中geo_point类型的字段名、目标坐标点
"order" : "asc", // 排序方式
"unit" : "km" // 排序的距离单位
}
}
]
}
这个查询的含义是:
工具:高德地图查看经纬度
示例:
需求描述:实现对酒店数据按照到你的位置坐标的距离升序排序;假设我的位置是:121.338689,31.202221,寻找我周围距离最近的酒店。
elasticSearch 默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数了。
elasticSearch 中通过修改from、size参数来控制要返回的分页结果:
from
:从第几个文档开始size
:总共查询几个文档类似于mysql中的limit ?, ?
分页的基本语法如下:
GET /索引库名/_search
{
"query": {
"match_all": {}
},
"from": 0, // 分页开始的位置,默认为0
"size": 10, // 期望获取的文档总数
"sort": [
{"字段": "asc"} // asc 或者 desc
]
}
现在,我要查询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,在另一个节点可能排到1000名以外了。
因此要想获取整个集群的TOP1000,必须先查询出每个节点的TOP1000,汇总结果后,在内存中重新排序选出前1000条文档。
那如果我要查询9900~10000的数据呢?是不是要先查询TOP10000呢?那每个节点都要查询10000条?汇总到内存中?
当分页查询的深度较大时(页数过多,或from+size过大),汇总数据过多,对内存和CPU会产生非常大的压力,因此elasticSearch会禁止from+ size 超过10000的请求。
针对深度分页,ES提供了两种解决方案,官方文档:
search after
:分页时需要排序,原理是从上一次的排序值开始,查询下一页数据。官方推荐使用的方式。scroll
:原理将排序后的文档id形成快照,保存在内存。官方已经不推荐使用。分页查询的常见实现方案以及优缺点:
from + size
:
after search
:
scroll
:
什么是高亮显示呢?我们在百度,京东搜索时,关键字会变成红色,比较醒目,这叫高亮显示。
高亮显示
的实现分为两步:
标签
标签编写CSS样式高亮的语法:
GET /索引库名/_search
{
"query": {
"match": {
"字段": "值" // 查询条件,高亮一定要使用全文检索查询
}
},
"highlight": {
"fields": { // 指定要高亮的字段
"字段": {
"pre_tags": "", // 用来标记高亮字段的前置标签
"post_tags": "" // 用来标记高亮字段的后置标签
}
}
}
}
注意:
示例:
补充:
当我们搜索的字段是组合字段 all ,但希望name中包含关键字的文档对应的关键字也能高亮,此时需要配置高亮字段的 "require_field_match":"false"
(默认为true)
查询的DSL是一个大的JSON对象,包含下列属性:
文档的查询同样适用昨天学习的 RestHighLevelClient对象,基本步骤包括:
我们以match_all查询为例
SearchRequest
对象,指定索引库名request.source()
构建DSL,DSL中可以包含查询、分页、排序、高亮等
query()
:代表查询条件,利用QueryBuilders.matchAllQuery()
构建一个match_all查询的DSL这里关键的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文档数据@SpringBootTest
public class HotelDocumentTest {
@Autowired
private IHotelService hotelService;
private RestHighLevelClient client;
//只能用junit5的依赖,所有crud测试方法之前执行的
@BeforeEach
void setUp() {
this.client = new RestHighLevelClient(RestClient.builder(HttpHost.create("http://服务器ip:9200")));
}
@Test
void testMatchAll() throws IOException{
// 1.准备 Request
SearchRequest request = new SearchRequest("hotel");
// 2.组织 DSL 参数
request.source().query(QueryBuilders.matchAllQuery());
// 3.发送请求,得到相应结果
SearchResponse response = client.search(request,RequestOptions.DEFAULT);
// 4.解析响应
this.handleResponse(response);
}
private void handleResponse(SearchResponse response){
// 4.解析响应
SearchHits searchHits = response.getHits();
// 4.1 获取总条数
long total = searchHits.getTotalHits().value;
System.out.println("共搜索到"+total+"条数据");
// 4.2 文档数组
SearchHit[] hitsHits = searchHits.getHits();
// 4.3 遍历数组元素
for (SearchHit hit : hitsHits) {
// 获取文档 source
String jsonStr = hit.getSourceAsString();
// 反序列化
HotelDoc hotelDoc = JSON.parseObject(jsonStr, HotelDoc.class);
System.out.println("hotelDoc = "+hotelDoc);
}
}
//tearDown方法用来释放资源,在所有crud测试方法之后执行的
@AfterEach
void tearDown() throws IOException {
this.client.close();
}
}
查询的基本步骤是:
- 创建SearchRequest对象
- 准备Request.source(),也就是DSL。
① QueryBuilders来构建查询条件。
② 传入Request.source() 的 query() 方法。- 发送请求,得到结果
- 解析结果(参考JSON结果,从外到内,逐层解析)
全文检索的 match 和 multi_match 查询与 match_all 的API基本一致。差别是查询条件,也就是query的部分。
因此,Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法:
完整代码如下:
@Test
void testMatch() throws IOException{
// 1.准备 Request
SearchRequest request = new SearchRequest("hotel");
// 2.准备 DSL
request.source().query(QueryBuilders.matchQuery("all","如家"));
// 3.发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
// 4.解析响应
this.handleResponse(response);
}
精确查询主要是两者:
与之前的查询相比,差异同样在查询条件,其它都一样。
function_score 查询 结构如下:
对应的JavaAPI如下:
注意:这里的原始查询条件可以换成布尔查询
QueryBuilders.boolQuery()
或者其他的查询。
布尔查询是用 must、must_not、filter 等方式组合其它查询,代码示例如下:
可以看到,API与其它查询的差别同样是在查询条件的构建,完整代码如下:
@Test
void testBool() throws IOException {
// 1.准备Request
SearchRequest request = new SearchRequest("hotel");
// 2.准备DSL
// 2.1.准备BooleanQuery
BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
// 2.2.添加term
boolQuery.must(QueryBuilders.termQuery("city", "杭州"));
// 2.3.添加range
boolQuery.filter(QueryBuilders.rangeQuery("price").lte(250));
request.source().query(boolQuery);
// 3.发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
// 4.解析响应
this.handleResponse(response);
}
搜索结果的排序和分页是与query同级的参数,因此同样是使用request.source()来设置。对应的API如下:
完整代码示例:
@Test
void testPageAndSort() throws IOException {
// 页码,每页大小
int page = 1, size = 5;
// 1.准备Request
SearchRequest request = new SearchRequest("hotel");
// 2.准备DSL
// 2.1.query
request.source().query(QueryBuilders.matchAllQuery());
// 2.2.排序 sort
request.source().sort("price", SortOrder.ASC);
// 2.3.分页 from、size
request.source().from((page - 1) * size).size(5);
// 3.发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
// 4.解析响应
handleResponse(response);
}
高亮的代码与之前代码差异较大,有两点:
上述代码省略了查询条件部分,但是:
高亮查询必须使用全文检索查询,并且要有搜索关键字
,将来才可以对关键字高亮。
完整代码如下:
@Test
void testHighlight() throws IOException{
// 1.准备 Request
SearchRequest request = new SearchRequest("hotel");
// 2.准备 DSL
// 2.1 查询条件
request.source().query(QueryBuilders.matchQuery("all","如家"));
// 2.2 高亮
request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
// 3.发送请求
SearchResponse response = client.search(request, RequestOptions.DEFAULT);
// 4.解析响应
this.handleResponse(response);
}
高亮的结果与查询的文档结果默认是分离的,并不在一起。因此解析高亮的代码需要额外处理:
代码解读:
完整代码如下:
//处理响应的方法
private void handleResponse(SearchResponse response){
// 4.解析响应
SearchHits searchHits = response.getHits();
// 4.1 获取总条数
long total = searchHits.getTotalHits().value;
System.out.println("共搜索到"+total+"条数据");
// 4.2 文档数组
SearchHit[] hitsHits = searchHits.getHits();
// 4.3 遍历数组元素
for (SearchHit hit : hitsHits) {
// 获取文档 source
String jsonStr = hit.getSourceAsString();
// 反序列化
HotelDoc hotelDoc = JSON.parseObject(jsonStr, HotelDoc.class);
// 获取高亮结果
Map<String, HighlightField> highlightFields = hit.getHighlightFields();
if (!CollectionUtils.isEmpty(highlightFields)){
// 根据字段名获取高亮结果
HighlightField highlightField = highlightFields.get("name");
if (highlightField != null){
// 获取高亮值
String name = highlightField.getFragments()[0].string();
// 覆盖非高亮结果
hotelDoc.setName(name);
}
}
System.out.println("hotelDoc = " + hotelDoc);
}
}