微服务框架springcloud(实用篇)【6】Elasticsearch 02

    Elasticsearch最擅长的还是搜索和数据分析。分别使用DSLRestClient实现搜索。

一、DSL查询文档

elasticsearch的查询依然是基于JSON风格的DSL来实现的。

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

我们以查询所有为例,其中:查询类型为match_all        没有查询条件

// 查询所有
GET /indexName/_search
{
        "query": {
                "match_all": {
                }
        }
}

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第1张图片

 (查询出来的结果默认十条,要是打算查询所有,学完分页查询就可以看到了)

2.全文检索查询

1)使用场景

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

        对用户搜索的内容做分词,得到词条

        根据词条去倒排索引库中匹配,得到文档id

        根据文档id找到文档,返回给用户

比较常用的场景包括:商城的输入框搜索        百度输入框搜索

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

2)基本语法

全文检索查询,会对用户输入内容分词,常用于搜索框搜索

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

        match查询:单字段查询,全文检索查询的一种,会对用户输入内容分词,然后去倒排索引库检索

        multi_match查询:多字段查询,match查询类似,只不过允许同时查询多个字段,任意一个字段符合条件就算符合查询条件,参与查询字段越多,查询性能越差

match查询语法如下:

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

mulit_match语法如下:

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

3)示例

match查询示例:(匹配度越高,排名越靠前)

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第2张图片

multi_match查询示例:(三个字段brand,name和business里,只要满足一个就可以)

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第3张图片

可以看到,两种查询结果是一样的,为什么?

因为我们将brand、name、business值都利用copy_to复制到了all字段中。因此你根据三个字段搜索,和根据all字段搜索效果当然一样了。

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

3.精准查询

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

        term:根据词条精确值查询,一般搜索keyword类型、数值类型、布尔类型、日期类型字段

        range:根据值的范围查询,可以是数值、日期的范围

1)term查询

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

语法说明:

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

示例:当我搜索的是精确词条时,能正确查询出结果:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第4张图片

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第5张图片

2)range查询

范围查询,一般应用在对数值类型做范围过滤的时候。比如做价格范围过滤。

基本语法:

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

示例:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第6张图片

4.地理坐标查询

所谓的地理坐标查询,其实就是根据经纬度查询,

官方文档:https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-queries.html

常见的使用场景包括:

        携程:搜索我附近的酒店        滴滴:搜索我附近的出租车        微信:搜索我附近的人

1)矩形范围查询(geo_bounding_box)

查询geo_point坐标落在某个矩形范围的所有文档

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第7张图片

查询时,需要指定矩形的左上、右下两个点的坐标,然后画出一个矩形,落在该矩形内的都是符合条件的点。

语法如下:

// geo_bounding_box查询
GET /indexName/_search
{
        "query": {
                "geo_bounding_box": {
                        "FIELD": {        文档里面,类型为geo_point的那个字段
                                "top_left": { // 左上点
                                        "lat": 31.1,
                                        "lon": 121.5
                                },
                                "bottom_right": { // 右下点
                                        "lat": 30.9,
                                        "lon": 121.7
                                }
                        }
                }
        }
}

这种并不符合“附近的人”这样的需求,所以我们就不做了。

2)附近查询

附近查询,也叫做距离查询(geo_distance):查询到指定中心点小于某个距离值的所有文档

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第8张图片

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

语法说明:

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

示例:我们先搜索陆家嘴附近15km的酒店:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第9张图片

发现共有47家酒店。

然后把半径缩短到3公里:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第10张图片

可以发现,搜索到的酒店数量减少到了5家。

5.复合查询

复合(compound)查询可以将其它简单查询组合起来,实现更复杂的搜索逻辑。常见的有两种:

        fuction score:算分函数查询,可以控制文档相关性算分,控制文档排名

        bool query:布尔查询,利用逻辑关系组合多个其它的查询,实现复杂搜索

1)相关性算分

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

例如,我们搜索 "虹桥如家",结果如下:

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

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第11张图片

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第12张图片

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第13张图片

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

        TF-IDF算法、BM25算法(elasticsearch5.1版本后采用的算法)

2)算分函数查询fuction score

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

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

1] 语法说明

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第14张图片

①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] 示例

需求:给“如家”这个品牌的酒店排名靠前一些

function score query定义的三要素

        过滤条件:哪些文档要加分

        算分函数:如何计算function score

        加权方式:function score 与 query score如何运算

翻译一下这个需求,转换为之前说的四个要点:

        原始条件:不确定,可以任意变化

        过滤条件:brand = "如家"

        算分函数:可以简单粗暴,直接给固定的算分结果,weight

        运算模式:比如求和

因此最终的DSL语句如下:

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

测试,在未添加算分函数时,如家得分如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第15张图片

添加了算分函数后,如家得分就提升了:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第16张图片

3)布尔查询Boolean Query

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

        must:必须匹配每个子查询,类似“与”

        should:选择性匹配子查询,类似“或”

        must_not:必须不匹配,不参与算分,类似“非”

        filter:必须匹配,不参与算分

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

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

        搜索框的关键字搜索,是全文检索查询,使用must查询,参与算分

        其它过滤条件,采用filter查询。不参与算分(es在进行搜索的时候,不仅仅要看文档是否匹配,还要看文档和关键字的相关度来进行打分,分值越高排名越靠前,打分有复杂的算分函数BM25,每做一次算分,消耗一份资源,如果子查询比较多,而且每一项都要进行算分,查询的性能就会受到影响,如果不参与算分就会只会返回,满足或不满足,是或者否,性能就会有所提高,es把这种不参与算分的过滤性查询放到缓存中去,将来再一次查询的时候会进一步的提升性能)

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范围内的酒店。

分析:

        名称搜索,属于全文检索查询,应该参与算分。放到must中

        价格不高于400,用range查询,属于过滤条件,不参与算分。放到must_not中

        周围10km范围内,用geo_distance查询,属于过滤条件,不参与算分。放到filter中

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第17张图片

二、搜索结果处理

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

1.排序

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

一旦做了排序,打分就没有意义了 _score的值为null

1)普通字段排序

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

语法:

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

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

示例:

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第18张图片

2)地理坐标排序

地理坐标排序略有不同。

语法说明:

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

这个查询的含义是:

        指定一个坐标,作为目标点

        计算每一个文档中,指定字段(必须是geo_point类型)的坐标 到目标点的距离是多少

        根据距离排序

示例:

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

提示:获取你的位置的经纬度的方式:

https://lbs.amap.com/demo/jsapi-v2/example/map/click-to-get-lnglat/

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第19张图片

 "location":{ "31.0234661,121.612282"}        这么写也可以

2.分页

elasticsearch 默认情况下只返回top10的数据。而如果要查询更多数据就需要修改分页参数了。

elasticsearch中通过修改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条:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第20张图片

查询TOP1000,如果es是单点模式,这并无太大影响。

ES是分布式的,所以会面临深度分页问题。按price排序后,获取from = 990,size =10的数据:

        首先在每个数据分片上都排序并查询前1000条文档。

        然后将所有节点的结果聚合,在内存中重新排序选出前1000条文档

        最后从这1000条中,选取从990开始的10条文档

但是elasticsearch将来一定是集群,例如我集群有5个节点,我要查询TOP1000的数据,并不是每个节点查询200条就可以了。因为节点A的TOP200,在另一个节点可能排到10000名以外了。

因此要想获取整个集群的TOP1000,必须先查询出每个节点的TOP1000,汇总结果后,重新排名,重新截取TOP1000。

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第21张图片

如果搜索页数过深,或者结果集(from + size)越大,对内存和CPU的消耗也越高。因此ES设定结果集查询的上限是10000

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第22张图片微服务框架springcloud(实用篇)【6】Elasticsearch 02_第23张图片

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

        search after:分页时需要排序,原理是从上一次的排序值开始,查询下一页数据。官方推荐使用的方式。(只能向后翻页)

        scroll:原理将排序后的文档id形成快照,保存在内存。官方已经不推荐使用。

3)小结

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

from + size:

        优点:支持随机翻页

        缺点:深度分页问题,默认查询上限(from + size)是10000

        场景:百度、京东、谷歌、淘宝这样的随机翻页搜索

after search:

        优点:没有查询上限(单次查询的size不超过10000)

        缺点:只能向后逐页查询,不支持随机翻页

        场景:没有随机翻页需求的搜索,例如手机向下滚动翻页

scroll:

        优点:没有查询上限(单次查询的size不超过10000)

        缺点:会有额外内存消耗,并且搜索结果是非实时的

        场景:海量数据的获取和迁移。从ES7.1开始不推荐,建议用 after search方案。

3.高亮

1)高亮原理

我们在百度,京东搜索时,关键字会变成红色,比较醒目,这叫高亮显示:

原理:将搜索结果中的关键字用标签标记出来、在页面中给标签添加css样式

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第24张图片

高亮显示的实现分为两步:

        1] 给文档中的所有关键字都添加一个标签,例如``标签

        2] 页面给``标签编写CSS样式

2)实现高亮

高亮的语法:

GET /hotel/_search
{
  "query": {
    "match": {
      "FIELD": "TEXT" // 查询条件,高亮一定要使用全文检索查询,搜索的字段+关键字

        //高亮显示,搜索不能用match_all或者是其他的查询,这里一定要用带关键字的查询
    }
  },
  "highlight": {
    "fields": { // 指定要高亮的字段
      "FIELD": {
        "pre_tags": "",  // 用来标记高亮字段的前置标签
        "post_tags": "
" // 用来标记高亮字段的后置标签
      }
    }
  }
}

注意:

        高亮是对关键字高亮,因此搜索条件必须带有关键字,而不能是范围这样的查询。

        默认情况下,高亮的字段,必须与搜索指定的字段一致,否则无法高亮

        如果要对非搜索字段高亮,则需要添加一个属性:required_field_match=false

source是原始内容不能修改,高亮结果在其下方返回

示例:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第25张图片

4.总结

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

        query:查询条件                     from和size:分页条件

        sort:排序条件                        highlight:高亮条件

示例:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第26张图片

三、RestClient查询文档

文档的查询同样适用昨天学习的 RestHighLevelClient对象,基本步骤包括:

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

1.快速入门

我们以match_all查询为例

1)发起查询请求

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第27张图片

代码解读:

        第一步,创建`SearchRequest`对象,指定索引库名

        第二步,利用`request.source()`构建DSL,DSL中可以包含查询、分页、排序、高亮等

        `query()`:代表查询条件,利用`QueryBuilders.matchAllQuery()`构建一个match_all查询的DSL

        第三步,利用client.search()发送请求,得到响应

这里关键的API有两个,一个是`request.source()`,其中包含了查询、排序、分页、高亮等所有功能:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第28张图片

另一个是QueryBuilders(是一个工具),其中包含match、term、function_score、bool等各种查询:

(不要用QueryBuilder这个接口,虽然里面有很多种实现,查询的类型不同,实现不同)

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第29张图片

2)解析响应

响应结果的解析:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第30张图片

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

完整代码如下:

@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.解析响应
    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[] hits = searchHits.getHits();
    // 4.3.遍历
    for (SearchHit hit : hits) {
        // 获取文档source
        String json = hit.getSourceAsString();
        // 反序列化
        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
        System.out.println("hotelDoc = " + hotelDoc);
    }
}

4)小结

查询的基本步骤是:

1] 创建SearchRequest对象

2] 准备Request.source(),也就是DSL。

        ① QueryBuilders来构建查询条件

        ② 传入Request.source() 的 query() 方法

3] 发送请求,得到结果

4] 解析结果(参考JSON结果,从外到内,逐层解析)

2.match查询

全文检索的match和multi_match查询与match_all的API基本一致。

差别是查询条件,也就是query的部分。

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第31张图片

因此,Java代码上的差异主要是request.source().query()中的参数了。同样是利用QueryBuilders提供的方法:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第32张图片

而结果解析代码则完全一致,可以抽取并共享。(ctrl + alt + m)

完整代码如下:

@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.解析响应
    handleResponse(response);

}

3.精确查询

精确查询主要是两者:term:词条精确匹配        range:范围查询

与之前的查询相比,差异同样在查询条件,其它都一样。

查询条件构造的API如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第33张图片微服务框架springcloud(实用篇)【6】Elasticsearch 02_第34张图片

4.布尔查询

布尔查询是用must、must_not、filter等方式组合其它查询,代码示例如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第35张图片

可以看到,API与其它查询的差别同样是在查询条件的构建,QueryBuilders,结果解析等其他代码完全不变。

完整代码如下:

@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.解析响应
    handleResponse(response);

}

5.排序、分页

搜索结果的排序和分页是与query同级的参数,因此同样是使用request.source()来设置。

对应的API如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第36张图片完整代码示例:

@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);

}

6.高亮

高亮的代码与之前代码差异较大,有两点:

        查询的DSL:其中除了查询条件,还需要添加高亮条件,同样是与query同级。

        结果解析:结果除了要解析_source文档数据,还要解析高亮结果

1)高亮请求构建

高亮请求的构建API如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第37张图片

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

完整代码如下:

@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.高亮    
    //requireFieldMatch需不需要匹配,这里是false不匹配
    //还有一些功能preTags前置标签,postTags后置标签,如果没有写,就使用默认标签
    request.source().highlighter(new HighlightBuilder().field("name").requireFieldMatch(false));
    // 3.发送请求
    SearchResponse response = client.search(request, RequestOptions.DEFAULT);
    // 4.解析响应
    handleResponse(response);
}

2)高亮结果解析

高亮的结果与查询的文档结果默认是分离的,并不在一起。

因此解析高亮的代码需要额外处理:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第38张图片

代码解读:

第一步:从结果中获取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 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);
    }
}

四、黑马旅游案例

下面,我们通过黑马旅游的案例来实战演练下之前学习的知识。

我们实现四部分功能:     酒店搜索和分页        酒店结果过滤        我周边的酒店        酒店竞价排名

启动我们提供的hotel-demo项目,其默认端口是8089,访问http://localhost:8090,就能看到项目页面了:

1.酒店搜索和分页

案例需求:实现黑马旅游的酒店搜索功能,完成关键字搜索和分页

1)需求分析

在项目的首页,有一个大大的搜索框,还有分页按钮:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第39张图片

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第40张图片

请求参数如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第41张图片

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

        请求方式:POST

        请求路径:/hotel/list

        请求参数:JSON对象,包含4个字段:

                key:搜索关键字

                page:页码

                size:每页大小

                sortBy:排序,目前暂不实现

        返回值:分页查询,需要返回分页结果PageResult,包含两个属性:

                total:总条数

                List:当前页的数据

因此,我们实现业务的流程如下:

        步骤一:定义实体类,接收请求参数的JSON对象

        步骤二:编写controller,接收页面的请求,调IHotelServicesearch方法

        步骤三:编写业务实现,定义IHotelService中的search方法,利用match查询实现根据关键字搜索酒店信息,利用RestHighLevelClient实现搜索、分页

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:当前页的数据

因此,我们在`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 hotels;

    public PageResult() {
    }

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

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);//alt + enter 把方法创建出来
    }
}

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方法:

//找到接口的实现类ctrl + alt + b
/*public class HotelService extends ServiceImpl implements IHotelService {}
alt + enter实现search方法
*/

@Override
public PageResult search(RequestParams params) {
    try {
        // 1.准备Request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备DSL
        // 2.1.query
        String key = params.getKey();
        if (key == null || "".equals(key)) {
            boolQuery.must(QueryBuilders.matchAllQuery());
        } else {
            boolQuery.must(QueryBuilders.matchQuery("all", key));
        }

        // 2.2.分页
        int page = params.getPage();
        int size = params.getSize();
        request.source().from((page - 1) * size).size(size);

        // 3.发送请求
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.解析响应
        return handleResponse(response);
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

// 结果解析
private PageResult handleResponse(SearchResponse response) {
    // 4.解析响应
    SearchHits searchHits = response.getHits();
    // 4.1.获取总条数
    long total = searchHits.getTotalHits().value;
    // 4.2.文档数组
    SearchHit[] hits = searchHits.getHits();
    // 4.3.遍历
    List hotels = new ArrayList<>();
    for (SearchHit hit : hits) {
        // 获取文档source
        String json = hit.getSourceAsString();
        // 反序列化
        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
		// 放入集合
        hotels.add(hotelDoc);
    }
    // 4.4.封装返回
    return new PageResult(total, hotels);
}

2.酒店结果过滤

需求:添加品牌、城市、星级、价格等过滤功能

1)需求分析

在页面搜索框下面,会有一些过滤项:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第42张图片

传递的参数如图:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第43张图片

包含的过滤条件有:

        brand:品牌值

        city:城市

        minPrice~maxPrice:价格范围

        starName:星级

我们需要做两件事情:

        修改请求参数的对象RequestParams,添加brandcitystarNameminPricemaxPrice等参数

        修改业务逻辑,在搜索条件之外,添加一些过滤条件,修改search方法的实现,在关键字搜索时,如果brand等参数存在,对其做过滤

2)修改实体类

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

@Data
public class RequestParams {
    private String key;
    private Integer page;
    private Integer size;
    private String sortBy;
    // 下面是新增的过滤条件参数
    private String city;
    private String brand;
    private String starName;
    private Integer minPrice;
    private Integer maxPrice;
}

3)修改搜索业务

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

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

        品牌过滤:精确匹配,是keyword类型,用term查询

        星级过滤:精确匹配,是keyword类型,用term查询

        价格过滤:范围过滤,是数值类型,用range查询

        城市过滤:精确匹配,是keyword类型,用term查询

注意事项:

        多个条件之间是AND关系,组合多条件用BooleanQuery

        参数存在才需要过滤,做好非空判断

多个查询条件组合,肯定是boolean查询来组合:

        关键字搜索放到must中,参与算分

        其它过滤条件放到filter中,不 参与算分

因为条件构建的逻辑比较复杂,这里先封装为一个函数:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第44张图片

buildBasicQuery的代码如下:

private void buildBasicQuery(RequestParams params, SearchRequest request) {
    // 1.构建BooleanQuery
    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    // 2.关键字搜索
    String key = params.getKey();
    if (key == null || "".equals(key)) {
        boolQuery.must(QueryBuilders.matchAllQuery());
    } else {
        boolQuery.must(QueryBuilders.matchQuery("all", key));
    }
    // 3.城市条件
    if (params.getCity() != null && !params.getCity().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("city", params.getCity()));
    }
    // 4.品牌条件
    if (params.getBrand() != null && !params.getBrand().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("brand", params.getBrand()));
    }
    // 5.星级条件
    if (params.getStarName() != null && !params.getStarName().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("starName", params.getStarName()));
    }
	// 6.价格
    if (params.getMinPrice() != null && params.getMaxPrice() != null) {
        boolQuery.filter(QueryBuilders
                         .rangeQuery("price")
                         .gte(params.getMinPrice())
                         .lte(params.getMaxPrice())
                        );
    }
	// 7.放入source
    request.source().query(boolQuery);
}

3.我周边的酒店

需求:我附近的酒店

1)需求分析

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

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

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第45张图片

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

        修改RequestParams参数,接收location字段

        修改search方法业务逻辑,如果location有值,添加根据geo_distance排序的功能

2)修改实体类

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

package cn.itcast.hotel.pojo;

import lombok.Data;

@Data
public class RequestParams {
    private String key;
    private Integer page;
    private Integer size;
    private String sortBy;
    private String city;
    private String brand;
    private String starName;
    private Integer minPrice;
    private Integer maxPrice;
    // 我当前的地理坐标
    private String location;
}

3)距离排序API

我们以前学习过排序功能,包括两种:普通字段排序、地理坐标排序

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

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

对应的java代码示例:

![image-20210722095227059](assets/image-20210722095227059.png)

4)添加距离排序

在`cn.itcast.hotel.service.impl`的`HotelService`的`search`方法中,添加一个排序功能:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第46张图片

完整代码:

@Override
public PageResult search(RequestParams params) {
    try {
        // 1.准备Request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备DSL
        // 2.1.query
        buildBasicQuery(params, request);

        // 2.2.分页
        int page = params.getPage();
        int size = params.getSize();
        request.source().from((page - 1) * size).size(size);

        // 2.3.排序
        String location = params.getLocation();
        if (location != null && !location.equals("")) {
            request.source().sort(SortBuilders
                                  .geoDistanceSort("location", new GeoPoint(location))
                                  .order(SortOrder.ASC)
                                  .unit(DistanceUnit.KILOMETERS)
                                 );
        }

        // 3.发送请求
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.解析响应
        return handleResponse(response);
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

5)排序距离显示

重启服务后,测试我的酒店功能:

发现确实可以实现对我附近酒店的排序,不过并没有看到酒店到底距离我多远,这该怎么办?

排序完成后,页面还要获取我附近每个酒店的具体**距离**值,这个值在响应结果中是独立的:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第47张图片

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

我们要做两件事:

        修改HotelDoc,添加排序距离字段,用于页面显示

        修改HotelService类中的handleResponse方法,添加对sort值的获取

1] 修改HotelDoc类,添加距离字段

package cn.itcast.hotel.pojo;

import lombok.Data;
import lombok.NoArgsConstructor;


@Data
@NoArgsConstructor
public class HotelDoc {
    private Long id;
    private String name;
    private String address;
    private Integer price;
    private Integer score;
    private String brand;
    private String city;
    private String starName;
    private String business;
    private String location;
    private String pic;
    // 排序时的 距离值
    private Object distance;

    public HotelDoc(Hotel hotel) {
        this.id = hotel.getId();
        this.name = hotel.getName();
        this.address = hotel.getAddress();
        this.price = hotel.getPrice();
        this.score = hotel.getScore();
        this.brand = hotel.getBrand();
        this.city = hotel.getCity();
        this.starName = hotel.getStarName();
        this.business = hotel.getBusiness();
        this.location = hotel.getLatitude() + ", " + hotel.getLongitude();
        this.pic = hotel.getPic();
    }
}

2] 修改HotelService中的handleResponse方法

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第48张图片

重启后测试,发现页面能成功显示距离了

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的酒店增加权重

2)修改HotelDoc实体

给`cn.itcast.hotel.pojo`包下的HotelDoc类添加isAD字段:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第49张图片

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)添加算分函数查询

接下来我们就要修改查询条件了。之前是用的boolean 查询,现在要改成function_socre查询。

对应的JavaAPI如下:

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第50张图片

我们可以将之前写的boolean查询作为**原始查询**条件放到query中,接下来就是添加过滤条件、算分函数、加权模式了。所以原来的代码依然可以沿用。

修改`cn.itcast.hotel.service.impl`包下的`HotelService`类中的`buildBasicQuery`方法,添加算分函数查询:

private void buildBasicQuery(RequestParams params, SearchRequest request) {
    // 1.构建BooleanQuery
    BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
    // 关键字搜索
    String key = params.getKey();
    if (key == null || "".equals(key)) {
        boolQuery.must(QueryBuilders.matchAllQuery());
    } else {
        boolQuery.must(QueryBuilders.matchQuery("all", key));
    }
    // 城市条件
    if (params.getCity() != null && !params.getCity().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("city", params.getCity()));
    }
    // 品牌条件
    if (params.getBrand() != null && !params.getBrand().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("brand", params.getBrand()));
    }
    // 星级条件
    if (params.getStarName() != null && !params.getStarName().equals("")) {
        boolQuery.filter(QueryBuilders.termQuery("starName", params.getStarName()));
    }
    // 价格
    if (params.getMinPrice() != null && params.getMaxPrice() != null) {
        boolQuery.filter(QueryBuilders
                         .rangeQuery("price")
                         .gte(params.getMinPrice())
                         .lte(params.getMaxPrice())
                        );
    }

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

——————————————————————

完整代码

微服务框架springcloud(实用篇)【6】Elasticsearch 02_第51张图片




    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.3.10.RELEASE
         
    
    cn.itcast.demo
    hotel-demo
    0.0.1-SNAPSHOT
    hotel-demo
    Demo project for Spring Boot
    
        1.8
        7.12.1
    
    
        
        
            org.elasticsearch.client
            elasticsearch-rest-high-level-client
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.4.2
        
        
            mysql
            mysql-connector-java
            runtime
        
        
            org.projectlombok
            lombok
            true
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
            
                
                    org.junit.vintage
                    junit-vintage-engine
                
            
        
		
        
            com.alibaba
            fastjson
            1.2.71
        
		
            org.apache.commons
            commons-lang3
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    
                        
                            org.projectlombok
                            lombok
                        
                    
                
            
        
    





    
        
            
                %d{MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            
        
    

    
        
    
#hotel-demo/src/main/resources/application.yaml
server:
  port: 8089
spring:
  datasource:
    url: jdbc:mysql://mysql:3306/heima?useSSL=false
    username: root
    password: 123
    driver-class-name: com.mysql.jdbc.Driver
logging:
  level:
    cn.itcast: debug
  pattern:
    dateformat: HH:mm:ss:SSS
mybatis-plus:
  configuration:
    map-underscore-to-camel-case: true
  type-aliases-package: cn.itcast.hotel.pojo

//  hotel-demo/src/main/java/cn/itcast/hotel/HotelDemoApplication.java
package cn.itcast.hotel;

import org.apache.http.HttpHost;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@MapperScan("cn.itcast.hotel.mapper")
@SpringBootApplication
public class HotelDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(HotelDemoApplication.class, args);
    }

    @Bean
    public RestHighLevelClient restHighLevelClient(){
        return new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }
}
//hotel-demo/src/main/java/cn/itcast/hotel/pojo/Hotel.java
package cn.itcast.hotel.pojo;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("tb_hotel")
public class Hotel {
    @TableId(type = IdType.INPUT)
    private Long id;
    private String name;
    private String address;
    private Integer price;
    private Integer score;
    private String brand;
    private String city;
    private String starName;
    private String business;
    private String longitude;
    private String latitude;
    private String pic;
}

/*—————————————————————————————————————————————————————*/
//hotel-demo/src/main/java/cn/itcast/hotel/pojo/HotelDoc.java
package cn.itcast.hotel.pojo;

import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
public class HotelDoc {
    private Long id;
    private String name;
    private String address;
    private Integer price;
    private Integer score;
    private String brand;
    private String city;
    private String starName;
    private String business;
    private String location;
    private String pic;
    private Object distance;
    private Boolean isAD;

    public HotelDoc(Hotel hotel) {
        this.id = hotel.getId();
        this.name = hotel.getName();
        this.address = hotel.getAddress();
        this.price = hotel.getPrice();
        this.score = hotel.getScore();
        this.brand = hotel.getBrand();
        this.city = hotel.getCity();
        this.starName = hotel.getStarName();
        this.business = hotel.getBusiness();
        this.location = hotel.getLatitude() + ", " + hotel.getLongitude();
        this.pic = hotel.getPic();
    }
}

/*—————————————————————————————————————————————————————*/
//hotel-demo/src/main/java/cn/itcast/hotel/pojo/PageResult.java
package cn.itcast.hotel.pojo;

import lombok.Data;
import java.util.List;

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

    public PageResult() {
    }

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

/*—————————————————————————————————————————————————————*/
//hotel-demo/src/main/java/cn/itcast/hotel/pojo/RequestParams.java
package cn.itcast.hotel.pojo;

import lombok.Data;

@Data
public class RequestParams {
    private String key;
    private Integer page;
    private Integer size;
    private String sortBy;
    private String brand;
    private String city;
    private String starName;
    private Integer minPrice;
    private Integer maxPrice;
    private String location;
}
//  hotel-demo/src/main/java/cn/itcast/hotel/web/HotelController.java
package cn.itcast.hotel.web;

import cn.itcast.hotel.pojo.PageResult;
import cn.itcast.hotel.pojo.RequestParams;
import cn.itcast.hotel.service.IHotelService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

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

    @Autowired
    private IHotelService hotelService;

    @PostMapping("list")
    public PageResult search(@RequestBody RequestParams params) {
        return hotelService.search(params);
    }
}

/*————————————————————————————————————————————————————————————*/
//hotel-demo/src/main/java/cn/itcast/hotel/service/IHotelService.java
package cn.itcast.hotel.service;

import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.pojo.PageResult;
import cn.itcast.hotel.pojo.RequestParams;
import com.baomidou.mybatisplus.extension.service.IService;

public interface IHotelService extends IService {
    PageResult search(RequestParams params);
}

/*————————————————————————————————————————————————————————————*/
//  hotel-demo/src/main/java/cn/itcast/hotel/service/impl/HotelService.java
package cn.itcast.hotel.service.impl;

import cn.itcast.hotel.mapper.HotelMapper;
import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.pojo.HotelDoc;
import cn.itcast.hotel.pojo.PageResult;
import cn.itcast.hotel.pojo.RequestParams;
import cn.itcast.hotel.service.IHotelService;
import com.alibaba.fastjson.JSON;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.common.geo.GeoPoint;
import org.elasticsearch.common.unit.DistanceUnit;
import org.elasticsearch.index.query.BoolQueryBuilder;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.index.query.functionscore.FunctionScoreQueryBuilder;
import org.elasticsearch.index.query.functionscore.ScoreFunctionBuilders;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.SearchHits;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightField;
import org.elasticsearch.search.sort.SortBuilders;
import org.elasticsearch.search.sort.SortOrder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

@Slf4j
@Service
public class HotelService extends ServiceImpl implements IHotelService {

    @Autowired
    private RestHighLevelClient restHighLevelClient;

    @Override
    public PageResult search(RequestParams params) {
        try {
            // 1.准备Request
            SearchRequest request = new SearchRequest("hotel");
            // 2.准备请求参数
            // 2.1.query
            buildBasicQuery(params, request);
            // 2.2.分页
            int page = params.getPage();
            int size = params.getSize();
            request.source().from((page - 1) * size).size(size);
            // 2.3.距离排序
            String location = params.getLocation();
            if (StringUtils.isNotBlank(location)) {
                request.source().sort(SortBuilders
                        .geoDistanceSort("location", new GeoPoint(location))
                        .order(SortOrder.ASC)
                        .unit(DistanceUnit.KILOMETERS)
                );
            }
            // 3.发送请求
            SearchResponse response = restHighLevelClient.search(request, RequestOptions.DEFAULT);
            // 4.解析响应
            return handleResponse(response);
        } catch (IOException e) {
            throw new RuntimeException("搜索数据失败", e);
        }
    }

    private void buildBasicQuery(RequestParams params, SearchRequest request) {
        // 1.准备Boolean查询
        BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();

        // 1.1.关键字搜索,match查询,放到must中
        String key = params.getKey();
        if (StringUtils.isNotBlank(key)) {
            // 不为空,根据关键字查询
            boolQuery.must(QueryBuilders.matchQuery("all", key));
        } else {
            // 为空,查询所有
            boolQuery.must(QueryBuilders.matchAllQuery());
        }

        // 1.2.品牌
        String brand = params.getBrand();
        if (StringUtils.isNotBlank(brand)) {
            boolQuery.filter(QueryBuilders.termQuery("brand", brand));
        }
        // 1.3.城市
        String city = params.getCity();
        if (StringUtils.isNotBlank(city)) {
            boolQuery.filter(QueryBuilders.termQuery("city", city));
        }
        // 1.4.星级
        String starName = params.getStarName();
        if (StringUtils.isNotBlank(starName)) {
            boolQuery.filter(QueryBuilders.termQuery("starName", starName));
        }
        // 1.5.价格范围
        Integer minPrice = params.getMinPrice();
        Integer maxPrice = params.getMaxPrice();
        if (minPrice != null && maxPrice != null) {
            maxPrice = maxPrice == 0 ? Integer.MAX_VALUE : maxPrice;
            boolQuery.filter(QueryBuilders.rangeQuery("price").gte(minPrice).lte(maxPrice));
        }

        // 2.算分函数查询
        FunctionScoreQueryBuilder functionScoreQuery = QueryBuilders.functionScoreQuery(
                boolQuery, // 原始查询,boolQuery
                new FunctionScoreQueryBuilder.FilterFunctionBuilder[]{ // function数组
                        new FunctionScoreQueryBuilder.FilterFunctionBuilder(
                                QueryBuilders.termQuery("isAD", true), // 过滤条件
                                ScoreFunctionBuilders.weightFactorFunction(10) // 算分函数
                        )
                }
        );

        // 3.设置查询条件
        request.source().query(functionScoreQuery);
    }

    private PageResult handleResponse(SearchResponse response) {
        SearchHits searchHits = response.getHits();
        // 4.1.总条数
        long total = searchHits.getTotalHits().value;
        // 4.2.获取文档数组
        SearchHit[] hits = searchHits.getHits();
        // 4.3.遍历
        List hotels = new ArrayList<>(hits.length);
        for (SearchHit hit : hits) {
            // 4.4.获取source
            String json = hit.getSourceAsString();
            // 4.5.反序列化,非高亮的
            HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
            // 4.6.处理高亮结果
            // 1)获取高亮map
            Map map = hit.getHighlightFields();
            if (map != null && !map.isEmpty()) {
                // 2)根据字段名,获取高亮结果
                HighlightField highlightField = map.get("name");
                if (highlightField != null) {
                    // 3)获取高亮结果字符串数组中的第1个元素
                    String hName = highlightField.getFragments()[0].toString();
                    // 4)把高亮结果放到HotelDoc中
                    hotelDoc.setName(hName);
                }
            }
            // 4.8.排序信息
            Object[] sortValues = hit.getSortValues();
            if (sortValues.length > 0) {
                hotelDoc.setDistance(sortValues[0]);
            }

            // 4.9.放入集合
            hotels.add(hotelDoc);
        }
        return new PageResult(total, hotels);
    }
}
//  hotel-demo/src/main/java/cn/itcast/hotel/constants/HotelIndexConstants.java
package cn.itcast.hotel.constants;

public class HotelIndexConstants {
    public static final String MAPPING_TEMPLATE = "{\n" +
            "  \"mappings\": {\n" +
            "    \"properties\": {\n" +
            "      \"id\": {\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"name\": {\n" +
            "        \"type\": \"text\",\n" +
            "        \"analyzer\": \"ik_max_word\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"address\": {\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"index\": false\n" +
            "      },\n" +
            "      \"price\": {\n" +
            "        \"type\": \"integer\"\n" +
            "      },\n" +
            "      \"score\": {\n" +
            "        \"type\": \"integer\"\n" +
            "      },\n" +
            "      \"brand\": {\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"city\": {\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"starName\": {\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"business\": {\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"pic\": {\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"index\": false\n" +
            "      },\n" +
            "      \"location\": {\n" +
            "        \"type\": \"geo_point\"\n" +
            "      },\n" +
            "      \"all\": {\n" +
            "        \"type\": \"text\",\n" +
            "        \"analyzer\": \"ik_max_word\"\n" +
            "      }\n" +
            "    }\n" +
            "  }\n" +
            "}";
}
//  hotel-demo/src/main/java/cn/itcast/hotel/mapper/HotelMapper.java
package cn.itcast.hotel.mapper;

import cn.itcast.hotel.pojo.Hotel;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface HotelMapper extends BaseMapper {
}
//  hotel-demo/src/test/java/cn/itcast/hotel/HotelDocumentTest.java
package cn.itcast.hotel;

import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.pojo.HotelDoc;
import cn.itcast.hotel.service.IHotelService;
import com.alibaba.fastjson.JSON;
import org.apache.http.HttpHost;
import org.elasticsearch.action.bulk.BulkRequest;
import org.elasticsearch.action.delete.DeleteRequest;
import org.elasticsearch.action.get.GetRequest;
import org.elasticsearch.action.get.GetResponse;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.action.update.UpdateRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.common.xcontent.XContentType;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;
import java.util.List;

@SpringBootTest
class HotelDocumentTest {

    private RestHighLevelClient client;

    @Autowired
    private IHotelService hotelService;

    @Test
    void testAddDocument() throws IOException {
        // 1.查询数据库hotel数据
        Hotel hotel = hotelService.getById(61083L);
        // 2.转换为HotelDoc
        HotelDoc hotelDoc = new HotelDoc(hotel);
        // 3.转JSON
        String json = JSON.toJSONString(hotelDoc);

        // 1.准备Request
        IndexRequest request = new IndexRequest("hotel").id(hotelDoc.getId().toString());
        // 2.准备请求参数DSL,其实就是文档的JSON字符串
        request.source(json, XContentType.JSON);
        // 3.发送请求
        client.index(request, RequestOptions.DEFAULT);
    }

    @Test
    void testGetDocumentById() throws IOException {
        // 1.准备Request      // GET /hotel/_doc/{id}
        GetRequest request = new GetRequest("hotel", "61083");
        // 2.发送请求
        GetResponse response = client.get(request, RequestOptions.DEFAULT);
        // 3.解析响应结果
        String json = response.getSourceAsString();

        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
        System.out.println("hotelDoc = " + hotelDoc);
    }

    @Test
    void testDeleteDocumentById() throws IOException {
        // 1.准备Request      // DELETE /hotel/_doc/{id}
        DeleteRequest request = new DeleteRequest("hotel", "61083");
        // 2.发送请求
        client.delete(request, RequestOptions.DEFAULT);
    }

    @Test
    void testUpdateById() throws IOException {
        // 1.准备Request
        UpdateRequest request = new UpdateRequest("hotel", "61083");
        // 2.准备参数
        request.doc(
                "price", "870"
        );
        // 3.发送请求
        client.update(request, RequestOptions.DEFAULT);
    }

    @Test
    void testBulkRequest() throws IOException {
        // 查询所有的酒店数据
        List list = hotelService.list();

        // 1.准备Request
        BulkRequest request = new BulkRequest();
        // 2.准备参数
        for (Hotel hotel : list) {
            // 2.1.转为HotelDoc
            HotelDoc hotelDoc = new HotelDoc(hotel);
            // 2.2.转json
            String json = JSON.toJSONString(hotelDoc);
            // 2.3.添加请求
            request.add(new IndexRequest("hotel").id(hotel.getId().toString()).source(json, XContentType.JSON));
        }

        // 3.发送请求
        client.bulk(request, RequestOptions.DEFAULT);
    }

    @BeforeEach
    void setUp() {
        client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }

    @AfterEach
    void tearDown() throws IOException {
        client.close();
    }
}
//  hotel-demo/src/test/java/cn/itcast/hotel/HotelIndexTest.java
package cn.itcast.hotel;

import org.apache.http.HttpHost;
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.client.indices.CreateIndexRequest;
import org.elasticsearch.client.indices.GetIndexRequest;
import org.elasticsearch.common.xcontent.XContentType;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;

import static cn.itcast.hotel.constants.HotelIndexConstants.MAPPING_TEMPLATE;

@SpringBootTest
class HotelIndexTest {

    private RestHighLevelClient client;

    @Test
    void testCreateIndex() throws IOException {
        // 1.准备Request      PUT /hotel
        CreateIndexRequest request = new CreateIndexRequest("hotel");
        // 2.准备请求参数
        request.source(MAPPING_TEMPLATE, XContentType.JSON);
        // 3.发送请求
        client.indices().create(request, RequestOptions.DEFAULT);
    }

    @Test
    void testExistsIndex() throws IOException {
        // 1.准备Request
        GetIndexRequest request = new GetIndexRequest("hotel");
        // 3.发送请求
        boolean isExists = client.indices().exists(request, RequestOptions.DEFAULT);

        System.out.println(isExists ? "存在" : "不存在");
    }
    @Test
    void testDeleteIndex() throws IOException {
        // 1.准备Request
        DeleteIndexRequest request = new DeleteIndexRequest("hotel");
        // 3.发送请求
        client.indices().delete(request, RequestOptions.DEFAULT);
    }


    @BeforeEach
    void setUp() {
        client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }

    @AfterEach
    void tearDown() throws IOException {
        client.close();
    }
}
//  hotel-demo/src/test/java/cn/itcast/hotel/HotelSearchTest.java
package cn.itcast.hotel;

import cn.itcast.hotel.pojo.HotelDoc;
import com.alibaba.fastjson.JSON;
import org.apache.http.HttpHost;
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.SearchHit;
import org.elasticsearch.search.SearchHits;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightField;
import org.elasticsearch.search.sort.SortOrder;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;
import java.util.Map;

@SpringBootTest
class HotelSearchTest {

    private RestHighLevelClient client;

    @Test
    void testMatchAll() throws IOException {
        // 1.准备request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备请求参数
        request.source().query(QueryBuilders.matchAllQuery());
        // 3.发送请求,得到响应
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.结果解析
        handleResponse(response);
    }

    @Test
    void testMatch() throws IOException {
        // 1.准备request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备请求参数
        // request.source().query(QueryBuilders.matchQuery("all", "外滩如家"));
        request.source().query(QueryBuilders.multiMatchQuery("外滩如家", "name", "brand", "city"));
        // 3.发送请求,得到响应
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.结果解析
        handleResponse(response);
    }

    @Test
    void testBool() throws IOException {
        // 1.准备request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备请求参数
       /*
         BoolQueryBuilder boolQuery = QueryBuilders.boolQuery();
        // 2.1.must
        boolQuery.must(QueryBuilders.termQuery("city", "杭州"));
        // 2.2.filter
        boolQuery.filter(QueryBuilders.rangeQuery("price").lte(250));
        */

        request.source().query(
                QueryBuilders.boolQuery()
                        .must(QueryBuilders.termQuery("city", "杭州"))
                        .filter(QueryBuilders.rangeQuery("price").lte(250))
        );
        // 3.发送请求,得到响应
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.结果解析
        handleResponse(response);
    }

    @Test
    void testSortAndPage() throws IOException {
        int page = 2,size = 5;

        // 1.准备request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备请求参数
        // 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(size);

        // 3.发送请求,得到响应
        SearchResponse response = client.search(request, RequestOptions.DEFAULT);
        // 4.结果解析
        handleResponse(response);
    }

    @Test
    void testHighlight() throws IOException {
        // 1.准备request
        SearchRequest request = new SearchRequest("hotel");
        // 2.准备请求参数
        // 2.1.query
        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.结果解析
        handleResponse(response);
    }

    private void handleResponse(SearchResponse response) {
        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) {
            // 4.4.获取source
            String json = hit.getSourceAsString();
            // 4.5.反序列化,非高亮的
            HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
            // 4.6.处理高亮结果
            // 1)获取高亮map
            Map map = hit.getHighlightFields();
            // 2)根据字段名,获取高亮结果
            HighlightField highlightField = map.get("name");
            // 3)获取高亮结果字符串数组中的第1个元素
            String hName = highlightField.getFragments()[0].toString();
            // 4)把高亮结果放到HotelDoc中
            hotelDoc.setName(hName);
            // 4.7.打印
            System.out.println(hotelDoc);
        }
    }

    @BeforeEach
    void setUp() {
        client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }

    @AfterEach
    void tearDown() throws IOException {
        client.close();
    }

}

你可能感兴趣的:(java,elasticsearch,微服务,spring,cloud)