查看: 726|回复: 0

[Java学习] 深入浅出 spring-data-elasticsearch - 基本案例详解

发表于 2017-8-8 16:27:28
句号论坛
运行环境:JDK 7 或 8,Maven 3.0+
技术栈:SpringBoot 1.5+, Spring Data Elasticsearch 1.5+ ,ElasticSearch 2.3.2

本文提纲
一、spring-data-elasticsearch-crud 的工程介绍
二、运行 spring-data-elasticsearch-crud 工程
三、spring-data-elasticsearch-crud 工程代码详解


一、spring-data-elasticsearch-crud 的工程介绍
spring-data-elasticsearch-crud 的工程,介绍 Spring Data Elasticsearch 简单的 ES 操作。Spring Data Elasticsearch 可以跟 JPA 进行类比。其使用方法也很简单。


二、运行 spring-data-elasticsearch-crud 工程
注意的是这里使用的是 ElasticSearch 2.3.2。是因为版本对应关系 https://github.com/spring-projects/spring-data-elasticsearch/wiki/Spring-Data-Elasticsearch---Spring-Boot---version-matrix;


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 的版本会有重大的更新

1. 后台起守护线程启动 Elasticsearch
  1. <font size="3">cd elasticsearch-2.3.2/
  2. ./bin/elasticsearch -d</font>
复制代码
git clone 下载工程 springboot-elasticsearch ,项目地址见 GitHub - https://github.com/JeffLi1993/ ... ample。
下面开始运行工程步骤(Quick Start):

2. 项目结构介绍
  1. <font size="3">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 - 应用配置文件,应用启动会自动读取配置</font>
复制代码
本地启动的 ES ,就不需要改配置文件了。如果连测试 ES 服务地址,需要修改相应配置

3.编译工程
在项目根目录 spring-data-elasticsearch-crud,运行 maven 指令:
  1. <font size="3">mvn clean install</font>
复制代码
4.运行工程
右键运行 Application 应用启动类(位置:/springboot-learning-example/springboot-elasticsearch/src/main/java/org/spring/springboot/Application.java)的 main 函数,这样就成功启动了 springboot-elasticsearch 案例。
用 Postman 工具新增两个城市

a. 新增城市信息
  1. <font size="3">POST http://127.0.0.1:8080/api/city
  2. {
  3.     "id”:"1",
  4.     "score":"5",
  5.     "name":"上海",
  6.     "description":"上海是个热城市"
  7. }</font>
复制代码
  1. <font size="3">POST http://127.0.0.1:8080/api/city
  2. {
  3.     "id":"2",
  4.     "score”:"4",
  5.     "name”:”温岭",
  6.     "description":”温岭是个沿海城市"
  7. }</font>
复制代码
可以打开 ES 可视化工具 head 插件:http://localhost:9200/_plugin/head/:
(如果不知道怎么安装,请查阅 《Elasticsearch 和插件 elasticsearch-head 安装详解》 http://www.bysocket.com/?p=1744 。)
在「数据浏览」tab,可以查阅到 ES 中数据是否被插入,插入后的数据格式如下:
  1. <font size="3">{
  2. "_index": "cityindex",
  3. "_type": "city",
  4. "_id": "1",
  5. "_version": 1,
  6. "_score": 1,
  7. "_source": {
  8.   "id":"2",
  9.     "score”:"4",
  10.     "name”:”温岭",
  11.     "description":”温岭是个沿海城市"
  12. }
  13. }</font>
复制代码
下面是基本查询语句的接口:
a. 普通查询,查询城市描述
  1. <font size="3">GET http://localhost:8080/api/city ... on%3D温岭</font>
复制代码
返回 JSON 如下:
  1. <font size="3">[
  2.     {
  3.         "id": 2,
  4.         "name": "温岭",
  5.         "description": "温岭是个沿海城市",
  6.         "score": 4
  7.     }
  8. ]</font>
复制代码
b. AND 语句查询
  1. <font size="3">GET http://localhost:8080/api/city ... on%3D温岭&score=4</font>
复制代码
返回 JSON 如下:
  1. <font size="3">[
  2.     {
  3.         "id": 2,
  4.         "name": "温岭",
  5.         "description": "温岭是个沿海城市",
  6.         "score": 4
  7.     }
  8. ]</font>
复制代码
如果换成 score=5 ,就没有结果了。


c. OR 语句查询
  1. <font size="3">GET http://localhost:8080/api/city ... on%3D上海&score=4</font>
复制代码
返回 JSON 如下:
  1. <font size="3">[
  2.     {
  3.         "id": 2,
  4.         "name": "温岭",
  5.         "description": "温岭是个沿海城市",
  6.         "score": 4
  7.     },
  8.     {
  9.         "id": 1,
  10.         "name": "上海",
  11.         "description": "上海是个好城市",
  12.         "score": 3
  13.     }
  14. ]</font>
复制代码
d. NOT 语句查询
  1. <font size="3">GET http://localhost:8080/api/city ... on%3D温州</font>
复制代码
返回 JSON 如下:
  1. <font size="3">[
  2.     {
  3.         "id": 2,
  4.         "name": "温岭",
  5.         "description": "温岭是个沿海城市",
  6.         "score": 4
  7.     },
  8.     {
  9.         "id": 1,
  10.         "name": "上海",
  11.         "description": "上海是个好城市",
  12.         "score": 3
  13.     }
  14. ]</font>
复制代码
e. LIKE 语句查询
  1. <font size="3">GET http://localhost:8080/api/city ... on%3D城市</font>
复制代码
返回 JSON 如下:
  1. <font size="3">[
  2.     {
  3.         "id": 2,
  4.         "name": "温岭",
  5.         "description": "温岭是个沿海城市",
  6.         "score": 4
  7.     },
  8.     {
  9.         "id": 1,
  10.         "name": "上海",
  11.         "description": "上海是个好城市",
  12.         "score": 3
  13.     }
  14. ]</font>
复制代码
三、spring-data-elasticsearch-crud 工程代码详解
具体代码见 GitHub - https://github.com/JeffLi1993/springboot-learning-example


1.pom.xml 依赖
  1. <font size="3"><?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/ma ... gt%3B
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>springboot</groupId>
  6.     <artifactId>spring-data-elasticsearch-crud</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <name>spring-data-elasticsearch-crud :: spring-data-elasticsearch - 基本案例 </name>
  9.     <!-- Spring Boot 启动父依赖 -->
  10.     <parent>
  11.         <groupId>org.springframework.boot</groupId>
  12.         <artifactId>spring-boot-starter-parent</artifactId>
  13.         <version>1.5.1.RELEASE</version>
  14.     </parent>
  15.     <dependencies>
  16.         <!-- Spring Boot Elasticsearch 依赖 -->
  17.         <dependency>
  18.             <groupId>org.springframework.boot</groupId>
  19.             <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
  20.         </dependency>
  21.         <!-- Spring Boot Web 依赖 -->
  22.         <dependency>
  23.             <groupId>org.springframework.boot</groupId>
  24.             <artifactId>spring-boot-starter-web</artifactId>
  25.         </dependency>
  26.         <!-- Junit -->
  27.         <dependency>
  28.             <groupId>junit</groupId>
  29.             <artifactId>junit</artifactId>
  30.             <version>4.12</version>
  31.         </dependency>
  32.     </dependencies>
  33. </project></font>
复制代码
这里依赖的 spring-boot-starter-data-elasticsearch 版本是 1.5.1.RELEASE,对应的 spring-data-elasticsearch 版本是 2.1.0.RELEASE。对应官方文档:http://docs.spring.io/spring-d ... html/。后面数据操作层都是通过该 spring-data-elasticsearch 提供的接口实现。


2. application.properties 配置 ES 地址
  1. <font size="3"># ES
  2. spring.data.elasticsearch.repositories.enabled = true
  3. spring.data.elasticsearch.cluster-nodes = 127.0.0.1:9300
  4. 默认 9300 是 Java 客户端的端口。9200 是支持 Restful HTTP 的接口。</font>
复制代码
更多配置:
 spring.data.elasticsearch.cluster-name Elasticsearch    集群名。(默认值: elasticsearch)
 spring.data.elasticsearch.cluster-nodes    集群节点地址列表,用逗号分隔。如果没有指定,就启动一个客户端节点。
 spring.data.elasticsearch.propertie     用来配置客户端的额外属性。
 spring.data.elasticsearch.repositories.enabled     开启 Elasticsearch 仓库。(默认值:true。)


3. ES 数据操作层
  1. <font size="3">/**
  2. * ES 操作类
  3. * <p>
  4. * Created by bysocket on 17/05/2017.
  5. */
  6. public interface CityRepository extends ElasticsearchRepository<City, Long> {
  7.     /**
  8.      * AND 语句查询
  9.      *
  10.      * @param description
  11.      * @param score
  12.      * @return
  13.      */
  14.     List<City> findByDescriptionAndScore(String description, Integer score);
  15.     /**
  16.      * OR 语句查询
  17.      *
  18.      * @param description
  19.      * @param score
  20.      * @return
  21.      */
  22.     List<City> findByDescriptionOrScore(String description, Integer score);
  23.     /**
  24.      * 查询城市描述
  25.      *
  26.      * 等同于下面代码
  27.      * @Query("{\"bool\" : {\"must\" : {\"term\" : {\"description\" : \"?0\"}}}}")
  28.      * Page<City> findByDescription(String description, Pageable pageable);
  29.      *
  30.      * @param description
  31.      * @param page
  32.      * @return
  33.      */
  34.     Page<City> findByDescription(String description, Pageable page);
  35.     /**
  36.      * NOT 语句查询
  37.      *
  38.      * @param description
  39.      * @param page
  40.      * @return
  41.      */
  42.     Page<City> findByDescriptionNot(String description, Pageable page);
  43.     /**
  44.      * LIKE 语句查询
  45.      *
  46.      * @param description
  47.      * @param page
  48.      * @return
  49.      */
  50.     Page<City> findByDescriptionLike(String description, Pageable page);
  51. }</font>
复制代码
接口只要继承 ElasticsearchRepository 类即可。默认会提供很多实现,比如 CRUD 和搜索相关的实现。类似于 JPA 读取数据,是使用 CrudRepository 进行操作 ES 数据。支持的默认方法有: count(), findAll(), findOne(ID), delete(ID), deleteAll(), exists(ID), save(DomainObject), save(Iterable<DomainObject>)。


另外可以看出,接口的命名是遵循规范的。常用命名规则如下:
关键字     方法命名
And          findByNameAndPwd
Or             findByNameOrSex
Is              findById
Between   findByIdBetween
Like           findByNameLike
NotLike     findByNameNotLike
OrderBy    findByIdOrderByXDesc
Not           findByNameNot


4. 实体类
  1. <font size="3">/**
  2. * 城市实体类
  3. * <p>
  4. * Created by bysocket on 03/05/2017.
  5. */
  6. @Document(indexName = "province", type = "city")
  7. public class City implements Serializable {
  8.     private static final long serialVersionUID = -1L;
  9.     /**
  10.      * 城市编号
  11.      */
  12.     private Long id;
  13.     /**
  14.      * 城市名称
  15.      */
  16.     private String name;
  17.     /**
  18.      * 描述
  19.      */
  20.     private String description;
  21.     /**
  22.      * 城市评分
  23.      */
  24.     private Integer score;
  25.     public Long getId() {
  26.         return id;
  27.     }
  28.     public void setId(Long id) {
  29.         this.id = id;
  30.     }
  31.     public String getName() {
  32.         return name;
  33.     }
  34.     public void setName(String name) {
  35.         this.name = name;
  36.     }
  37.     public String getDescription() {
  38.         return description;
  39.     }
  40.     public void setDescription(String description) {
  41.         this.description = description;
  42.     }
  43.     public Integer getScore() {
  44.         return score;
  45.     }
  46.     public void setScore(Integer score) {
  47.         this.score = score;
  48.     }
  49. }</font>
复制代码
注意
a. City 属性名不支持驼峰式。
b. indexName 配置必须是全部小写,不然会出异常。
org.elasticsearch.indices.InvalidIndexNameException: Invalid index name [provinceIndex], must be lowercase


更多实战内容请戳:http://www.roncoo.com/article/index



太阳http代理AD
回复

使用道具 举报

关闭

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