查看: 716|回复: 0

[Java学习] Spring Boot 整合 Elasticsearch,实现 function score query 权重分查询

发表于 2017-8-4 10:26:50
句号论坛
运行环境:JDK 7 或 8,Maven 3.0+

技术栈:SpringBoot 1.5+,ElasticSearch 2.3.2

本文提纲

一、ES 的使用场景

二、运行 springboot-elasticsearch 工程

三、springboot-elasticsearch 工程代码详解

推荐 -

「springboot-learning-example」开源项目,Fork 一下,多多 Pull Request~

spring boot 实践学习案例,是 spring boot 初学者及核心技术巩固的最佳实践。
https://git.oschina.net/jeff1993/springboot-learning-example

一、ES 的使用场景

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

在《Elasticsearch 和插件 elasticsearch-head 安装详解》  和 《Elasticsearch 默认配置 IK 及 Java AnalyzeRequestBuilder 使用》 我详细的介绍了如何安装,初步使用了 IK 分词器。

这里,我主要讲下 SpringBoot 工程中如何使用 ElasticSearch。

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

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

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



二、运行 springboot-elasticsearch 工程

注意的是这里使用的是 ElasticSearch 2.3.2。是因为版本对应关系 :
  1. Spring Boot Version (x) Spring Data Elasticsearch Version (y) Elasticsearch Version (z)
  2. x <= 1.3.5 y <= 1.3.4 z = 1.4.x 2.0.0 <=y < 5.0.0** 2.0.0 <= z < 5.0.0**
  3. * - 只需要你修改下对应的 pom 文件版本号
  4. ** - 下一个 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. }

  8. POST http://127.0.0.1:8080/api/city
  9. {
  10. "id":"2",
  11. "provinceid":"2",
  12. "cityname":"温州",
  13. "description":"温州是个热城市"
  14. }
复制代码
可以打开 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. }
复制代码
下面验证下权重分查询搜索接口的实现: 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.     4.0.0    springboot    springboot-elasticsearch    0.0.1-SNAPSHOT    springboot-elasticsearch :: 整合 Elasticsearch     
  2.             org.springframework.boot        spring-boot-starter-parent        1.5.1.RELEASE               
  3.                     org.springframework.boot            spring-boot-starter-data-elasticsearch               
  4.                     org.springframework.boot            spring-boot-starter-web               
  5.                     junit            junit            4.12
复制代码
这里依赖的 spring-boot-starter-data-elasticsearch 版本是 1.5.1.RELEASE,对应的 spring-data-elasticsearch 版本是 2.1.0.RELEASE。

后面数据操作层都是通过该 spring-data-elasticsearch 提供的接口实现。 操作对应官方文档:http://docs.spring.io/spring-data/elasticsearch/docs/2.1.0.RELEASE/reference/html/。

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 的接口。

更多配置:
  1. spring.data.elasticsearch.cluster-name Elasticsearch 集群名。(默认值: elasticsearch)
  2. spring.data.elasticsearch.cluster-nodes 集群节点地址列表,用逗号分隔。如果没有指定,就启动一个客户端节点。
  3. spring.data.elasticsearch.propertie 用来配置客户端的额外属性。
  4. spring.data.elasticsearch.repositories.enabled 开启 Elasticsearch 仓库。(默认值:true。)
复制代码
3. ES 数据操作层
  1. @Repository
  2. public interface CityRepository extends ElasticsearchRepository {


  3. }
复制代码
接口只要继承 ElasticsearchRepository 类即可。默认会提供很多实现,比如 CRUD 和搜索相关的实现。

4. 实体类
  1. @Document(indexName = "cityindex", type = "city")
  2. public class City implements Serializable{

  3.     private static final long serialVersionUID = -1L;

  4.     /**
  5.      * 城市编号
  6.      */
  7.     private Long id;

  8.     /**
  9.      * 省份编号
  10.      */
  11.     private Long provinceid;

  12.     /**
  13.      * 城市名称
  14.      */
  15.     private String cityname;

  16.     /**
  17.      * 描述
  18.      */
  19.     private String description;
  20. }
复制代码
注意 index 配置必须是全部小写,不然会暴异常。 org.elasticsearch.indices.InvalidIndexNameException: Invalid index name [cityIndex], must be lowercase

5. ES 业务逻辑层
  1. /**
  2. * 城市 ES 业务逻辑实现类
  3. *
  4. * Created by bysocket on 07/02/2017.
  5. */
  6. @Service
  7. public class CityESServiceImpl implements CityService {

  8.     private static final Logger LOGGER = LoggerFactory.getLogger(CityESServiceImpl.class);

  9.     @Autowired
  10.     CityRepository cityRepository;

  11.     @Override
  12.     public Long saveCity(City city) {

  13.         City cityResult = cityRepository.save(city);
  14.         return cityResult.getId();
  15.     }

  16.     @Override
  17.     public List searchCity(Integer pageNumber,
  18.                                  Integer pageSize,
  19.                                  String searchContent) {
  20.         // 分页参数
  21.         Pageable pageable = new PageRequest(pageNumber, pageSize);

  22.         // Function Score Query
  23.         FunctionScoreQueryBuilder functionScoreQueryBuilder = QueryBuilders.functionScoreQuery()
  24.                 .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("cityname", searchContent)),
  25.                     ScoreFunctionBuilders.weightFactorFunction(1000))
  26.                 .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("description", searchContent)),
  27.                         ScoreFunctionBuilders.weightFactorFunction(100));

  28.         // 创建搜索 DSL 查询
  29.         SearchQuery searchQuery = new NativeSearchQueryBuilder()
  30.                 .withPageable(pageable)
  31.                 .withQuery(functionScoreQueryBuilder).build();

  32.         LOGGER.info("\n searchCity(): searchContent [" + searchContent + "] \n DSL  = \n " + searchQuery.getQuery().toString());

  33.         Page searchPageResults = cityRepository.search(searchQuery);
  34.         return searchPageResults.getContent();
  35.     }

  36. }
复制代码
保存逻辑很简单。 分页 function score query 搜索逻辑如下: 先创建分页参数,然后用 FunctionScoreQueryBuilder 定义 Function Score Query,并设置对应字段的权重分值。城市名称 1000 分,description 100 分。 然后创建该搜索的 DSL 查询,并打印出来。

四、小结

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

更多学习内容请登录:http://www.roncoo.com/



太阳http代理AD
回复

使用道具 举报

关闭

站长推荐上一条 /1 下一条