今日重点

  1. 消费方消费消息100%不丢:
  2. 消费方接收到消息会有应答机制ACK或者NACK来进行判断!
  3. 消费失败:NACK 进行重试(需要让本地进行重试Springretry)失败后不会一直重试,开发者会设置重试次数,如果还重试不行才会扔进错误队列!
  4. 发送信息如果执行时长达到一个值, 如果这个值超过了重试机制设置的响应时长值,这会让重试机制再次发生信息,这样就不能保证幂等性了!(通过数据库字段is—_pub来优化该问题)
  5. 如果课程发布成功会修改is_pub的数值为已发布!
  6. 为了解决幂等性,就是执行事务时,先判断is_pub是否被修改,如果修改了,就不重试了!
  7. 由于项目环境使用的是SpringBoot对RabbitMQ的封装,如果需要消息重试: 抛出异常
  8. 重试条件:
  9. 1.不稳定因素引起的错误,需要进行重试
  10. 2.如果是数据上的问题或者其他框架的问题错误,只做到错误的记录,不要重试
  11. 使用MQ实现分布式事务,如果确保消息可靠性?
  12. 生成方 MQ服务方 消费方
  13. 使用应答机制 如果正确操作返回ACK 如何失败返回NACK
  14. springretry 开始失败重试 失败时长 重试次数 重试次数时长的倍数!
  15. 消费方如果一直失败,会将消息放带错误队列,0
  16. 消费方出现消息尝试,如果确保信息幂等性:
  17. 消费方进行重试是通过抛异常的方式,消息幂等性的通过表唯一标识,Redis 分布式锁 记录表 来进行保证!
  18. 课程搜索(学员使用):
  19. 学员登陆后可在页面对课程进行查询(由于高并发,海量数据 查询条件复杂 需要使用到ES搜索引擎来解决这些问题)
  20. Nginx:
  21. 负载均衡 反向代理 虚拟主机 邮箱服务
  22. 索引库搜索快的原因:
  23. 对于关系型数据库和索引库都可以查询数据,但是他们使用的场景、性能、数据结构等都是不一样的。
  24. Mysql数据库ElasticSearch数据结构B+tree结构索引数据结构数据索引主键索引默认为聚簇索引,其他索引是非聚簇索引倒排索引索引特点写入优化的索引结构查找优化的索引结构
  25. logstash(java语言开发):
  26. Logstash是ES下的一款开源软件,它能够同时 从多个来源采集数据、转换数据,然后将数据发送到Eleasticsearch中创建索引
  27. log不会把所有数据拿过去es索引中 只会拿最新的数据,通过查询更新时间 如果大于创建时间 那就是最新的!(logstash上一次采集数据的时间最大值)
  28. 数据同步:
  29. 输入 input 的数据来源和 output 的数据输出服务 第一次采集1970年 并记录上次采集的最大时间,作为下一次查询的条件!
  30. 解决时区问题:
  31. #进入容器
  32. docker exec -it mysql5.7 bash
  33. #查看当前时区
  34. date -R
  35. #修改时区 方式一:
  36. cp /usr/share/zoneinfo/PRC /etc/localtime
  37. # 或者 方式二:
  38. ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime

学习目标
1理解课程搜索的功能性需求
2理解课程搜索的非功能性需求
3能够理解课程搜索的设计
4能够搭建Logstash
5能够搭建ElasticSearch检索服务
6掌握Logstash与ElasticSearch的集成方式
7能够使用ElasticSearch原生Api完成课程搜索
8能够开发课程搜索功能

1. 课程搜索需求概述

1.1 课程搜索概述


课程搜索也是在线教育的重点功能,它相当于电商系统中的商品搜索的地位。用户需要通过此功能来找到自己想要学习的课程,因此需要提供多样化的搜索方式,快速的搜索响应,最终得到较高的用户体验。
课程搜索功能在整个学成在线功能架构中处于门户模块中的课程搜索中,如下图:

Day10-第五章-课程搜索 - 图1

1.2 业务介绍


本章,我们来实现课程搜索功能
1教育机构需要先进行课程发布操作,此时会生成对应课程的索引数据。
2通过门户首页引导至课程搜索页,能够检索到已发布的课程,通过检索到的课程列表,可进入到课程详情页。

课程搜索业务流程
教育机构
Day10-第五章-课程搜索 - 图2

其中,课程发布、课程详情页功能在前面的课程中已经介绍过,本章需要完成功能如下:
●课程搜索:门户可对已发布的课程进行多样化检索,检索结果为课程列表,列表每个数据项中包含课程详情静态页跳转链接。
前面说到课程搜索的访问流量也是巨大的。因此,必须满足高性能要求。

1.3 业务流程


本章只涉及一个业务流程,课程搜索。

1.3.1 课程搜索


课程计划绑定媒资流程如下:
1.通过门户首页最上面的搜索栏进行搜索可进入课程搜索页,点击门户首页中的课程分类也可进入课程搜索页。

Day10-第五章-课程搜索 - 图3

2.进入课程搜索页后,可选择方向、分类、等级来对已发布课程列表进行筛选,可按照推荐、最新、热评指标对课程列表进行排序。

Day10-第五章-课程搜索 - 图4

3.点击课程搜索页中课程列表的某个课程,可进入课程详情页。

Day10-第五章-课程搜索 - 图5

1.4 课程搜索的数据模型


在内容管理的课程发布业务中,课程发布后会创建 Course_Pub 数据,此数据中包含了整个课程是完整信息,如下示意图:

Day10-第五章-课程搜索 - 图6

课程搜索的数据就是使用 Course_Pub 来做课程检索数据。

2. 课程搜索


1.数据库功能
复杂查询
将用户搜索数据进行分词
用户搜索数据进行模糊匹配(全表扫描)
用户搜索数据可以高亮
用户搜索数据纠错配置(化为)
2.数据库的结构
默认:B+tree(数据库所索引数据+数据)
聚簇索引(聚集索引)、非聚簇索引(非聚集索引)
3.数据库性能
查询的性能
接受请求的并发量(不能接受大量的并发)

2.1 需求分析


此模块主要实现门户对已发布的课程进行多样化检索,检索结果为课程列表。这里还需要满足一个非功能性需求,即前面提到的高性能课程检索
课程搜索

Day10-第五章-课程搜索 - 图7

为了满足高性能课程检索需求,我们将不再使用直接在数据库中执行查询,因为:
●关系型数据库随着数据量的上涨,查询效率递减明显。
●关系型数据库做模糊查询时,如LIKE语句,它会遍历整张表。
●大量的课程读取操作,将影响其他业务。
我们将使用专门的搜索服务Elasticsearch(简称ES),来完成门户对课程的检索功能,使用ES服务进行课程搜索前,需要先将课程信息建立为ES索引数据。因此,项目中必须有一种机制,能够将课程数据定时的、增量的转换为ES索引。

2.1.1 索引库搜索快的原因


对于关系型数据库和索引库都可以查询数据,但是他们使用的场景、性能、数据结构等都是不一样的。

| | Mysql数据库

| ElasticSearch

| | —- | —- | —- | | 数据结构

| B+tree结构

| 索引数据结构

| | 数据索引

| 主键索引默认为聚簇索引,其他索引是非聚簇索引

| 倒排索引

| | 索引特点

| 写入优化的索引结构

| 查找优化的索引结构

|

2.1.1.1 Mysql的索引(面试)


Mysql的主键默认采用聚集索引,其他索引是非聚集索引,两者的索引数据都是采用 B+Tree 数据结构。下面是聚合索引和非聚合索引查询数据示意图,如下:
聚集索引是有规律和有顺序,还有数据的逻辑性。
聚集索引会根据结构找到完整的数据。
聚集索引示意图

Day10-第五章-课程搜索 - 图8

非聚集索引是有无规律和无顺序。
非聚集索引会根据结构找到和聚集索引的关联数据。
非聚集索引示意图

Day10-第五章-课程搜索 - 图9

对于上面的聚合索引和非聚合索引来说,主键的聚合索引插叙速度回快。而非聚合索引要先查询出数据的主键值,然后在根据主键值查询聚合索引数据。
但是对于课程按照关键字查询,不会是根据Id来来进行查询,用户也不知道所要的数据的 id 值,所以对于课程搜索使用Mysql的索引效率并不高,无法满足高性能查询的需求。

2.1.1.2 ElasticSearch的索引


ElasticSearch是基于Lucene 全文检索引擎工具包所开发的全文检索搜索服务,其采用倒排索引的数据结构来实现多条件数据查询,其性能优越。这里我们要说下什么是倒排索引和与之对应的正排索引的区别,如下图:
正排索引

Day10-第五章-课程搜索 - 图10

正排索引简单的可以理解为根据所需要查询的词汇在文档中进行查找,这种搜索方式成为正排索引。正排索引随着文档中内容增多,使得查询的效率变得差。
倒排索引

Day10-第五章-课程搜索 - 图11

在索引库中,大体上分为三个区域,词汇索引、词汇字典、词汇所在文档位置。通过词汇来查找文档,这种形式为倒排索引。
倒排索引的查询,可以通过词汇快速定位到所需要的数据,只要词汇分的够细,那么变更容易查询到数据的所在位置上。

2.1.2 系统交互结构


通过以上的分析,本模块需要实现的内容包括以下两部分:
●产生课程索引
●课程检索
产生课程索引交互流程如下

Day10-第五章-课程搜索 - 图12

步骤描述:
1.课程管理服务将数据写到MySQL数据库
2.使用Logstash将MySQL数据库中的数据写到ES的索引库。
3.用户在前端搜索课程信息,请求到搜索服务。
4.搜索服务请求ES搜索课程信息。
Logstash 是开源的服务器端数据处理管道,能够同时从多个来源采集数据,转换数据,然后将数据发送到其它的“存储库”中,后续我们会对其进行学习。
课程发布业务完善:
1.在课程发布时,要将 CoursePub 中 is_pub 设置为 0,代表为课程发布的数据为已发布状态,Logstash 会检索 is_pub 为 0 的 数据。
2.在课程发布时,要将课程基本信息和课程发布信息进行关联。将课程发布的 CoursePubId 设置到 CourseBase 数据当中。

2.2 搭建ES环境


1.启动 ES 环境
开发环境使用ES单机环境,启动ES服务端(已经集成ik分词器)。
注意:旧的ES环境,可以删除 data\nodes目录以完全清除ES环境。
2.添加ik分词器
1)上传IK安装包
将 资料/es/elasticsearch-analysis-ik-7.10.1.zip上传到服务器的/plugins目录下
2)将指定目录中创建ik目录,并将ik分词器的资源包拷贝到目录中

  1. mkdir -p /usr/soft/elasticsearch/plugins/ik

3)解压

  1. unzip elasticsearch-analysis-ik-7.10.1.zip

4)删除压缩包

  1. rm -rf elasticsearch-analysis-ik-7.10.1.zip

5)重启容器

  1. docker restart elasticsearch

3.安装head插件
chrome浏览器的插件

2.3 Logstash产生索引


Logstash是ES下的一款开源软件,它能够同时 从多个来源采集数据、转换数据,然后将数据发送到Eleasticsearch中创建索引。

Day10-第五章-课程搜索 - 图13

本项目使用Logstash将MySQL中的数据采用到ES索引中。

2.3.1 下载Logstash


下载Logstash 7.10.1 版本,注意:本项目使用的Elasticsearch7.10.1,Logstash要和其版本一致。
https://www.elastic.co/cn/downloads/past-releases/elasticsearch-7-10-1

Day10-第五章-课程搜索 - 图14

2.3.2 安装LogStash


●Linux的容器化部署安装
1)下载logstash镜像

  1. #注意要与ES版本一致
  2. docker pull logstash:7.10.1

2)创建Logstash

  1. #创建logstash本地挂载目录
  2. mkdir -p /etc/logstash
  3. #设置文件写入权限
  4. chown 1000:1000 /etc/logstash/
  5. #docker 创建容器
  6. docker run -d --name logstash --privileged=true -v /etc/logstash/:/etc/logstash/pipeline/ logstash:7.10.1

3)进入容器

  1. docker exec -it logstash /bin/bash

4)修改容器配置文件

  1. #进入config文件
  2. cd config
  3. #更改logstash.yml文件
  4. vi logstash.yml

5)退出并重启容器

  1. #退出容器
  2. exit
  3. #重启容器
  4. docker restart logstash

●windows版的安装
logstash-input-jdbc 是ruby开发的,先下载ruby并安装 下载地址: https://rubyinstaller.org/downloads/
下载2.5版本即可。
安装完成查看是否安装成功

Day10-第五章-课程搜索 - 图15

1.安装logstash-input-jdbc
Logstash5.x以上版本本身自带有logstash-input-jdbc,6.x版本本身不带logstash-input-jdbc插件,需要手动安装,进入到 logstash 根目录进行执行命令,命令如下:

  1. logstash-plugin.bat install logstash-input-jdbc

如图:

Day10-第五章-课程搜索 - 图16

安装成功后我们可以在logstash根目录下的以下目录查看对应的插件版本

Day10-第五章-课程搜索 - 图17

PS:由于下载的插件,会连接外网的库,下载速度回非常的慢,解压老师提供的logstash-6.2.1.zip,此logstash中已集成了logstash-input-jdbc插件,大家不需要在下载,大家对插件的插件下载有所认知即可。

2.3.3 配置Logstash


对于 Logstash 的运行,需要配置两个关键的内容,如下图:

Day10-第五章-课程搜索 - 图18

根据上面的图,我们需要配置 logstash 的.conf 文件,在文件中,需要制定输入 input 的数据来源和 output 的数据输出服务。
在 output 中需要制定,需要配置索引库的模板文件,其中包括创建索引库的名称、索引库的分片数据量、索引库的副本数据量、文档类型等等信息。
总结下来,需要配置两个文件内容:1. logstash 的.conf 文件 2.索引库的模板文件 。

2.4.3.1 配置mysql-es.conf


在logstash的config目录下配置mysql-es-xc.conf文件供logstash使用,logstash会根据配置的地址从MySQL中读取数据向ES中写入索引。
参考https://www.elastic.co/guide/en/logstash/current/plugins-inputs-jdbc.html 配置输入数据源和输出数据源。
●mysql-es-xc.conf

  1. input {
  2. jdbc {
  3. jdbc_connection_string => "jdbc:mysql://192.168.94.129:3306/xc_content?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai"
  4. # the user we wish to excute our statement as
  5. jdbc_user => "root"
  6. jdbc_password => root
  7. # the path to our downloaded jdbc driver
  8. jdbc_driver_library => "/etc/logstash/pipeline/mysql-connector-java-8.0.11.jar"
  9. # the name of the driver class for mysql
  10. jdbc_driver_class => "com.mysql.cj.jdbc.Driver"
  11. jdbc_paging_enabled => "true"
  12. jdbc_page_size => "50000"
  13. jdbc_default_timezone =>"Asia/Shanghai"
  14. #要执行的sql文件
  15. #statement_filepath => "/conf/course.sql"
  16. record_last_run => "true"
  17. use_column_value => "true"
  18. tracking_column => "change_date"
  19. #如果列是时间字段(比如updateTime),一定要指定这个类型为timestamp
  20. tracking_column_type => "timestamp"
  21. statement => "select *,0 AS learners,0 AS comment_num from course_pub where is_pub = 0 and change_date > :sql_last_value"
  22. #定时配置 -- 每个一分钟会采集一次数据
  23. schedule => "* * * * *"
  24. last_run_metadata_path => "/etc/logstash/pipeline/course_pub.meta_date"
  25. }
  26. }
  27. output {
  28. elasticsearch {
  29. #ES的ip地址和端口
  30. hosts => "192.168.94.129:9200"
  31. #hosts => ["localhost:9200","localhost:9202","localhost:9203"]
  32. #ES索引库名称
  33. index => "xc_course"
  34. document_id => "%{id}"
  35. template =>"/etc/logstash/pipeline/xc_course_template.json"
  36. template_name =>"xc_course"
  37. template_overwrite =>"true"
  38. }
  39. stdout {
  40. #日志输出
  41. codec => json_lines
  42. }
  43. }

说明:
1、在 input 的数据来源中,需要查询数据库 course_pub 内容,但只能查询 course_pub 为 is_pub 为 0(课程已发布) 的数据。
2、在查询的数据库 SQL 语句中,我们添加了对 课程的学习人数 和 用户对课程的评论数据。SQL语句中给出的是默认值为 0,后期如果需要修改在对其数值进行修改。
3、在 output 中,我们需要制定索引库模板文件的位置。
4、logstash每个执行完成会在制定的文档中记录执行时间下次以此时间为基准进行增量同步数据到索引库。
相对于课程发布信息之外,还需要增加额外字段来满足筛选、排序需求:
learners为新增字段,表示学习人数,需求中含有按此字段排序,在后续章节介绍课程学习相关内容时才能对此字段填充。
comment_num为新增字段,表示评论人数,需求中含有按此字段排序,在后续章节介绍课程学习相关内容时才能对此字段填充。

2.4.3.2 创建模板文件


Logstash的工作是从MySQL中读取数据,向ES中创建索引,这里需要提前创建mapping的模板文件以便logstash
使用。
在logstach的config目录创建xc_course_template.json,内容如下:

  1. {
  2. "template": "xc_course",
  3. "settings": {
  4. "index.number_of_shards": 3,
  5. "number_of_replicas": 1
  6. },
  7. "mappings" : {
  8. "properties" : {
  9. "charge" : {
  10. "type" : "keyword"
  11. },
  12. "description" : {
  13. "analyzer" : "ik_max_word",
  14. "search_analyzer" : "ik_smart",
  15. "type" : "text"
  16. },
  17. "start_time" : {
  18. "type" : "date"
  19. },
  20. "end_time" : {
  21. "type" : "date"
  22. },
  23. "valid" : {
  24. "type" : "keyword"
  25. },
  26. "grade" : {
  27. "type" : "keyword"
  28. },
  29. "id" : {
  30. "type" : "keyword"
  31. },
  32. "mt" : {
  33. "type" : "keyword"
  34. },
  35. "st" : {
  36. "type" : "keyword"
  37. },
  38. "name" : {
  39. "analyzer" : "ik_max_word",
  40. "search_analyzer" : "ik_smart",
  41. "type" : "text"
  42. },
  43. "pic" : {
  44. "index" : false,
  45. "type" : "keyword"
  46. },
  47. "price" : {
  48. "type": "scaled_float",
  49. "scaling_factor": 100
  50. },
  51. "price_old" : {
  52. "type": "scaled_float",
  53. "scaling_factor": 100
  54. },
  55. "create_date" : {
  56. "type" : "date"
  57. },
  58. "change_date" : {
  59. "type" : "date"
  60. },
  61. "qq" : {
  62. "index" : false,
  63. "type" : "keyword"
  64. },
  65. "studymodel" : {
  66. "type" : "keyword"
  67. },
  68. "teachmode" : {
  69. "type" : "keyword"
  70. },
  71. "teachplan" : {
  72. "analyzer" : "ik_max_word",
  73. "search_analyzer" : "ik_smart",
  74. "type" : "text"
  75. },
  76. "users" : {
  77. "index" : false,
  78. "type" : "text"
  79. },
  80. "status" : {
  81. "type" : "byte"
  82. },
  83. "is_latest" : {
  84. "type" : "byte"
  85. },
  86. "is_pub" : {
  87. "type" : "byte"
  88. },
  89. "remark" : {
  90. "index" : false,
  91. "type" : "text"
  92. },
  93. "course_id" : {
  94. "type" : "keyword"
  95. },
  96. "company_id" : {
  97. "index" : false,
  98. "type" : "keyword"
  99. },
  100. "company_name" : {
  101. "type" : "text"
  102. },
  103. "tags" : {
  104. "index" : false,
  105. "type" : "text"
  106. },
  107. "market" : {
  108. "index" : false,
  109. "type" : "text"
  110. },
  111. "learners" : {
  112. "type" : "long"
  113. },
  114. "comment_num" : {
  115. "type" : "long"
  116. }
  117. }
  118. }
  119. }

2.3.4 测试


●linux容器版
1)将 资料/logstash/配置文件 下的文件拷贝到 /etc/logstash 中
2)修改容器内配置文件

  1. #进入容器
  2. docker exec -it logstash /bin/bash
  3. #进入config文件夹
  4. cd config
  5. #更改pipelines.yml文件
  6. vi pipelines.yml
  1. path.config: "/etc/logstash/pipeline/mysql-es-xc.conf"

3)退出并重启容器

  1. #退出容器
  2. exit
  3. #重启容器
  4. docker restart logstash

●window 版
对于logstash的启动,需要进入
启动logstash.bat:

  1. logstash.bat -f ../config/mysql-es-xc.conf

Day10-第五章-课程搜索 - 图19

修改course_pub中的数据,并且修改change_date为当前时间,观察Logstash⽇日志是否读取到要索引的数据。
最后⽤用head登录ES查看索引⽂文档内容是否修改。

Day10-第五章-课程搜索 - 图20

2.4 创建课程搜索服务

2.5.1 工程导入


导入“资料”下的媒资管理服务基础工程:xc-content-search-service

Day10-第五章-课程搜索 - 图21

2.5.2 配置中心


在nacos中新建应用 search-service-dev.properties,并配置下面信息

  1. server.servlet.context-path = /search
  2. server.port=63080

在 xc-content-search-service 微服务的核心配置文件 bootstrap.yml,引入 Nacos 的配置信息,如下:

  1. #微服务配置
  2. spring:
  3. application:
  4. name: search-service
  5. cloud:
  6. sentinel:
  7. transport:
  8. dashboard: 192.168.94.129:8858 #sentinel控制台地址
  9. nacos:
  10. discovery: #配置注册中心
  11. server-addr: 192.168.94.129:8848
  12. namespace: 自己的dev
  13. group: ${group.name}
  14. config: #配置中心
  15. server-addr: 192.168.94.129:8848
  16. namespace: 自己的dev
  17. group: ${group.name}
  18. file-extension: properties
  19. shared-configs:
  20. - dataId: spring-http-config.properties
  21. group: ${dev.group}
  22. profiles: # 激活配置环境
  23. active: dev
  24. # 组名称
  25. group:
  26. name: xc-group
  27. # 日志文件配置路径
  28. logging:
  29. config: classpath:log4j2-dev.xml
  30. # swagger 文档配置
  31. swagger:
  32. enable: true
  33. title: "学成在线2.0-搜索中心服务API文档"
  34. description: "对内容服务中的数据进行搜索管理"
  35. version: 1.0.0
  36. base-package: com.xuecheng

2.5.3 Elasticsearch客户端集成


(1)引入maven依赖
在 xc-content-search-service 引入 ES 的 maven 依赖信息(已经引入无需再次引入)。

  1. <dependency>
  2. <groupId>org.elasticsearch.client</groupId>
  3. <artifactId>elasticsearch-rest-high-level-client</artifactId>
  4. <version>7.6.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.elasticsearch</groupId>
  8. <artifactId>elasticsearch</artifactId>
  9. <version>7.6.2</version>
  10. </dependency>

(2)Elasticsearch客户端配置
Nacos 中的 search-service-dev.properties 中添加ES客户端的配置,内容如下:

  1. # ES 配置信息
  2. xuecheng.elasticsearch.hostlist = 192.168.94.129:9200
  3. xuecheng.elasticsearch.course.index = xc_course

2.5 课程检索功能开发


对于课程搜索页面中,需要完成下面的功能,如下:

Day10-第五章-课程搜索 - 图22

课程搜索功能需求:
1.分页数据查询
2.根据关键字进行查询
3.根据课程分类和课程等级条件查询
4.根据关键字进行查询后的内容要高亮显示。
在上面的查询条件需求中,需要使用 DSL 不同的查询方式来进行实现。
1.关键字查询,要查询属性 name 和 description 中的数据。对此要使用 MatchQuery 查询方式来查询,查询的数据会先分词在查询。
2.课程等级和课程分类查询,要使用精确匹配。对此使用 termQuery 查询方式来查询,查询数据不会进行分词。
3.由于是多个查询方式共同进行查询,对此要使用 BooleanQuery 来组合多个查询方式。
4.对于课程等级和课程分类精确匹配查询,课程使用 BooleanQuery 查询中的过滤器来查询数据,这样可以提高查询效率。
课程检索交互流程如下

Day10-第五章-课程搜索 - 图23

步骤描述:
1.前端输入检索参数,发起课程检索请求。
2. 课程搜索服务封装检索参数为ES检索条件,向ES服务发起检索请求
3. ES服务执行检索,并返回检索结果
4.课程搜索服务封装ES检索结果为课程信息列表,最终返回给前端

2.6 课程检索接口定义


1.接口参数列表
根据前后端传入参数列表来定义接口
Http接口地址

Day10-第五章-课程搜索 - 图24

接口传入传出列表

Day10-第五章-课程搜索 - 图25

2.传入传出参数封装类
●传入参数封装
在 xc-api 工程的 com.xuecheng.api.search.model.qo 包下创建类,如下:
QueryCoursePubModel为课程检索参数

  1. @Data
  2. @ApiModel(value = "QueryCoursePubModel",description = "课程索引搜索条件查询对象")
  3. public class QueryCoursePubModel {
  4. @ApiModelProperty("查询关键字")
  5. private String keyword;
  6. @ApiModelProperty("课程二级分类")
  7. private String mt;
  8. @ApiModelProperty("课程三级分类")
  9. private String st;
  10. @ApiModelProperty("课程等级")
  11. private String grade;
  12. @ApiModelProperty("排序字段, 推荐/最新/热评")
  13. private String sortFiled;
  14. }

●传出参数封装类
在 xc-api 工程的 com.xuecheng.api.search.model 包下创建类,如下:
CoursePubIndexDTO为检索返回的课程信息

  1. @Data
  2. @ApiModel(value="CoursePubIndexDTO", description="课程发布")
  3. public class CoursePubIndexDTO implements Serializable {
  4. @ApiModelProperty(value = "主键")
  5. private Long indexId;
  6. @ApiModelProperty(hidden = true)
  7. private Long course_id;
  8. @ApiModelProperty(value = "课程标识",example = "1")
  9. public Long getCourseId() {
  10. return course_id;
  11. }
  12. @ApiModelProperty(hidden = true)
  13. private Long company_id;
  14. @ApiModelProperty(value = "机构ID",example = "1")
  15. public Long getCompanyId() {
  16. return company_id;
  17. }
  18. @ApiModelProperty(hidden = true)
  19. private String company_name;
  20. @ApiModelProperty(value = "公司名称")
  21. public String getCompanyName() {
  22. return company_name;
  23. }
  24. @ApiModelProperty(value = "课程名称")
  25. private String name;
  26. @ApiModelProperty(value = "适用人群")
  27. private String users;
  28. @ApiModelProperty(value = "标签")
  29. private String tags;
  30. @ApiModelProperty(value = "大分类")
  31. private String mt;
  32. @ApiModelProperty(value = "大分类名称")
  33. private String mtName;
  34. @ApiModelProperty(value = "小分类")
  35. private String st;
  36. @ApiModelProperty(value = "小分类名称")
  37. private String stName;
  38. @ApiModelProperty(value = "课程等级")
  39. private String grade;
  40. @ApiModelProperty(value = "教育模式(common普通,record 录播,live直播等)")
  41. private String teachmode;
  42. @ApiModelProperty(value = "课程图片")
  43. private String pic;
  44. @ApiModelProperty(value = "课程介绍")
  45. private String description;
  46. @ApiModelProperty(value = "所有课程计划,json格式")
  47. private String teachplan;
  48. @ApiModelProperty(hidden = true)
  49. private Date create_date;
  50. @ApiModelProperty(value = "发布时间")
  51. public Date getCreateDate() {
  52. return create_date;
  53. }
  54. @ApiModelProperty(hidden = true)
  55. private Date change_date;
  56. @ApiModelProperty(value = "修改时间")
  57. public Date getChangeDate() {
  58. return change_date;
  59. }
  60. @ApiModelProperty(hidden = true)
  61. private Integer is_latest;
  62. @ApiModelProperty(value = "是否最新课程(1最新)")
  63. public Integer getIsLatest() {
  64. return is_latest;
  65. }
  66. @ApiModelProperty(hidden = true)
  67. private Integer is_pub;
  68. @ApiModelProperty(value = "是否发布(1发布 0取消发布)")
  69. public Integer getIsPub() {
  70. return is_pub;
  71. }
  72. @ApiModelProperty(value = "状态(1正常 0删除)")
  73. private String status;
  74. @ApiModelProperty(value = "备注")
  75. private String remark;
  76. @ApiModelProperty(value = "课程营销数据")
  77. private String market;
  78. @ApiModelProperty(value = "收费规则,对应数据字典--203")
  79. private String charge;
  80. @ApiModelProperty(value = "现价")
  81. private Float price;
  82. @ApiModelProperty(value = "有效性,对应数据字典--204")
  83. private String valid;
  84. @ApiModelProperty(value = "学习人数")
  85. private Long learners;
  86. @ApiModelProperty(value = "课程评论数")
  87. private Long comment_num;
  88. }

3.接口定义
在 xc-api 工程中新增 com.xuecheng.api.search.CoursePubSearchApi 类并增加如下接口定义:

  1. @Api(value = "课程发布搜索服务API管理")
  2. public interface CoursePubSearchApi {
  3. @ApiOperation("根据条件分页查询")
  4. PageVO<CoursePubIndexDTO> coursePubIndexByCondition(PageRequestParams pageParams, QueryCoursePubModel queryModel);
  5. }


2.6.1 接口实现


(1)服务层实现
接口定义:
在 xc-content-search-service 工程的 com.xuecheng.search.service包下新增以下接口:

  1. /**
  2. * 课程搜索服务层
  3. */
  4. public interface CoursePubSearchService {
  5. /**
  6. * 根据条件分页查询
  7. * @param pageRequestParams {@link PageRequestParams} 分页数据封装对象
  8. * @param queryModel {@link QueryCoursePubModel} 条件查询对象
  9. * @return PageVO 分页封装数据
  10. */
  11. PageVO<CoursePubIndexDTO> queryCoursePubIndex(PageRequestParams pageRequestParams, QueryCoursePubModel queryModel);
  12. }

服务层实现:
在 xc-content-search-service 工程的 com.xuecheng.search.service.impl包下新增以下实现类:

  1. package com.xuecheng.search.service.impl;
  2. import com.xuecheng.api.search.model.dto.CoursePubIndexDTO;
  3. import com.xuecheng.api.search.model.qo.QueryCoursePubIndexModel;
  4. import com.xuecheng.common.domain.page.PageRequestParams;
  5. import com.xuecheng.common.domain.page.PageVO;
  6. import com.xuecheng.common.exception.ExceptionCast;
  7. import com.xuecheng.common.util.JsonUtil;
  8. import com.xuecheng.common.util.StringUtil;
  9. import com.xuecheng.search.common.constant.ContentSearchErrorCode;
  10. import com.xuecheng.search.service.CoursePubSearchService;
  11. import lombok.extern.slf4j.Slf4j;
  12. import org.elasticsearch.action.search.SearchRequest;
  13. import org.elasticsearch.action.search.SearchResponse;
  14. import org.elasticsearch.client.RequestOptions;
  15. import org.elasticsearch.client.RestHighLevelClient;
  16. import org.elasticsearch.common.text.Text;
  17. import org.elasticsearch.index.query.BoolQueryBuilder;
  18. import org.elasticsearch.index.query.MultiMatchQueryBuilder;
  19. import org.elasticsearch.index.query.QueryBuilders;
  20. import org.elasticsearch.index.query.TermQueryBuilder;
  21. import org.elasticsearch.search.SearchHit;
  22. import org.elasticsearch.search.SearchHits;
  23. import org.elasticsearch.search.builder.SearchSourceBuilder;
  24. import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
  25. import org.elasticsearch.search.fetch.subphase.highlight.HighlightField;
  26. import org.springframework.beans.factory.annotation.Autowired;
  27. import org.springframework.beans.factory.annotation.Value;
  28. import org.springframework.stereotype.Service;
  29. import org.springframework.util.ObjectUtils;
  30. import java.io.IOException;
  31. import java.util.ArrayList;
  32. import java.util.Map;
  33. /**
  34. * 课程搜索服务实现层(es原始Api实现)
  35. */
  36. @Slf4j
  37. @Service
  38. public class CoursePubSearchServiceImpl implements CoursePubSearchService {
  39. @Value("${xuecheng.elasticsearch.course.index}")
  40. private String indexName;
  41. @Autowired
  42. private RestHighLevelClient client;
  43. /*
  44. * 主方法的分析:
  45. * 1.创建出SearchRequest
  46. * 1.1 SearchRequest 设置索引库的名称
  47. * 1.2 创建SearchSourceBuilder
  48. * 分页
  49. * 查询方式
  50. * 高亮
  51. * 排序(作业)
  52. * 2.获得响应数据SearchResponse
  53. * 通过Client方法Search方法来获得Response
  54. * 3.解析结果数据并封装PageVO中
  55. * 获得大Hits
  56. * 从大Hits获得总条数
  57. * 从大Hits获得小Htis数组
  58. * 遍历小Hits
  59. * 从小Hist中获得
  60. * 文档id
  61. * 文档的源数据_source
  62. * 文档的高亮
  63. * */
  64. public PageVO<CoursePubIndexDTO> queryCoursePubIndex(PageRequestParams params,
  65. QueryCoursePubModel model) {
  66. PageVO<CoursePubIndexDTO> pageVO = null;
  67. try {
  68. // 1.创建出SearchRequest
  69. SearchRequest request = getSearchRequest(params,model);
  70. // 2.获得响应数据SearchResponse
  71. SearchResponse searchResponse = client.search(request, RequestOptions.DEFAULT);
  72. // 3.解析结果数据并封装PageVO中
  73. pageVO = parseResponse(searchResponse,params);
  74. } catch (IOException e) {
  75. log.error("课程搜索数据失败:{}", e.getMessage());
  76. ExceptionCast.cast(ContentSearchErrorCode.E_150001);
  77. }
  78. return pageVO;
  79. }
  80. /*
  81. * 解析结果数据并封装PageVO中
  82. * */
  83. private PageVO<CoursePubIndexDTO> parseResponse(SearchResponse searchResponse,PageRequestParams params) {
  84. // 1.获得响应数据的大hits
  85. SearchHits hits = searchResponse.getHits();
  86. // 2.查询的总条数
  87. long totalCount = hits.getTotalHits().value;
  88. // 3.获得小hits
  89. SearchHit[] hitsHits = hits.getHits();
  90. ArrayList<CoursePubIndexDTO> list = new ArrayList<>();
  91. // 4.遍历小hits封装数据到PageVO中
  92. for (SearchHit hitsHit : hitsHits) {
  93. // 获得文档的源数据内容
  94. String id = hitsHit.getId();
  95. String jsonString = hitsHit.getSourceAsString();
  96. CoursePubIndexDTO dto = JsonUtil.jsonToObject(jsonString, CoursePubIndexDTO.class);
  97. dto.setIndexId(new Long(id));
  98. // 获得高亮数据
  99. Map<String, HighlightField> highlightFields = hitsHit.getHighlightFields();
  100. HighlightField highlightField = highlightFields.get("name");
  101. if (!(ObjectUtils.isEmpty(highlightField))) {
  102. Text[] fragments = highlightField.getFragments();
  103. StringBuilder stringBuilder = new StringBuilder();
  104. for (Text fragment : fragments) {
  105. stringBuilder.append(fragment);
  106. }
  107. String highLightName = stringBuilder.toString();
  108. dto.setName(highLightName);
  109. }
  110. list.add(dto);
  111. }
  112. PageVO<CoursePubIndexDTO> pageVO = new PageVO<>(list,totalCount,params.getPageNo(),params.getPageSize());
  113. return pageVO;
  114. }
  115. /*
  116. 课程搜索功能需求:
  117. 1.分页数据查询
  118. 2.根据关键字进行查询
  119. 3.根据课程分类和课程等级条件查询
  120. 4.根据关键字进行查询后的内容要高亮显示。
  121. * 创建出SearchRequest
  122. *
  123. *
  124. * 1 SearchRequest 设置索引库的名称
  125. 2 创建SearchSourceBuilder
  126. 分页
  127. 查询方式
  128. 高亮
  129. 排序(作业)
  130. 3.构建查询方式
  131. Boolean
  132. must:
  133. MultiMatchQuery
  134. filter:
  135. TermQuery
  136. 4.设置查询源数据对象
  137. *
  138. * */
  139. private SearchRequest getSearchRequest(PageRequestParams params,
  140. QueryCoursePubModel model) {
  141. // 0.判断分页数据
  142. if (params.getPageNo() < 1) {
  143. params.setPageNo(PageRequestParams.DEFAULT_PAGE_NUM);
  144. }
  145. if (params.getPageSize() < 1) {
  146. params.setPageSize(PageRequestParams.DEFAULT_PAGE_SIZE);
  147. }
  148. // 1.创建SearchRequest对象
  149. SearchRequest request = new SearchRequest(indexName);
  150. // 2.创建搜索源数据对象
  151. SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
  152. // 2.1 设置分页数据
  153. Long pageNo = params.getPageNo();
  154. Integer pageSize = params.getPageSize();
  155. int from = (pageNo.intValue() - 1) * pageSize;
  156. sourceBuilder.from(from);
  157. sourceBuilder.size(pageSize);
  158. // 2.2 设置高亮数据
  159. HighlightBuilder highlightBuilder = new HighlightBuilder();
  160. highlightBuilder.preTags("<font color='red'><b>");
  161. highlightBuilder.postTags("</b></font>");
  162. highlightBuilder.fields().add(new HighlightBuilder.Field("name"));
  163. sourceBuilder.highlighter(highlightBuilder);
  164. // 3.构建查询方式
  165. /*
  166. * 根据关键字进行查询
  167. * 1.对关键字内容需要进行分词
  168. * 2.需要对多个字段进行查询
  169. *
  170. * MultiMatchQuery
  171. * 1.匹配查询--> 对查询的内容先分词后查询
  172. * 2.可以这是对个字段
  173. *
  174. 根据课程分类和课程等级条件查询
  175. 课程分类--> TermQuery
  176. 课程等级--> TermQuery
  177. 对于不分词的查询方式,我们可以使用过滤器来提高查询效率
  178. 上面查询是多种查询方式来构成:BooleanQuery可以对多种查询方式来一同查询
  179. * */
  180. BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
  181. String keyword = model.getKeyword();
  182. if (StringUtil.isNotBlank(keyword)) {
  183. MultiMatchQueryBuilder queryBuilder = QueryBuilders.multiMatchQuery(keyword, "name", "description")
  184. .minimumShouldMatch("80%").field("name",3);
  185. boolQueryBuilder.must(queryBuilder);
  186. }
  187. String grade = model.getGrade();
  188. String mt = model.getMt();
  189. String st = model.getSt();
  190. if (StringUtil.isNotBlank(grade)) {
  191. TermQueryBuilder gradeTerm = QueryBuilders.termQuery("grade", grade);
  192. boolQueryBuilder.filter(gradeTerm);
  193. }
  194. if (StringUtil.isNotBlank(mt)) {
  195. TermQueryBuilder mtTerm = QueryBuilders.termQuery("mt", mt);
  196. boolQueryBuilder.filter(mtTerm);
  197. }
  198. if (StringUtil.isNotBlank(st)) {
  199. TermQueryBuilder stTerm = QueryBuilders.termQuery("st", st);
  200. boolQueryBuilder.filter(stTerm);
  201. }
  202. sourceBuilder.query(boolQueryBuilder);
  203. // 将查询源数据对象存放到Request
  204. request.source(sourceBuilder);
  205. return request;
  206. }
  207. }

(2)Controller实现
CoursePubSearchController中实现课程检索接口

  1. /**
  2. * 课程搜索服务控制层
  3. */
  4. @RestController
  5. @RequestMapping
  6. public class CoursePubSearchController implements CoursePubSearchApi {
  7. @Resource
  8. private CoursePubSearchService couresPubSearchService;
  9. @PostMapping("course_index")
  10. public PageVO<CoursePubIndexDTO> coursePubIndexByCondition(PageRequestParams pageParams, @RequestBody QueryCoursePubModel queryModel) {
  11. PageVO<CoursePubIndexDTO> pageVO = couresPubSearchService.queryCoursePubIndex(pageParams, queryModel);
  12. return pageVO;
  13. }
  14. }

2.6.2接口测试


使用postman进行接口测试,请求界面如下:

Day10-第五章-课程搜索 - 图26

请求消息内容如下:

  1. {
  2. "keyword":"spring",
  3. "mt": "1-3",
  4. "st": "1-3-2",
  5. "grade": "200003"
  6. }

响应内容如下:

Day10-第五章-课程搜索 - 图27