spring-data-elasticsearch对ElasticSearch API进行了封装,很好的集成了Spring框架,我们只需要定义好实体类(定义文档、文档类型、索引字段,字段类型等)和实现对应的接口,即可操作ElasticSearch。
1. 版本对应关系 :spring-data-elasticsearch 跟ElasticSearch客户端是有版本对应关系的,低版本的elasticsearch客户端是连接不了高版本的elasticsearch服务器,所以,使用spring-data-elasticsearch前要先确定好elasticsearch服务器版本,然后引入对应的spring-data-elasticsearch 版本。版本对应关系如下:
2. 引入maven依赖
引入maven包
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-elasticsearch</artifactId>
<version>3.1.6.RELEASE</version>
</dependency>
3.定义实体类和对应的Repository
实体类:User.java,类注解和属性注解请看下一节解析。
@Document(indexName = "user_db", type = "user_table")
public class User{
@Id
@Field(type = FieldType.Keyword)
private String userId;
@Field(type= FieldType.Keyword)
private String account;
@Field(type= FieldType.Keyword)
private String userName;
@Field(type= FieldType.Keyword)
private String idCard;
@Field(type = FieldType.Date,
format = DateFormat.custom,
pattern = "yyyy-MM-dd HH:mm:ss")
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
private Date createTime;
//DOTO
//get和set方法
//toString()方法
}
定义Repository:UserRepository,Repository使用请看下一节解析
package com.myelastic.repository;
import com.myelastic.model.User;
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
public interface UserRepository extends ElasticsearchRepository<User, String> {
User findByUserId(StringuserId);
}
至此,实体类和Repository就定义完成了,实体类主要是定义了Java对象跟ES索引、字段映射之间的关系,Repository仓库主要定义了对ES相关的操作,默认集成ElasticsearchRepository类是支持普通的增删查的。
4、引入XML,集成Spring
定义完实体类和Reposity后,就可以通过配置xml文件,并且引入到Spring中。以下为spring-elasticsearch.xml配置:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
<elasticsearch:repositories base-package="com.myelastic.repository" elasticsearch-template-ref="elasticsearchTemplate"/>
<elasticsearch:transport-client id="client" cluster-nodes="ip:9300,ip:9300" cluster-name="elasticsearch" />
<bean name="elasticsearchTemplate" class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
<constructor-arg name="client" ref="client"/>
</bean>
</beans>
base-package:指RepositoryJava类定义包路径,如UserRepository 在包com.myelastic.repository路径下。
elasticsearch-template-ref:指向模板配置bean名称,不填默认为elasticsearchTemplate。
cluster-nodes:集群节点,ip:端口号(Transport 端口,非http端口),多个节点英文逗号(,)隔开。
cluster-name:集群节点名称,对应ES配置文件elasticsearch.yml的cluster.name。
5、完成配置,调用实现
完成以上配置后,就可以在程序中引用调用ES了。
@Service
public class MyService {
@Autowired
private UserRepository repository;
//创建用户索引
public User userIndex(User user) {
User userEs = repository.save(user);
return userEs;
}
//根据用户ID查询用户信息
public User queryUserById(String userId) {
User user = repository.findByUserId(userId);
return user;
}
}