前言
为了简化对Elasticsearch的操作Spring Data提供了Spring Data Elasticsearch。Spring Data Elasticsearch是Spring Data技术对Elasticsearch原生API封装之后的产物,它通过对原生API的封装,使得程序员可以简单的对Elasticsearch进行各种操作。接下来就跟着袁老师一起来学习Spring Data Elasticsearch相关的知识。
一. Spring Data Elasticsearch概述
Spring Data Elasticsearch官方文档地址:Spring Data Elasticsearch。
1.简介
Spring Data for Elasticsearch是Spring Data项目的一部分,该项目旨在为新的数据存储提供一个熟悉且一致的基于Spring的编程模型,同时保留特定于存储的特性和功能。
Spring Data Elasticsearch项目提供了与Elasticsearch搜索引擎的集成。Spring Data Elasticsearch的关键功能领域是一个以POJO为中心的模型,用于与Elasticsearch文档交互,并轻松编写一个Repository风格的数据访问层。
2.特征
Spring Data for Elasticsearch的特性主要见下:
- Spring配置支持使用基于Java的@Configuration类或ES客户端实例的XML命名空间。
- ElasticsearchTemplate帮助类,它可以提高执行常见ES操作的效率。包括文档和POJO之间的集成对象映射。
- 与Spring的转换服务集成的功能丰富的对象映射。
- 基于注释的映射元数据,但可扩展以支持其他元数据格式。
- 自动实现Repository接口,包括对自定义查找器方法的支持。
- 对存储库的CDI支持。
二. Spring Data Elasticsearch配置
1.基本配置
1.我们在【es-client】项目的pom.xml文件中,引入Spring Data Elasticsearch的启动器。
XML
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>
2.在resources目录下的application.yml文件中配置Elasticsearch的host和port信息。
spring:
data:
elasticsearch:
cluster-name: yx-elastic
cluster-nodes: 127.0.0.1:9301,127.0.0.1:9302,127.0.0.1:9303
需要注意的是,Spring Data Elasticsearch底层使用的不是Elasticsearch提供的RestHighLevelClient,而是TransportClient,并不采用HTTP协议通信,而是访问Elasticsearch对外开放的TCP端口。我们在之前集群配置中,设置的端口分别是:9301、9302、9303。
另外,Spring Boot已经帮我们配置好了各种SDE配置,并且注册了一个ElasticsearchTemplate供我们使用。接下来一起来试试吧。
3.在test测试文件夹下的com.yx.es包下创建一个SpringDataESTests测试类。通过@Autowired注解对ElasticsearchTemplate进行注入,测试对象是否可以获取到。
java
package com.yx.es;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.elasticsearch.core.ElasticsearchTemplate;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringDataESTests {
@Autowired
private ElasticsearchTemplate template;
@Test
public void check() {
System.err.println(template);
}
}
4.运行check()方法,输出结果见下:
org.springframework.data.elasticsearch.core.ElasticsearchTemplate@64a7ad02
2.异常解析
如果运行check()方法报错,可能是以下问题所导致。
1.在pom.xml配置文件中,将Spring Boot的版本设置为2.1.6.RELEASE,进行降级处理。原因是安装的Elasticsearch是6.2.4版本,如果Spring Boot的版本过高可能不兼容。
XML
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/>
</parent>
2.检查ElasticsearchTemplate类的导包是否是org.springframework.data.elasticsearch.core.ElasticsearchTemplate。高版本的SDE可能包结构有区别。
3.如果输出结果是"null",原因是低版本的Spring Boot测试类需要添加@RunWith(SpringRunner.class)注解进行修饰。
三. 索引库操作
1.创建索引库
创建索引库需要使用到的注解:
|-----------|---------------------------------------------------------------------------------|
| 注解 | 描述 |
| @Document | 声明索引库配置。参数见下:indexName:索引库名称type:类型名称,默认是"docs"shards:分片数量,默认5replicas:副本数量,默认1 |
| @Id | 声明实体类的id |
| @Field | 声明字段属性。参数见下:type:字段的数据类型analyzer:指定分词器类型index:是否创建索引 |
实际上,与我们自定义工具类类似,SDE也是通过实体类上的注解来配置索引库信息的。
1.我们在Product实体类上添加下面的一些注解。
java
package com.yx.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.FieldType;
@Data
@NoArgsConstructor
@AllArgsConstructor
@Document(indexName = "yx", type = "product", shards = 3, replicas = 1)
public class Product {
@Id
private Long id; // 商品ID
@Field(type = FieldType.Text, analyzer = "ik_max_word")
private String title; // 标题
@Field(type = FieldType.Keyword)
private String category; // 分类
@Field(type = FieldType.Keyword)
private String brand; // 品牌
@Field(type = FieldType.Double)
private Double price; // 价格
@Field(type = FieldType.Keyword, index = false)
private String images; // 图片地址
}
2.在SpringDataESTests类中定义创建索引的createIndex()方法。
java
@Test
public void createIndex() {
// 创建索引库,并制定实体类的字节码
template.createIndex(Product.class);
}
2.创建映射
刚才的注解已经把映射关系也配置上了,所以创建映射只需要这样:
java
@Test
public void createMapping() {
template.putMapping(Product.class);
}
四. 结语
跟着袁老师回顾一下这一章节我们学习的主要内容,首先我们对Spring Data Elasticsearch进行了简单介绍并概述了其特征;然后学习了Spring Data Elasticsearch的基本配置;最后介绍了通过Spring Data Elasticsearch如何操作Elasticsearch。关于Spring Data for Elasticsearch的基本使用就给大家介绍到这里。
今天的内容就分享到这里吧。关注「袁庭新」,干货天天都不断!