鲨鱼网
Spring Boot整合Elasticsearch，实现function score query权重分查询
创始人
2025-02-12 13:41:34
0次

本文提纲

一、ES 的使用场景

二、运行 springboot-elasticsearch 工程

三、springboot-elasticsearch 工程代码详解

[[191772]]

运行环境：JDK 7 或 8，Maven 3.0+

技术栈：SpringBoot 1.5+，ElasticSearch 2.3.2

一、ES 的使用场景

简单说，ElasticSearch(简称 ES)是搜索引擎，是结构化数据的分布式搜索引擎。在

《Elasticsearch 和插件 elasticsearch-head 安装详解》

《Elasticsearch 默认配置 IK 及 Java AnalyzeRequestBuilder 使用》

我详细的介绍了如何安装，初步使用了 IK 分词器。这里，我主要讲下 SpringBoot 工程中如何使用 ElasticSearch。

ES 的使用场景大致分为两块：

1. 全文检索。加上分词(IK 是其中一个)、拼音插件等可以成为强大的全文搜索引擎。

2. 日志统计分析。可以实时动态分析海量日志数据。

二、运行 springboot-elasticsearch 工程

注意的是这里使用的是 ElasticSearch 2.3.2。是因为版本对应关系 ：

  • Spring Boot Version (x) Spring Data Elasticsearch Version (y) Elasticsearch Version (z)
  • x <= 1.3.5 y <= 1.3.4 z <= 1.7.2*
  • x >= 1.4.x 2.0.0 <=y < 5.0.0** 2.0.0 <= z < 5.0.0**
  • * - 只需要你修改下对应的 pom 文件版本号
  • ** - 下一个 ES 的版本会有重大的更新

git clone 下载工程 springboot-elasticsearch ，项目地址见 GitHub - https://github.com/JeffLi1993/springboot-learning-example。

1. 后台起守护线程启动 Elasticsearch

  1. cd elasticsearch-2.3.2/  
  2. ./bin/elasticsearch -d 

下面开始运行工程步骤(Quick Start)：

2. 项目结构介绍

  1. org.spring.springboot.controller - Controller 层  
  2. org.spring.springboot.repository - ES 数据操作层  
  3. org.spring.springboot.domain - 实体类  
  4. org.spring.springboot.service - ES 业务逻辑层  
  5. Application - 应用启动类  
  6. application.properties - 应用配置文件，应用启动会自动读取配置 

本地启动的 ES ，就不需要改配置文件了。如果连测试 ES 服务地址，需要修改相应配置

3.编译工程

在项目根目录 springboot-elasticsearch，运行 maven 指令：

  1. mvn clean install 

4.运行工程

右键运行 Application 应用启动类(位置：/springboot-learning-example/springboot-elasticsearch/src/main/java/org/spring/springboot/Application.java)的 main 函数，这样就成功启动了 springboot-elasticsearch 案例。

用 Postman 工具新增两个城市

新增城市信息

  1. POST http://127.0.0.1:8080/api/city 
  2. { 
  3.     "id":"1", 
  4.     "provinceid":"1", 
  5.     "cityname":"温岭", 
  6.     "description":"温岭是个好城市" 
  7. } 
  1. POST http://127.0.0.1:8080/api/city 
  2. { 
  3.     "id":"2", 
  4.     "provinceid":"2", 
  5.     "cityname":"温州", 
  6.     "description":"温州是个热城市" 
  7. } 

可以打开 ES 可视化工具 head 插件：http://localhost:9200/_plugin/head/：

(如果不知道怎么安装，请查阅

《Elasticsearch 和插件 elasticsearch-head 安装详解》。)

在「数据浏览」tab，可以查阅到 ES 中数据是否被插入，插入后的数据格式如下：

  1. { 
  2.      "_index": "cityindex", 
  3.      "_type": "city", 
  4.      "_id": "1", 
  5.      "_version": 1, 
  6.      "_score": 1, 
  7.      "_source": { 
  8.           "id": 1, 
  9.           "provinceid": 1, 
  10.           "cityname": "温岭", 
  11.           "description": "温岭是个好城市" 
  12.      } 
  13. } 

下面验证下权重分查询搜索接口的实现：

  1. GET http://localhost:8080/api/city/search?pageNumber=0&pageSize=10&searchContent=温岭 

数据是会出现：

  1. [ 
  2.   { 
  3.     "id": 1, 
  4.     "provinceid": 1, 
  5.     "cityname": "温岭", 
  6.     "description": "温岭是个好城市" 
  7.   }, 
  8.   { 
  9.     "id": 2, 
  10.     "provinceid": 2, 
  11.     "cityname": "温州", 
  12.     "description": "温州是个热城市" 
  13.   } 
  14. ] 

从启动后台 Console 可以看出，打印出来对应的 DSL 语句：

  1.  { 
  2.   "function_score" : { 
  3.     "functions" : [ { 
  4.       "filter" : { 
  5.         "bool" : { 
  6.           "should" : { 
  7.             "match" : { 
  8.               "cityname" : { 
  9.                 "query" : "温岭", 
  10.                 "type" : "boolean" 
  11.               } 
  12.             } 
  13.           } 
  14.         } 
  15.       }, 
  16.       "weight" : 1000.0 
  17.     }, { 
  18.       "filter" : { 
  19.         "bool" : { 
  20.           "should" : { 
  21.             "match" : { 
  22.               "description" : { 
  23.                 "query" : "温岭", 
  24.                 "type" : "boolean" 
  25.               } 
  26.             } 
  27.           } 
  28.         } 
  29.       }, 
  30.       "weight" : 100.0 
  31.     } ] 
  32.   } 
  33. } 

为什么会出现 温州 城市呢?因为 function score query 权重分查询，无相关的数据默认分值为 1。如果想除去，设置一个 setMinScore 分值即可。

三、springboot-elasticsearch 工程代码详解

具体代码见 GitHub - https://github.com/JeffLi1993/springboot-learning-example

1.pom.xml 依赖

  1.  
  2.  
  3.      
  4.      
  5.         org.springframework.boot 
  6.         spring-boot-starter-data-elasticsearch 
  7.      
  8.  
  9.      
  10.      
  11.         org.springframework.boot 
  12.         spring-boot-starter-web 
  13.      
  14.  
  15.      
  16.      
  17.         junit 
  18.         junit 
  19.         4.12 
  20.      
  21.  

2. application.properties 配置 ES 地址

  1. # ES 
  2. spring.data.elasticsearch.repositories.enabled = true 
  3. spring.data.elasticsearch.cluster-nodes = 127.0.0.1:9300 

默认 9300 是 Java 客户端的端口。9200 是支持 Restful HTTP 的接口。

3. ES 数据操作层

  1. @Repository 
  2. public interface CityRepository extends ElasticsearchRepository { 
  3.  
  4. } 

接口只要继承 ElasticsearchRepository 类即可。默认会提供很多实现，比如 CRUD 和搜索相关的实现。

4. 实体类

  1. @Document(indexName = "cityindex", type = "city") 
  2. public class City implements Serializable{ 
  3.  
  4.     private static final long serialVersionUID = -1L; 
  5.  
  6.     /** 
  7.      * 城市编号 
  8.      */ 
  9.     private Long id; 
  10.  
  11.     /** 
  12.      * 省份编号 
  13.      */ 
  14.     private Long provinceid; 
  15.  
  16.     /** 
  17.      * 城市名称 
  18.      */ 
  19.     private String cityname; 
  20.  
  21.     /** 
  22.      * 描述 
  23.      */ 
  24.     private String description; 
  25. } 

注意

index 配置必须是全部小写，不然会引出异常：

  1. org.elasticsearch.indices.InvalidIndexNameException: Invalid index name [cityIndex], must be lowercase 

5. ES 业务逻辑层

Service 实现类：

  1. /** 
  2.  * 城市 ES 业务逻辑实现类 
  3.  * 
  4.  * Created by bysocket on 07/02/2017. 
  5.  */ 
  6. @Service 
  7. public class CityESServiceImpl implements CityService { 
  8.  
  9.     private static final Logger LOGGER = LoggerFactory.getLogger(CityESServiceImpl.class); 
  10.  
  11.     @Autowired 
  12.     CityRepository cityRepository; 
  13.  
  14.     @Override 
  15.     public Long saveCity(City city) { 
  16.  
  17.         City cityResult = cityRepository.save(city); 
  18.         return cityResult.getId(); 
  19.     } 
  20.  
  21.     @Override 
  22.     public List searchCity(Integer pageNumber, 
  23.                                  Integer pageSize, 
  24.                                  String searchContent) { 
  25.         // 分页参数 
  26.         Pageable pageable = new PageRequest(pageNumber, pageSize); 
  27.  
  28.         // Function Score Query 
  29.         FunctionScoreQueryBuilder functionScoreQueryBuilder = QueryBuilders.functionScoreQuery() 
  30.                 .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("cityname", searchContent)), 
  31.                     ScoreFunctionBuilders.weightFactorFunction(1000)) 
  32.                 .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("description", searchContent)), 
  33.                         ScoreFunctionBuilders.weightFactorFunction(100)); 
  34.  
  35.         // 创建搜索 DSL 查询 
  36.         SearchQuery searchQuery = new NativeSearchQueryBuilder() 
  37.                 .withPageable(pageable) 
  38.                 .withQuery(functionScoreQueryBuilder).build(); 
  39.  
  40.         LOGGER.info("\n searchCity(): searchContent [" + searchContent + "] \n DSL  = \n " + searchQuery.getQuery().toString()); 
  41.  
  42.         Page searchPageResults = cityRepository.search(searchQuery); 
  43.         return searchPageResults.getContent(); 
  44.     } 
  45.  
  46. } 

保存逻辑很简单，这里不解释了。

分页 function score query 搜索逻辑：

先创建分页参数，然后用 FunctionScoreQueryBuilder 定义 Function Score Query，并设置对应字段的权重分值。城市名称 1000 分，description 100 分。

然后创建该搜索的 DSL 查询，并打印出来。

四、小结

实际场景还会很复杂。这里只是点睛之笔，后续大家优化或者更改下 DSL 语句就可以完成自己想要的搜索规则。

【本文为51CTO专栏作者“李强强”的原创稿件，转载请通过51CTO联系作者获取授权】

戳这里，看该作者更多好文

上一篇：10款中小企业必备的开源免费安全工具

下一篇：Actoz：将通过法律途径彻底制止Wemade非法行为

相关内容

热门资讯

PHP新手之PHP入门 PHP是一种易于学习和使用的服务器端脚本语言。只需要很少的编程知识你就能使用PHP建立一个真正交互的...
网络中立的未来 网络中立性是什... 《牛津词典》中对“网络中立”的解释是“电信运营商应秉持的一种原则，即不考虑来源地提供所有内容和应用的...
各种千兆交换机的数据接口类型详... 千兆交换机有很多值得学习的地方，这里我们主要介绍各种千兆交换机的数据接口类型，作为局域网的主要连接设...
粉嫩如何诠释霸道 东芝M805... “霸道粉”是个什么玩意东芝M805拿过来的时候，笔者扑哧笑了，不是笑这款笔记本，而是笑这款产品的颜色...
如何利用交换机和端口设置来管理... 在网络管理中，总是有些人让管理员头疼。下面我们就将介绍一下一个网管员利用交换机以及端口设置等来进行D...
什么是大数据安全 什么是大数据... 在《为什么需要大数据安全分析》一文中，我们已经阐述了一个重要观点，即：安全要素信息呈现出大数据的特征...
只需三步，让你掌握阿尔法路由器... 请参照以下阿尔法路由器设置方法，通过浏览器进入及设置宽带路由器。经过这三个步骤的设置，基本上能够熟悉...
如何更省钱? 近期特价热门硒鼓... 如今激光打印设备已经成为商务或企业的绝对主力办公设备，但采购者往往忽视了激光打印设备所用的耗材，相对...
全面诠释网络负载均衡 负载均衡的出现大大缓解了服务器的压力，更是有效的利用了资源，提高了效率。那么我们现在来说一下网络负载...
如何允许远程连接到MySQL数... [[277004]]【51CTO.com快译】默认情况下，MySQL服务器仅侦听来自localhos...