Elasticsearch-02

往期Java学习笔记
一、SpringCloud
二、Docker
三、RabbitMQ
四、Elasticsearch-01
五、Elasticsearch-02
六、Elasticsearch-03
七、Sentinel

---

---

Elasticsearch-02

一、DSL查询文档

1.1 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": {
    "查询类型": {
      "查询条件": "条件值"
    }
  }
}

1.2 查询所有

我们以查询所有为例，其中：

• 查询类型为match_all
• 没有查询条件

# 查询所有简单写法
GET /indexName/_search

# 查询所有标准写法
GET /indexName/_search
{
  "query": {
    "match_all": {}
  }
}

其它查询无非就是查询类型、查询条件的变化。

1.3 全文检索查询

1.3.1 使用场景

全文检索查询的基本流程如下：

• 对用户搜索的内容做分词，得到词条
• 根据词条去倒排索引库中匹配，得到文档id
• 根据文档id找到文档，返回给用户

比较常用的场景包括：

• 商城的输入框搜索
• 百度输入框搜索

例如京东：

因为是拿着词条去匹配，因此参与搜索的字段也必须是可分词的text类型的字段。

1.3.2 基本语法

常见的全文检索查询包括：

• match查询：单字段查询
• multi_match查询：多字段查询，任意一个字段符合条件就算符合查询条件

match查询语法如下：

GET /indexName/_search
{
  "query": {
    "match": {
      "FIELD": "TEXT"
    }
  }
}

FIELD:指的是字段名，name，brand那些

mulit_match语法如下：

GET /indexName/_search
{
  "query": {
    "multi_match": {
      "query": "TEXT",
      "fields": ["FIELD1", " FIELD12"]
    }
  }
}

query:要查询的文本
fields:字段的集合

1.3.3 示例

（1）单字段查询

match查询示例：

GET /hotel/_search
{
  "query": {
    "match": {
      "all": "哈哈哈"
    }
  }
}

（2）多字段查询

multi_match查询示例：

GET /hotel/_search
{
  "query": {
    "multi_match": {
      "query": "如家汉庭",
      "fields": ["name","all"]
    }
  }
}

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

（3）query_string

query_string查询示例：

## 多字段查询query_string 结果可以是交集或者并集 AND 或 OR
GET /hotel/_search
{
  "query": {
    "query_string": {
      "default_field": "all",
      "query": "北京 or 酒店"
    }
  }
}

（4）simple_query_string

simple_query_string查询示例：

## 多字段查询simple_query_string 结果可以是交集或并集 + 或 |
GET /hotel/_search
{
  "query": {
    "simple_query_string": {
      "query": "北京+酒店",
      "fields": ["all","name"]
    }
  }
}

1.3.4 总结

match和multi_match的区别是什么？

• match：根据一个字段查询
• multi_match：根据多个字段查询，参与查询字段越多，查询性能越差

1.4 精准查询

精确查询一般是查找keyword、数值、日期、boolean等类型字段。所以不会对搜索条件分词。常见的有：

• term：根据词条精确值查询
• range：根据值的范围查询

1.4.1 term查询

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

语法说明：

// term查询
GET /indexName/_search
{
  "query": {
    "term": {
      "FIELD": {
        "value": "VALUE"
      }
    }
  }
}

示例：

## term查询
GET /hotel/_search
{
  "query": {
    "term": {
      "city": {
        "value": "北京"
      }
    }
  }
}

但是，当我搜索的内容不是词条，而是多个词语形成的短语时，反而搜索不到：

1.4.2 range查询

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

// range查询
GET /indexName/_search
{
  "query": {
    "range": {
      "FIELD": {
        "gte": 10, // 这里的gte代表大于等于，gt则代表大于
        "lte": 20 // lte代表小于等于，lt则代表小于
      }
    }
  }
}

示例：

## range查询
GET /hotel/_search
{
  "query": {
    "range":{
      "price": {
        "gte": 10,
        "lte": 20
      }
    }
  }
}

1.4.3 ids查询

## 根据id查询
## IDS查询
GET /hotel/_search
{
  "query": {
    "ids": {
      "values": ["598591"]
    }
  }
}

1.4.4 总结

精确查询常见的有哪些？

• term查询：根据词条精确匹配，一般搜索keyword类型、数值类型、布尔类型、日期类型字段
• range查询：根据数值范围查询，可以是数值、日期的范围

1.5 地理查询

1.5.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
        }
      }
    }
  }
}

FILED:是可以进行地理坐标查询的字段
示例：

# 矩形范围查询
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.5.2 附近查询（距离查询）

附近查询，也叫做距离查询（geo_distance）：查询到指定中心点小于某个距离值的所有文档。

换句话来说，在地图上找一个点作为圆心，以指定距离为半径，画一个圆，落在圆内的坐标都算符合条件：

语法说明：

// geo_distance 查询
GET /indexName/_search
{
  "query": {
    "geo_distance": {
      "distance": "15km", // 半径
      "FIELD": "31.21,121.5" // 圆心
    }
  }
}

示例：

# 圆形范围查询
GET /hotel/_search
{
  "query": {
    "geo_distance":{
      "distance":"5km",
      "location":"31.21,121.5"
    }
  }
}

1.6 复合查询

复合（compound）查询：复合查询可以将其它简单查询组合起来，实现更复杂的搜索逻辑。常见的有两种：

• fuction score：算分函数查询，可以控制文档相关性算分，控制文档排名
• bool query：布尔查询，利用逻辑关系组合多个其它的查询，实现复杂搜索

1.6.1 相关性算分

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

例如，我们搜索 “虹桥如家”，结果如下：

[
  {
    "_score" : 17.850193,
    "_source" : {
      "name" : "虹桥如家酒店真不错",
    }
  },
  {
    "_score" : 12.259849,
    "_source" : {
      "name" : "外滩如家酒店真不错",
    }
  },
  {
    "_score" : 11.91091,
    "_source" : {
      "name" : "迪士尼如家酒店真不错",
    }
  }
]

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

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

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

小结：elasticsearch会根据词条和文档的相关度做打分，算法由两种：

• TF-IDF算法
• BM25算法，elasticsearch5.1版本后采用的算法

1.6.2 算分函数查询

根据相关度打分是比较合理的需求，但合理的不一定是产品经理需要的。

以百度为例，你搜索的结果中，并不是相关度越高排名越靠前，而是谁掏的钱多排名就越靠前。如图：

要想认为控制相关性算分，就需要利用elasticsearch中的function score 查询了。

（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语句如下：

GET /hotel/_search
{
  "query": {
    "function_score": {
      "query": {  .... }, // 原始查询，可以是任意条件
      "functions": [ // 算分函数
        {
          "filter": { // 满足的条件，品牌必须是如家
            "term": {
              "brand": "如家"
            }
          },
          "weight": 2 // 算分权重为2
        }
      ],
      "boost_mode": "sum" // 加权模式，求和
    }
  }
}

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

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

（3）小结

function score query定义的三要素是什么？

• 过滤条件：哪些文档要加分
• 算分函数：如何计算function score
• 加权方式：function score 与 query score如何运算

1.6.3 布尔查询

布尔查询是一个或多个查询子句的组合，每一个子句就是一个子查询。子查询的组合方式有：

• must：必须匹配每个子查询，类似“与”
• should：选择性匹配子查询，类似“或”
• must_not：必须不匹配，不参与算分，类似“非”
• filter：必须匹配，不参与算分

比如在搜索酒店时，除了关键字搜索外，我们还可能根据品牌、价格、城市等字段做过滤：

每一个不同的字段，其查询的条件、方式都不一样，必须是多个不同的查询，而要组合这些查询，就必须用bool查询了。

需要注意的是，搜索时，**参与打分的字段越多，查询的性能也越差。**因此这种多条件查询时，建议这样做：

• 搜索框的关键字搜索，是全文检索查询，使用must查询，参与算分
• 其它过滤条件，采用filter查询。不参与算分

（1）示例：

GET /hotel/_search
{
  "query": {
    "bool": {
      "must": [
        {
          "match": {
            "all": "如家"
          }
        }
      ]
      ,
      "must_not": [
        {
          "range": {
            "price": {
              "gte":400
            }
          }
        }
      ]
      ,
      "filter": [
        {
          "geo_distance": {
            "distance": "10km",
            "location": {
              "lat": 31.21,
              "lon": 121.5
            }
          }
        }
      ]
    }
  }
}

（2）小结

bool查询有几种逻辑关系？

• must：必须匹配的条件，可以理解为“与”
  • 一般是搜索的关键字
• should：选择性匹配的条件，可以理解为“或”
• must_not：必须不匹配的条件，不参与打分
  • 除了搜索的关键字，其他条件最好放在这里
• filter：必须匹配的条件，不参与打分
  • 除了搜索的关键字，其他条件最好放在这里

二、搜索结果处理

搜索的结果可以按照用户指定的方式去处理或展示。

2.1 排序

elasticsearch默认是根据相关度算分（_score）来排序，但是也支持自定义方式对搜索结果排序。可以排序字段类型有：keyword类型、数值类型、地理坐标类型、日期类型等。

2.1.1 普通字段排序

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

（1）语法

GET /indexName/_search
{
  "query": {
    "match_all": {}
  },
  "sort": [
    {
      "FIELD": "desc"  // 排序字段、排序方式ASC、DESC
    }
  ]
}

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

（2）示例

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

GET /hotel/_search
{
  "query": {
    "match": {
      "all": "上海酒店"
    }
  }
  ,
  "sort": [
    {
      "score": {
        "order": "desc"
      }
      ,
      "price": {
        "order": "asc"
      }
    }
  ]
}

2.1.2 地理坐标排序

（1）语法

GET /indexName/_search
{
  "query": {
    "match_all": {}
  },
  "sort": [
    {
      "_geo_distance" : {
          "FIELD" : "纬度，经度", // 文档中geo_point类型的字段名、目标坐标点
          "order" : "asc", // 排序方式
          "unit" : "km" // 排序的距离单位
      }
    }
  ]
}

这个查询的含义是：

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

（2）示例

需求描述：实现对酒店数据按照到你的位置坐标的距离升序排序

提示：获取你的位置的经纬度的方式：https://lbs.amap.com/demo/jsapi-v2/example/map/click-to-get-lnglat/

假设我的位置是：31.034661，121.612282，寻找我周围距离最近的酒店。

GET /hotel/_search
{
  "query": {
    "match": {
      "all": "上海酒店"
    }
  }
  ,
  "sort": [
    {
      "_geo_distance": {
        "location": {
          "lat": 31.21,
          "lon": 121.5
        },
        "order": "asc"
      }
    }
  ]
}

2.2 分页

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

• from：从第几个文档开始
• size：总共查询几个文档

类似于mysql中的limit ?, ?

2.2.1 基本的分页

分页的基本语法如下：

GET /hotel/_search
{
  "query": {
    "match_all": {}
  },
  "from": 0, // 分页开始的位置，默认为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。

深度分页的问题

elasticsearch会禁止from+size超过10000的请求，因为搜索页数过深，或者结果集越大，对内存和CPU的消耗也就也高，因此，ES设定结果集查询的上限是10000

针对深度分页，ES提供了两种解决方案，官方文档：

• search after：分页时需要排序，原理是从上一次的排序值开始，查询下一页数据。官方推荐使用的方式。
• scroll：原理将排序后的文档id形成快照，保存在内存。官方已经不推荐使用。

2.2.2 小结

分页查询的常见实现方案以及优缺点：

• 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 实现高亮

（1）语法

GET /hotel/_search
{
  "query": {
    "match": {
      "FIELD": "TEXT" // 查询条件，高亮一定要使用全文检索查询
    }
  },
  "highlight": {
    "fields": { // 指定要高亮的字段
      "FIELD": {
        "pre_tags": "<em>",  // 用来标记高亮字段的前置标签
        "post_tags": "</em>" // 用来标记高亮字段的后置标签
      }
    }
  }
}

（2）注意

• 高亮是对关键字高亮，因此搜索条件必须带有关键字，而不能是范围这样的查询。
• 默认情况下，高亮的字段，必须与搜索指定的字段一致，否则无法高亮，如果要对非搜索字段高亮，则需要添加一个属性：required_field_match=false
• 加高亮标签的地方，不是搜索的关键词，而是通过分词器对搜索的关键词进行分词得到的词条进行高亮

（3）示例

## 高亮 ，北京如家酒店，结果里名称的值出现词条就高亮显示
GET /hotel/_search
{
  "query": {
    "match": {
      "all": "北京如家酒店"
    }
  }
  ,
  "highlight": {
    "require_field_match": "false", 
    "fields": {
      "name": {
        "pre_tags": "<em>",
        "post_tags": "</em>"
      }
    }
  }
}

2.4 总结

2.4.总结

查询的DSL是一个大的JSON对象，包含下列属性：

• query：查询条件
• from和size：分页条件
• sort：排序条件
• highlight：高亮条件

示例：

三、RestClient查询文档

文档的查询同样使用之前的 RestHighLevelClient对象，基本步骤包括：

• 1）准备Request对象
• 2）准备请求参数
• 3）发起请求
• 4）解析响应

3.1 快速入门

我们以match_all查询为例

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.1.3 完整代码

完整代码如下：

// 省略了初始化RestHighLevelClient客户端、关闭客户端的步骤，前面的文章有
/**
 * 测试文档搜索
 */
@Test
public void testSearchDocument() throws IOException {
	// 1.构建搜索请求对象
	SearchRequest request = new SearchRequest("hotel");
	// 2.设置查询条件
	// 设置查询条件-查询全部
	request.source().from(100);
	request.source().size(100);
	request.source().query(QueryBuilders.matchAllQuery());
	// 3.执行搜索请求得到搜索结果
	SearchResponse response = client.search(request, RequestOptions.DEFAULT);
	// 4.从搜索响应结果从外到内逐层解析命中的结果数据
	SearchHits hits = response.getHits();
	// 总条数
	long value = hits.getTotalHits().value;
	// 文档对象集合
	SearchHit[] hitsHits = hits.getHits();
	if (hitsHits != null && hitsHits.length > 0){
		// hitsHit 表示每一个文档对象
		for (SearchHit hitsHit : hitsHits) {
			// 每一个文档JSON字符串
			String sourceAsString = hitsHit.getSourceAsString();
			// 默认输出前10条
			System.out.println(sourceAsString);
		}
	}
}

3.1.4 小结

查询的基本步骤是：

1. 创建SearchRequest对象
2. 准备Request.source()，也就是DSL。
   ① QueryBuilders来构建查询条件
   ② 传入Request.source() 的 query() 方法
3. 发送请求，得到结果
4. 解析结果（参考JSON结果，从外到内，逐层解析）

3.2 全文检索查询

全文检索的match和multi_match查询与match_all的API基本一致。差别是查询条件，也就是query的部分。

// 设置查询条件-查询全部 match_all
request.source().query(QueryBuilders.matchAllQuery());
// 全文检索查询-单字段查询
request.source().query(QueryBuilders.matchQuery("all","如家酒店"));
// 全文检索查询- 多字段查询
request.source().query(QueryBuilders.multiMatchQuery("如家酒店","all","name"));
// query_string
request.source().query(QueryBuilders.queryStringQuery("如家酒店").field("all").field("name").defaultOperator(Operator.OR));

3.3 精确查询

精确查询主要是两者：

• term：词条精确匹配
• range：范围查询
  补充：ids查询

// 精确查询-IDS查询
request.source().query(QueryBuilders.idsQuery().addIds("598591"));
// 精确查询-term查询
request.source().query(QueryBuilders.termQuery("city","北京"));
// 精确查询-range查询
request.source().query(QueryBuilders.rangeQuery("price").gte(100).lte(300));

3.4 复合查询

3.4.1 boolean query

//  复合查询-布尔查询
BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
boolQueryBuilder.must(QueryBuilders.termQuery("city","北京"));
boolQueryBuilder.filter(QueryBuilders.rangeQuery("price").gte(300));
request.source().query(boolQueryBuilder);

3.4.2 function score

// 复合查询-算分函数查询
MatchQueryBuilder matchQueryBuilder = QueryBuilders.matchQuery("all", "北京酒店");
FunctionScoreQueryBuilder functionScoreQueryBuilder = QueryBuilders.functionScoreQuery(matchQueryBuilder,new FunctionScoreQueryBuilder.FilterFunctionBuilder[]{
		new FunctionScoreQueryBuilder.FilterFunctionBuilder(QueryBuilders.termQuery("brand","如家"),
				ScoreFunctionBuilders.weightFactorFunction(10))
}).boostMode(CombineFunction.SUM);
request.source().query(functionScoreQueryBuilder);

3.5 地理位置查询-圆形

request.source().query(QueryBuilders.geoDistanceQuery("location").distance("10km").point(31.21,121.5));

3.6 分页、排序和高亮

3.6.1 分页和排序

// 查询
request.source().query(QueryBuilders.matchAllQuery());
// 分页
request.source().from(0).size(5);
// 价格排序
request.source().sort("price",SortOrder.ASC);

3.6.2 高亮

（1）高亮请求构建

高亮请求的构建API如下：

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

@Test
void testHighlight() throws IOException {
    // 1.准备Request
    SearchRequest request = new SearchRequest("hotel");
    // 2.准备DSL
    // 2.1.query
    request.source().query(QueryBuilders.matchQuery("all", "如家"));
    // 2.2.高亮
    request.source().highlighter(
			new HighlightBuilder().field("name").requireFieldMatch(false).
			preTags("<em>").
			postTags("</em>")
	);
    // 3.发送请求
    SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    // 4.解析响应
    handleResponse(response);
}

（2）高亮结果解析

代码解读：

• 第一步：从结果中获取source。hit.getSourceAsString()，这部分是非高亮结果，json字符串。还需要反序列为HotelDoc对象
• 第二步：获取高亮结果。hit.getHighlightFields()，返回值是一个Map，key是高亮字段名称，值是HighlightField对象，代表高亮值
• 第三步：从map中根据高亮字段名称，获取高亮字段值对象HighlightField
• 第四步：从HighlightField中获取Fragments，并且转为字符串。这部分就是真正的高亮字符串了
• 第五步：用高亮的结果替换HotelDoc中的非高亮结果

完整代码如下：

private void handleResponse(SearchResponse response) {
    // 4.解析响应
    SearchHits searchHits = response.getHits();
    // 4.1.获取总条数
    long total = searchHits.getTotalHits().value;
    System.out.println("共搜索到" + total + "条数据");
    // 4.2.文档数组
    SearchHit[] hits = searchHits.getHits();
    // 4.3.遍历
    for (SearchHit hit : hits) {
        // 获取文档source
        String json = hit.getSourceAsString();
        // 反序列化
        HotelDoc hotelDoc = JSON.parseObject(json, 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);
    }
}

四、黑马旅游案例

4.1 关键词搜索和结果分页

4.1.1 需求分析

点击搜索按钮，可以看到浏览器控制台发出了请求：

请求参数如下：

由此可以知道，我们这个请求的信息如下：

• 请求方式：POST
• 请求路径：/hotel/list
• 请求参数：JSON对象，包含4个字段：
  • key：搜索关键字
    • key要考虑两种情况 1.为空 2.有值
  • page：页码
  • size：每页大小
  • sortBy：排序，目前暂不实现
• 返回值：分页查询，需要返回分页结果PageResult，包含两个属性：
  • total：总条数
  • List<HotelDoc>：当前页的数据

因此，我们实现业务的流程如下：

• 步骤一：定义实体类，接收请求参数的JSON对象
• 步骤二：编写controller，接收页面的请求
• 步骤三：编写业务实现，利用RestHighLevelClient实现搜索、分页

4.1.2 定义实体类

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

（1）请求参数

前端请求的json结构如下：

{
    "key": "搜索关键字",
    "page": 1,
    "size": 3,
    "sortBy": "default"
}

因此，我们在cn.itcast.hotel.pojo包下定义一个实体类：

package cn.itcast.hotel.pojo;

import lombok.Data;

@Data
public class RequestParams {
    private String key;
    private Integer page;
    private Integer size;
    private String sortBy;
}

（2）返回值

分页查询，需要返回分页结果PageResult，包含两个属性：

• total：总条数
• List<HotelDoc>：当前页的数据

因此，我们在cn.itcast.hotel.pojo中定义返回结果：

package cn.itcast.hotel.pojo;

import lombok.Data;

import java.util.List;

@Data
public class PageResult {
    private Long total;
    private List<HotelDoc> hotels;

    public PageResult() {
    }

    public PageResult(Long total, List<HotelDoc> hotels) {
        this.total = total;
        this.hotels = hotels;
    }
}

4.1.3 定义controller

定义一个HotelController，声明查询接口，满足下列要求：

• 请求方式：Post
• 请求路径：/hotel/list
• 请求参数：对象，类型为RequestParam
• 返回值：PageResult，包含两个属性
  • Long total：总条数
  • List hotels：酒店数据

因此，我们在cn.itcast.hotel.web中定义HotelController：

@RestController
@RequestMapping("/hotel")
public class HotelController {

    @Autowired
    private IHotelService hotelService;
	// 搜索酒店数据
    @PostMapping("/list")
    public PageResult search(@RequestBody RequestParams params){
        return hotelService.search(params);
    }
}

4.1.4 实现搜索业务

我们在controller调用了IHotelService，并没有实现该方法，因此下面我们就在IHotelService中定义方法，并且去实现业务逻辑。

（1）在cn.itcast.hotel.service中的IHotelService接口中定义一个方法：

/**
 * 根据关键字搜索酒店信息
 * @param params 请求参数对象，包含用户输入的关键字 
 * @return 酒店文档列表
 */
PageResult search(RequestParams params);

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

@Bean
public RestHighLevelClient client(){
    return  new RestHighLevelClient(RestClient.builder(
        HttpHost.create("http://192.168.150.101:9200")
    ));
}

（3）在cn.itcast.hotel.service.impl中的HotelService中实现search方法：

@Service
public class HotelService extends ServiceImpl<HotelMapper, Hotel> implements IHotelService {

    @Autowired
    private RestHighLevelClient client;

    @Override
    public PageResult search(RequestParams requestParams) {

        // 1. 构建搜索请求对象 --- 参数写索引库的名称
        SearchRequest searchRequest = new SearchRequest("hotel");
        // 2. 设置查询条件
        // 参数的key有两种情况
        // 1. 没有值，为空，为空的时候查询全部 --- match_all
        // 2. 有值，不为空，不为空的话就根据关键词来查询
        // isNotBlank和isNotEmpty的区别
        // isNotEmpty只会判断 空 和 空字符串，不能判断空格
        // isNotBlank可以判断空格
        if (StringUtils.isBlank(requestParams.getKey())) {
            searchRequest.source().query(QueryBuilders.matchAllQuery());
        } else {    // 如果搜索关键词不为空，则根据all，进行单字段全文检索
            searchRequest.source().query(QueryBuilders.matchQuery("all",requestParams.getKey()));
        }
        // 3. 设置查询结果要求
        // from的值是 (page - 1)*size
        // 查询开始的值
        searchRequest.source().from((requestParams.getPage()-1)* requestParams.getSize());
        // 查询条数
        searchRequest.source().size(requestParams.getSize());
        try {
            // 4. 执行搜索请求
            SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
            // 5. 从结果中解析酒店数据
            SearchHits hits = searchResponse.getHits();
            // 构建酒店列表
            List<HotelDoc> hotelDocList = new ArrayList<>();
            // 复合条件的总条数
            long total = hits.getTotalHits().value;
            SearchHit[] searchHits = hits.getHits();
            if (searchHits != null && searchHits.length > 0) {
                for (SearchHit searchHit : searchHits) {
                    // 每个酒店的json字符串
                    String hotelJson = searchHit.getSourceAsString();
                    // 返回给前端需要的是一个doc
                    HotelDoc hotelDoc = JSON.parseObject(hotelJson, HotelDoc.class);
                    hotelDocList.add(hotelDoc);

                }
            }
            return new PageResult(total,hotelDocList);

        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

4.2 多条件过滤查询

4.2.1 需求分析

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

传递的参数如图：

包含的过滤条件有：

• brand：品牌值
• city：城市
• minPrice~maxPrice：价格范围
• starName：星级

我们需要做两件事情：

• 修改请求参数的对象RequestParams，接收上述参数
• 修改业务逻辑，在搜索条件之外，添加一些过滤条件

4.2.2 修改实例类

修改在cn.itcast.hotel.pojo包下的实体类RequestParams：

// 下面是新增的过滤条件参数
    private String city;
    private String brand;
    private String starName;
    private Integer minPrice;
    private Integer maxPrice;

4.2.3 修改搜索业务

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

在之前的业务中，只有match查询，根据关键字搜索，现在要添加条件过滤，包括：

• 品牌过滤：是keyword类型，用term查询
• 星级过滤：是keyword类型，用term查询
• 价格过滤：是数值类型，用range查询
• 城市过滤：是keyword类型，用term查询

多个查询条件组合，肯定是boolean查询来组合：

• 关键字搜索放到must中，参与算分
• 其它过滤条件放到filter中，不参与算分

if (StringUtils.isBlank(requestParams.getKey())) {
    boolQueryBuilder.must(QueryBuilders.matchAllQuery());
} else {    // 如果搜索关键词不为空，则根据all，进行单字段全文检索
    boolQueryBuilder.must(QueryBuilders.matchQuery("all",requestParams.getKey()));
}
// 如果请求城市参数不为空，则根据城市进行term过滤
if (StringUtils.isNotBlank(requestParams.getCity())){
    boolQueryBuilder.filter(QueryBuilders.termQuery("city",requestParams.getCity()));
}
// 如果请求星级参数不为空，则根据星级进行term过滤
if (StringUtils.isNotBlank(requestParams.getStarName())){
    boolQueryBuilder.filter(QueryBuilders.termQuery("starName",requestParams.getStarName()));
}
// 如果请求品牌参数不为空，则根据品牌进行term过滤
if (StringUtils.isNotBlank(requestParams.getBrand())){
    boolQueryBuilder.filter(QueryBuilders.termQuery("brand",requestParams.getBrand()));
}
// 如果价格参数有值，则根据价格进行范围range过滤
if (requestParams.getMinPrice() != null) {
    boolQueryBuilder.filter(QueryBuilders.rangeQuery("price").gte(requestParams.getMinPrice()));
}
if (requestParams.getMaxPrice() != null) {
    boolQueryBuilder.filter(QueryBuilders.rangeQuery("price").lte(requestParams.getMaxPrice()));
}

searchRequest.source().query(boolQueryBuilder);

4.3 附近酒店查询

4.3.1 需求分析

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

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

我们要做的事情就是基于这个location坐标，然后按照距离对周围酒店排序。实现思路如下：

• 修改RequestParams参数，接收location字段
• 修改search方法业务逻辑，如果location有值，添加根据geo_distance排序的功能

4.3.2 修改实体类

修改在cn.itcast.hotel.pojo包下的实体类RequestParams：

// 我当前的地理坐标
private String location;

4.3.3 距离排序api

我们以前学习过排序功能，包括两种：

• 普通字段排序
• 地理坐标排序

我们只讲了普通字段排序对应的java写法。地理坐标排序只学过DSL语法，如下：

GET /indexName/_search
{
  "query": {
    "match_all": {}
  },
  "sort": [
    {
      "price": "asc"  
    },
    {
      "_geo_distance" : {
          "FIELD" : "纬度，经度",
          "order" : "asc",
          "unit" : "km"
      }
    }
  ]
}

对应的java代码示例：

4.3.4 添加距离排序

String location = params.getLocations();
if (StringUtils.isNotBlank(requestParams.getLocation())) {
	searchRequest.source().sort(sortBuilders
		.geoDistanceSort("location", new GeoPoint(requestParams.getLocation))
		.order(SortOrder.ASC)
		.unit(DistanceUnit.KILOMETERS)
		);
}

4.3.5 排序距离显示

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

发现确实可以实现对我附近酒店的排序，不过并没有看到酒店到底距离我多远，这该怎么办？
排序完成后，页面还要获取我附近每个酒店的具体距离值，这个值在响应结果中是独立的：

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

我们要做两件事：

• 修改HotelDoc，添加排序距离字段，用于页面显示
• 修改HotelService类中的handleResponse方法，添加对sort值的获取

（1）修改HotelDoc类，添加距离字段

// 排序时的 距离值
private Object distance;

（2）修改HotelService中的handleResponse方法

4.4 酒店竞价排名

4.4.1 需求分析

要让指定酒店在搜索结果中排名置顶，效果如图：

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

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

我们之前学习过的function_score查询可以影响算分，算分高了，自然排名也就高了。而function_score包含3个要素：

• 过滤条件：哪些文档要加分
• 算分函数：如何计算function score
• 加权方式：function score 与 query score如何运算

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

比如，我们给酒店添加一个字段：isAD，Boolean类型：

• true：是广告
• false：不是广告

这样function_score包含3个要素就很好确定了：

• 过滤条件：判断isAD 是否为true
• 算分函数：我们可以用最简单暴力的weight，固定加权值
• 加权方式：可以用默认的相乘，大大提高算分

因此，业务的实现步骤包括：

1. 给HotelDoc类添加isAD字段，Boolean类型
2. 挑选几个你喜欢的酒店，给它的文档数据添加isAD字段，值为true
3. 修改search方法，添加function score功能，给isAD值为true的酒店增加权重

4.4.2 修改实体

给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中，接下来就是添加过滤条件、算分函数、加权模式了。所以原来的代码依然可以沿用。

// 2.算分控制
FunctionScoreQueryBuilder functionScoreQuery =
    QueryBuilders.functionScoreQuery(
    // 原始查询，相关性算分的查询
    boolQuery,
    // function score的数组
    new FunctionScoreQueryBuilder.FilterFunctionBuilder[]{
        // 其中的一个function score 元素
        new FunctionScoreQueryBuilder.FilterFunctionBuilder(
            // 过滤条件
            QueryBuilders.termQuery("isAD", true),
            // 算分函数
            ScoreFunctionBuilders.weightFactorFunction(10)
        )
    });