一：运行环境
JDK：1.8
ES：5.6.4
二：学习内容
如何构建spring-data-elasticsearch环境？
如何实现常用的增删改查？
如何实现对象嵌套也就是1对多这种关系？
三：JAVA依赖环境
根据spring-data-elasticsearch官网说明，我这采用的是3.0.6.RELEASE版本，spring boot采用的是2.0.1.RELEASE；
1<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 3 <modelVersion>4.0.0</modelVersion> 4 5 <parent> 6 <groupId>org.springframework.boot</groupId> 7 <artifactId>spring-boot-starter-parent</artifactId> 8 <version>2.0.1.RELEASE</version> 9 <relativePath /> 10 </parent> 11 12 13 <groupId>com.huize.pluto.els</groupId> 14 <artifactId>demo</artifactId> 15 <version>1.0.0-SNAPSHOT</version> 16 <packaging>jar</packaging> 17 18 <name>demo</name> 19 <url>http://maven.apache.org</url> 20 21 <properties> 22 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 23 <elasticsearch.version>5.6.4</elasticsearch.version> 24 <java.version>1.8</java.version> 25 </properties> 26 27 <repositories> 28 <repository> 29 <id>spring-libs-milestone</id> 30 <url>https://repo.spring.io/libs-milestone</url> 31 </repository> 32 </repositories> 33 34 <pluginRepositories> 35 <pluginRepository> 36 <id>spring-plugins-release</id> 37 <url>https://repo.spring.io/plugins-release</url> 38 </pluginRepository> 39 </pluginRepositories> 40 41 <dependencies> 42 <dependency> 43 <groupId>org.springframework.boot</groupId> 44 <artifactId>spring-boot-starter-web</artifactId> 45 </dependency> 46 47 <dependency> 48 <groupId>org.springframework.boot</groupId> 49 <artifactId>spring-boot-starter-test</artifactId> 50 <scope>test</scope> 51 </dependency> 52 53 <dependency> 54 <groupId>org.springframework.data</groupId> 55 <artifactId>spring-data-elasticsearch</artifactId> 56 <version>3.0.6.RELEASE</version> 57 </dependency> 58 59 <!-- 强制声明ES版本 --> 60 <dependency> 61 <groupId>org.elasticsearch</groupId> 62 <artifactId>elasticsearch</artifactId> 63 <version>${elasticsearch.version}</version> 64 </dependency> 65 66 <!-- 因为要采用java编码直接操作ES所以需要引入 --> 67 <dependency> 68 <groupId>org.elasticsearch.client</groupId> 69 <artifactId>transport</artifactId> 70 <version>${elasticsearch.version}</version> 71 <exclusions> 72 <exclusion> 73 <groupId>commons-logging</groupId> 74 <artifactId>commons-logging</artifactId> 75 </exclusion> 76 </exclusions> 77 </dependency> 78 79 </dependencies> 80 81 82 <build> 83 <plugins> 84 <plugin> 85 <groupId>org.apache.maven.plugins</groupId> 86 <artifactId>maven-compiler-plugin</artifactId> 87 <version>3.5.1</version> 88 <configuration> 89 <source>1.8</source> 90 <target>1.8</target> 91 <compilerVersion>1.8</compilerVersion> 92 <encoding>UTF-8</encoding> 93 </configuration> 94 </plugin> 95 </plugins> 96 </build> 97 98</project>
四、spring-data-elasticsearch详解
4.1：配置ES
声明 ElasticsearchTemplate bean ;（当然也可以采用spring boot自动配置方法来实现，因为后面还得直接用JAVA API操作ES，所以这用代码配置了）
1/*** 2 ** 配置ES,支持集群 3 */ 4@Configuration 5public class ElasticConfigration { 6 7 @Value("${elasticsearch.host}") 8 private String esHost; 9 10 @Value("${elasticsearch.port}") 11 private int esPort; 12 13 @Value("${elasticsearch.clusterName}") 14 private String esClusterName; 15 16 private TransportClient client; 17 18 @PostConstruct 19 public void initialize() throws Exception { 20 Settings esSettings = Settings.builder() 21 .put("cluster.name", esClusterName) 22 .put("client.transport.sniff", true).build(); 23 client = new PreBuiltTransportClient(esSettings); 24 25 String[] esHosts = esHost.trim().split(","); 26 for (String host : esHosts) { 27 client.addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName(host), 28 esPort)); 29 } 30 } 31 32 @Bean 33 public Client client() { 34 return client; 35 } 36 37 38 @Bean 39 public ElasticsearchTemplate elasticsearchTemplate() throws Exception { 40 return new ElasticsearchTemplate(client); 41 } 42 43 44 @PreDestroy 45 public void destroy() { 46 if (client != null) { 47 client.close(); 48 } 49 } 50 51}
4.2：编写实体类
声明各个字段类型及相应属性：
1/** 2 * 声明 USER实体，注意有一个1对多关系的roles 3 **/ 4@Document(indexName = "test-user", type = "user",replicas=0,shards=3) 5public class User { 6 7 @Id 8 private String id; 9 10 @Field(type=FieldType.keyword) 11 private String userName; 12 13 @Field(type=FieldType.Integer) 14 private Integer age; 15 16 @Field(type=FieldType.Date) 17 private Date birthday; 18 19 /** 20 * 声明分词器为ik_smart (注意 es要安装ik分词器插件) 21 */ 22 @Field(searchAnalyzer="ik_smart",analyzer="ik_smart",type=FieldType.text) 23 private String description; 24 25 /** 26 * 1对多在spring-data-elasticsearch 统一为nested类型 27 **/ 28 @Field(type=FieldType.Nested,includeInParent=true) 29 private List<Role> roles; 30 31 32 public User() {} 33 34 public User(String userName,Integer age,Date birthday,String description) { 35 this.userName = userName; 36 this.age = age; 37 this.birthday = birthday; 38 this.description = description; 39 } 40 41 public String getId() { 42 return id; 43 } 44 45 46 public void setId(String id) { 47 this.id = id; 48 } 49 50 51 public String getUserName() { 52 return userName; 53 } 54 55 56 public void setUserName(String userName) { 57 this.userName = userName; 58 } 59 60 61 62 public Date getBirthday() { 63 return birthday; 64 } 65 66 67 68 public void setBirthday(Date birthday) { 69 this.birthday = birthday; 70 } 71 72 73 public Integer getAge() { 74 return age; 75 } 76 77 78 public void setAge(Integer age) { 79 this.age = age; 80 } 81 82 83 public String getDescription() { 84 return description; 85 } 86 87 88 public void setDescription(String description) { 89 this.description = description; 90 } 91 92 93 public List<Role> getRoles() { 94 return roles; 95 } 96 97 98 public void setRoles(List<Role> roles) { 99 this.roles = roles; 100 } 101 102 103} 104 105 106@Document(indexName = "test-role", type = "role",replicas=0,shards=3) 107public class Role { 108 109 @Id 110 private String id; 111 112 @Field(type=FieldType.keyword) 113 private String name; 114 115 @Field(type=FieldType.Date) 116 private Date createTime; 117 118 @Field(searchAnalyzer="ik_smart",analyzer="ik_smart",type=FieldType.text) 119 private String description; 120 121 public Role() {} 122 123 public Role(String name,String description,Date createTime) { 124 this.name = name; 125 this.description = description; 126 this.createTime = createTime; 127 } 128 129 public String getId() { 130 return id; 131 } 132 133 134 public void setId(String id) { 135 this.id = id; 136 } 137 138 139 public String getName() { 140 return name; 141 } 142 143 144 public void setName(String name) { 145 this.name = name; 146 } 147 148 149 public Date getCreateTime() { 150 return createTime; 151 } 152 153 154 public void setCreateTime(Date createTime) { 155 this.createTime = createTime; 156 } 157 158 159 public String getDescription() { 160 return description; 161 } 162 163 164 public void setDescription(String description) { 165 this.description = description; 166 } 167 168}
4.3：编写dao
只要继承ElasticsearchRepository就具有常用的增删减查功能了，可以新增一些其他需要用到的查询
1public interface UserRepository extends ElasticsearchRepository<User,String>{ 2 3 //按userName like查询 4 List<User> findByUserNameLike(String userName); 5 6 //按role的name属性查询 7 List<User> findByRolesName(String name); 8 9 //按role的name属性查询 两种方式都可以 10 List<User> findByRoles_Name(String name); 11 12}
4.4：编写service
1@Service 2public class UserStandardService implements StandardService{ 3 4 @Autowired 5 private UserRepository userRepository; 6 7 @Autowired 8 private ElasticsearchTemplate elasticsearchTemplate; 9 10 /** 11 * 批量新增 12 **/ 13 @Override 14 public void batchAddUser(List<User> users) { 15 if(CollectionUtils.isEmpty(users)) { 16 return ; 17 } 18 List<IndexQuery> queries = Lists.newArrayListWithExpectedSize(users.size()); 19 IndexQuery indexItem = null; 20 for(User user :users) { 21 indexItem = new IndexQuery(); 22 indexItem.setObject(user); 23 queries.add(indexItem); 24 } 25 elasticsearchTemplate.bulkIndex(queries); 26 } 27 28 @Override 29 public void addUser(User user) { 30 userRepository.save(user); 31 } 32 33 @Override 34 public void deletedUserById(String id) { 35 userRepository.deleteById(id); 36 } 37 38 /** 39 * 根据userId更新信息 40 */ 41 @Override 42 public void updateUser(User user) { 43 UpdateQuery updateQuery = new UpdateQuery(); 44 updateQuery.setId(user.getId()); 45 updateQuery.setClazz(User.class); 46 user.setId(null); 47 UpdateRequest request = new UpdateRequest(); 48 request.doc(JsonUtils.beanToJson(user)); 49 updateQuery.setUpdateRequest(request); 50 elasticsearchTemplate.update(updateQuery); 51 } 52 53 @Override 54 public List<User> queryByUserName(String userName) { 55 return userRepository.findByUserNameLike(userName); 56 } 57 58 @Override 59 public List<User> queryByRoleName(Role role) { 60 return userRepository.findByRoles_Name(role.getName()); 61 } 62 63}
4.5：启动
主要要加上 @EnableElasticsearchRepositories 注解；
1@EnableElasticsearchRepositories(basePackages = "com.test.els.demo.core.user.repository") 2@SpringBootApplication 3public class DemoApplication { 4 5 private static final Logger logger = LoggerFactory.getLogger(DemoApplication.class); 6 7 public static void main(String[] args) { 8 9 SpringApplication.run(DemoApplication.class, args); 10 logger.info("start completed ！"); 11 } 12 13 14}
OK，到这spring-data-elasticsearch 实践完了。