开放原子开发者工作坊

一、概述

Spring Data是Spring下的一个子项目，用于简化数据库访问，并支持云服务的开源框架。Spring Data支持NoSQL和 关系数据存储，其主要目标是使得数据库的访问变得方便快捷。并支持map-reduce框架和云计算数据服务。对于拥有海量数据的项目，可以用Spring Data来简化项目的开发。 然而针对不同的数据储存访问使用相对的类库来操作访问。Spring Data中已经为我们提供了很多业务中常用的一些接口和实现类来帮我们快速构建项目，比如分页、排序、DAO一些常用的操作。 

 

二、环境搭建

1.1 导入jar包

 

1.2 applicationContext.xml配置

 

1. <?xml version="1.0" encoding="UTF-8"?>

2. <beans xmlns="http://www.springframework.org/schema/beans"

3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

4. xmlns:context="http://www.springframework.org/schema/context"

5. xmlns:tx="http://www.springframework.org/schema/tx"

6. xmlns:jpa="http://www.springframework.org/schema/data/jpa"

7. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd

8. http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd

9. http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd

10. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

11.  

12. <!-- 配置自动扫描的包 -->

13. <context:component-scan base-package="com.test.springdata"></context:component-scan>

14.  

15. <!-- 1. 配置数据源 -->

16. <context:property-placeholder location="classpath:config.properties"/>

17.  

18. <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">

19. <property name="driverClass" value="${jdbc.driver}" />

20. <property name="jdbcUrl" value="${jdbc.url}" />

21. <property name="user" value="${jdbc.user}" />

22. <property name="password" value="${jdbc.password}" />

23. </bean>

24.  

25. <!-- 2. 配置 JPA 的 EntityManagerFactory -->

26. <bean id="entityManagerFactory"

27. class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">

28. <property name="dataSource" ref="dataSource"></property>

29. <property name="jpaVendorAdapter">

30. <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"></bean>

31. </property>

32. <property name="packagesToScan" value="com.test.springdata"></property>

33. <property name="jpaProperties">

34. <props>

35. <!-- 二级缓存相关 -->

36.  

37. <!-- <prop key="hibernate.cache.region.factory_class">org.hibernate.cache.ehcache.EhCacheRegionFactory</prop>

38. <prop key="net.sf.ehcache.configurationResourceName">ehcache-hibernate.xml</prop> -->

39.  

40. <!-- 生成的数据表的列的映射策略 -->

41. <prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop>

42. <!-- hibernate 基本属性 -->

43. <prop key="hibernate.dialect">org.hibernate.dialect.Oracle10gDialect</prop>

44. <prop key="hibernate.show_sql">true</prop>

45. <prop key="hibernate.format_sql">true</prop>

46. <prop key="hibernate.hbm2ddl.auto">update</prop>

47. </props>

48. </property>

49. </bean>

50.  

51. <!-- 3. 配置事务管理器 -->

52. <bean id="transactionManager"

53. class="org.springframework.orm.jpa.JpaTransactionManager">

54. <property name="entityManagerFactory" ref="entityManagerFactory"></property>

55. </bean>

56.  

57. <!-- 4. 配置支持注解的事务 -->

58. <tx:annotation-driven transaction-manager="transactionManager"/>

59.  

60. <!-- 5. 配置 SpringData -->

61. <!-- 加入 jpa 的命名空间 -->

62. <!-- base-package: 扫描 Repository Bean 所在的 package -->

63. <jpa:repositories base-package="com.test.springdata"

64. entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>

65.  

66. </beans>

 

三、Repository接口

Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法。

 

public interface Repository<T, ID extends Serializable> {}

 

说明：

 

• Repository是一个空接口，即是一个标记接口
• 若我们定义的接口继承了Repository，则该接口会被IOC容器识别为一个Repository Bean注入到IOC容器中，只要遵循Spring Data的方法定义规范，就无需写实现类。
• 与继承 Repository 等价的一种方式，就是在持久层接口上使用 @RepositoryDefinition 注解，并为其指定 domainClass 和 idClass 属性。如下两种方式是完全等价的

 

 

@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)

 

3.1 Repository的子接口

基础的 Repository 提供了最基本的数据访问功能，其几个子接口则扩展了一些功能。它们的继承关系如下： 

• Repository： 仅仅是一个标识，表明任何继承它的均为仓库接口类
• CrudRepository： 继承 Repository，实现了一组 CRUD 相关的方法 
• PagingAndSortingRepository： 继承 CrudRepository，实现了一组分页排序相关的方法 
• JpaRepository： 继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法 

 

 

3.2 Spring Data方法定义规范

查询方法以find | read | get开头，设计条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。 

例如：定义一个 Entity 实体类 

 

 

1. class User｛

2. private String firstName;

3. private String lastName;

4. ｝

使用And条件连接时，应这样写： 

 

findByLastNameAndFirstName(String lastName,String firstName); 

条件的属性名称与个数要与参数的位置与个数一一对应 

 

 

直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：

 

 

三、CrudRepository接口

CrudRepository 接口提供了最基本的对实体类的添删改查操作 

 

• T save(T entity);//保存单个实体 
• Iterable<T> save(Iterable<? extends T> entities);//保存集合        
• T findOne(ID id);//根据id查找实体         
• boolean exists(ID id);//根据id判断实体是否存在         
• Iterable<T> findAll();//查询所有实体,不用或慎用!         
• long count();//查询实体数量         
• void delete(ID id);//根据Id删除实体         
• void delete(T entity);//删除一个实体 
• void delete(Iterable<? extends T> entities);//删除一个实体的集合         
• void deleteAll();//删除所有实体,不用或慎用! 

 

 

四、PagingAndSortingRepository接口

PagingAndSortingRepository接口提供了分页与排序的功能：

 

• Iterable<T> findAll(Sort sort); //排序 
• Page<T> findAll(Pageable pageable); //分页查询（含排序功能） 

 

 

五、JpaRepository接口

JpaRepository接口提供了JPA的相关功能： 

 

• List<T> findAll(); //查找所有实体 
• List<T> findAll(Sort sort); //排序、查找所有实体 
• List<T> save(Iterable<? extends T> entities);//保存集合 
• void flush();//执行缓存与数据库同步 
• T saveAndFlush(T entity);//强制执行持久化 
• void deleteInBatch(Iterable<T> entities);//删除一个实体集合 

 

 

示例代码

Person实体类

 

1. package com.test.springdata;

2.  

3. import java.util.Date;

4.  

5. import javax.persistence.Column;

6. import javax.persistence.Entity;

7. import javax.persistence.GeneratedValue;

8. import javax.persistence.Id;

9. import javax.persistence.JoinColumn;

10. import javax.persistence.ManyToOne;

11. import javax.persistence.Table;

12.  

13. @Table(name="JPA_PERSONS")

14. @Entity

15. public class Person {

16.  

17. private Integer id;

18. private String lastName;

19.  

20. private String email;

21. private Date birth;

22.  

23. private Address address;

24.  

25. private Integer addressId;

26.  

27. @GeneratedValue

28. @Id

29. public Integer getId() {

30. return id;

31. }

32.  

33. public void setId(Integer id) {

34. this.id = id;

35. }

36.  

37. public String getLastName() {

38. return lastName;

39. }

40.  

41. public void setLastName(String lastName) {

42. this.lastName = lastName;

43. }

44.  

45. public String getEmail() {

46. return email;

47. }

48.  

49. public void setEmail(String email) {

50. this.email = email;

51. }

52.  

53. public Date getBirth() {

54. return birth;

55. }

56.  

57. public void setBirth(Date birth) {

58. this.birth = birth;

59. }

60.  

61. @Column(name="ADD_ID")

62. public Integer getAddressId() {

63. return addressId;

64. }

65.  

66. public void setAddressId(Integer addressId) {

67. this.addressId = addressId;

68. }

69.  

70. @JoinColumn(name="ADDRESS_ID")

71. @ManyToOne

72. public Address getAddress() {

73. return address;

74. }

75.  

76. public void setAddress(Address address) {

77. this.address = address;

78. }

79.  

80. @Override

81. public String toString() {

82. return "Person [id=" + id + ", lastName=" + lastName + ", email="

83. + email + ", brith=" + birth + "]";

84. }

85. }

Address实体类

 

1. package com.test.springdata;

2.  

3. import javax.persistence.Entity;

4. import javax.persistence.GeneratedValue;

5. import javax.persistence.Id;

6. import javax.persistence.Table;

7.  

8. @Table(name="JPA_ADDRESSES")

9. @Entity

10. public class Address {

11.  

12. private Integer id;

13. private String province;

14. private String city;

15.  

16. @GeneratedValue

17. @Id

18. public Integer getId() {

19. return id;

20. }

21.  

22. public void setId(Integer id) {

23. this.id = id;

24. }

25.  

26. public String getProvince() {

27. return province;

28. }

29.  

30. public void setProvince(String province) {

31. this.province = province;

32. }

33.  

34. public String getCity() {

35. return city;

36. }

37.  

38. public void setCity(String city) {

39. this.city = city;

40. }

41.  

42. }

JpaRepsotory类 --- PersonRepsotory类

 

1. package com.test.springdata;

2.  

3. import java.util.Date;

4. import java.util.List;

5.  

6. import org.springframework.data.jpa.repository.JpaRepository;

7. import org.springframework.data.jpa.repository.JpaSpecificationExecutor;

8. import org.springframework.data.jpa.repository.Modifying;

9. import org.springframework.data.jpa.repository.Query;

10. import org.springframework.data.repository.CrudRepository;

11. import org.springframework.data.repository.PagingAndSortingRepository;

12. import org.springframework.data.repository.Repository;

13. import org.springframework.data.repository.RepositoryDefinition;

14. import org.springframework.data.repository.query.Param;

15.  

16. /**

17. * 1、Repository 是一个空接口，即使一个标记接口

18. * 2、若我们定义的接口继承了Repository，则该接口会被IOC容器识别为一个Repository Bean

19. * 纳入到IOC容器中，进而可以在该接口中定义满足一定规范的方法

20. * 3、可以通过注解的方式标记Repository接口

21. */

22. /**

23. * 方式一：继承Repository<Person,Integer>接口

24. * public interface PersonRepsotory extends Repository<Person,Integer>{

25. * */

26.  

27. /**

28. * 方式二：注解@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)

29. *

30. */

31. /**

32. * 在Repository子接口中声明方法

33. * 1、不是随便声明的，而需要符合一定的规范

34. * 2、查询方法以find | read | get开头

35. * 3、涉及条件查询时，条件的属性用条件关键字连接

36. * 4、要注意的是：条件属性以首字母大写

37. * 5、支持属性的级联查询，若当前类有符合条件的属性，则优先使用，而不使用级联属性。若需要使用级联属性，则属性之间使用_连接

38. *

39. */

40. // @RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)

41. //public interface PersonRepsotory extends Repository<Person, Integer>{

42. //public interface PersonRepsotory extends CrudRepository<Person, Integer>{

43. //public interface PersonRepsotory extends JpaRepository<Person, Integer>,JpaSpecificationExecutor<Person>{

44.  

45. public interface PersonRepsotory extends Repository<Person, Integer>{

46.  

47. // 根据lastName来获取对应的Person

48. Person getByLastName(String lastName);

49.  

50. // Where lastName like ?% And id < ?

51. List<Person> getByLastNameStartingWithAndIdLessThan(String lastName, Integer id);

52.  

53. // Where lastName like %? And id < ?

54. List<Person> getByLastNameEndingWithAndIdLessThan(String lastName, Integer id);

55.  

56. //WHERE email IN (?, ?, ?) OR birth < ?

57. List<Person> getByEmailInAndBirthLessThan(List<String> emails, Date birth);

58.  

59. //WHERE a.id > ?

60. List<Person> getByAddress_IdGreaterThan(Integer id);

61.  

62. //查询 id 值最大的那个 Person

63. //使用 @Query 注解可以自定义 JPQL 语句以实现更灵活的查询

64. @Query("SELECT p FROM Person p WHERE p.id = (SELECT max(p2.id) FROM Person p2)")

65. Person getMaxIdPerson();

66.  

67. //为 @Query 注解传递参数的方式1: 使用占位符.

68. @Query("SELECT p FROM Person p WHERE p.lastName = ?1 AND p.email = ?2")

69. List<Person> testQueryAnnotationParams1(String lastName, String email);

70.  

71. //为 @Query 注解传递参数的方式1: 命名参数的方式.

72. @Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")

73. List<Person> testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName);

74.  

75. //SpringData 允许在占位符上添加 %%.

76. @Query("SELECT p FROM Person p WHERE p.lastName LIKE %?1% OR p.email LIKE %?2%")

77. List<Person> testQueryAnnotationLikeParam(String lastName, String email);

78.  

79. //SpringData 允许在占位符上添加 %%.

80. @Query("SELECT p FROM Person p WHERE p.lastName LIKE %:lastName% OR p.email LIKE %:email%")

81. List<Person> testQueryAnnotationLikeParam2(@Param("email") String email, @Param("lastName") String lastName);

82.  

83. //设置 nativeQuery=true 即可以使用原生的 SQL 查询

84. @Query(value="SELECT count(id) FROM jpa_persons", nativeQuery=true)

85. long getTotalCount();

86.  

87. //可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作. 注意: JPQL 不支持使用 INSERT

88. //在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个 UPDATE 或 DELETE 操作

89. //UPDATE 或 DELETE 操作需要使用事务, 此时需要定义 Service 层. 在 Service 层的方法上添加事务操作.

90. //默认情况下, SpringData 的每个方法上有事务, 但都是一个只读事务. 他们不能完成修改操作!

91. @Modifying

92. @Query("UPDATE Person p SET p.email = :email WHERE id = :id")

93. void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);

94.  

95. }

 

PersonService类

 

1. package com.test.springdata;

2.  

3. import java.util.List;

4.  

5. import org.springframework.beans.factory.annotation.Autowired;

6. import org.springframework.stereotype.Service;

7. import org.springframework.transaction.annotation.Transactional;

8.  

9. @Service

10. public class PersonService {

11.  

12. @Autowired

13. private PersonRepsotory personRepsotory;

14.  

15. @Transactional

16. public void savePersons(List<Person> persons){

17. personRepsotory.save(persons);

18. }

19.  

20. @Transactional

21. public void updatePersonEmail(String email, Integer id){

22. personRepsotory.updatePersonEmail(id, email);

23. }

24. }

Test类

 

1. package com.test.springdata.test;

2.  

3. import java.io.FileNotFoundException;

4. import java.io.IOException;

5. import java.sql.SQLException;

6. import java.util.ArrayList;

7. import java.util.Arrays;

8. import java.util.Date;

9. import java.util.List;

10.  

11. import javax.persistence.criteria.CriteriaBuilder;

12. import javax.persistence.criteria.CriteriaQuery;

13. import javax.persistence.criteria.Path;

14. import javax.persistence.criteria.Predicate;

15. import javax.persistence.criteria.Root;

16. import javax.sql.DataSource;

17.  

18. import org.junit.Test;

19. import org.springframework.context.ApplicationContext;

20. import org.springframework.context.support.ClassPathXmlApplicationContext;

21. import org.springframework.data.domain.Page;

22. import org.springframework.data.domain.PageRequest;

23. import org.springframework.data.domain.Sort;

24. import org.springframework.data.domain.Sort.Direction;

25. import org.springframework.data.domain.Sort.Order;

26. import org.springframework.data.jpa.domain.Specification;

27.  

28. import com.test.springdata.Person;

29. import com.test.springdata.PersonRepsotory;

30. import com.test.springdata.PersonService;

31.  
32.  

33. public class SpringDataTest {

34.  

35. private ApplicationContext ctx = null;

36. private PersonRepsotory personRepsotory = null;

37. private PersonService personService;

38.  

39. {

40. ctx = new ClassPathXmlApplicationContext("applicationContext.xml");

41. personRepsotory = ctx.getBean(PersonRepsotory.class);

42. personService = ctx.getBean(PersonService.class);

43. }

44.  

45. /*@Test

46. public void testCommonCustomRepositoryMethod(){

47. ApplicationContext ctx2 = new ClassPathXmlApplicationContext("classpath:com/atguigu/springdata/commonrepositorymethod/applicationContext2.xml");

48. AddressRepository addressRepository = ctx2.getBean(AddressRepository.class);

49. addressRepository.method();

50. }

51.  

52. @Test

53. public void testCustomRepositoryMethod(){

54. personRepsotory.test();

55. }*/

56.  

57. /**

58. * 目标: 实现带查询条件的分页. id > 5 的条件

59. *

60. * 调用 JpaSpecificationExecutor 的 Page<T> findAll(Specification<T> spec, Pageable pageable);

61. * Specification: 封装了 JPA Criteria 查询的查询条件

62. * Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort

63. */

64. /*@Test

65. public void testJpaSpecificationExecutor(){

66. int pageNo = 3 - 1;

67. int pageSize = 5;

68. PageRequest pageable = new PageRequest(pageNo, pageSize);

69.  

70. //通常使用 Specification 的匿名内部类

71. Specification<Person> specification = new Specification<Person>() {

72. *//**

73. * @param *root: 代表查询的实体类.

74. * @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以

75. * 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象.

76. * @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象

77. * @return: *Predicate 类型, 代表一个查询条件.

78. *//*

79. @Override

80. public Predicate toPredicate(Root<Person> root,

81. CriteriaQuery<?> query, CriteriaBuilder cb) {

82. Path path = root.get("id");

83. Predicate predicate = cb.gt(path, 5);

84. return predicate;

85. }

86. };

87.  

88. Page<Person> page = personRepsotory.findAll(specification, pageable);

89.  

90. System.out.println("总记录数: " + page.getTotalElements());

91. System.out.println("当前第几页: " + (page.getNumber() + 1));

92. System.out.println("总页数: " + page.getTotalPages());

93. System.out.println("当前页面的 List: " + page.getContent());

94. System.out.println("当前页面的记录数: " + page.getNumberOfElements());

95. }*/

96.  

97. /*@Test

98. public void testJpaRepository(){

99. Person person = new Person();

100. person.setBirth(new Date());

101. person.setEmail("xy@atguigu.com");

102. person.setLastName("xyz");

103.  

104. Person person2 = personRepsotory.saveAndFlush(person);

105.  

106. System.out.println(person == person2);

107. }*/

108.  

109. /*@Test

110. public void testPagingAndSortingRespository(){

111. //pageNo 从 0 开始.

112. int pageNo = 0;

113. int pageSize = 5;

114. //Pageable 接口通常使用的其 PageRequest 实现类. 其中封装了需要分页的信息

115. //排序相关的. Sort 封装了排序的信息

116. //Order 是具体针对于某一个属性进行升序还是降序.

117. Order order1 = new Order(Direction.DESC, "id");

118. Order order2 = new Order(Direction.ASC, "email");

119. Sort sort = new Sort(order1, order2);

120.  

121. PageRequest pageable = new PageRequest(pageNo, pageSize, sort);

122. Page<Person> page = personRepsotory.findAll(pageable);

123.  

124. System.out.println("总记录数: " + page.getTotalElements());

125. System.out.println("当前第几页: " + (page.getNumber() + 1));

126. System.out.println("总页数: " + page.getTotalPages());

127. System.out.println("当前页面的 List: " + page.getContent());

128. System.out.println("当前页面的记录数: " + page.getNumberOfElements());

129. }*/

130.  

131. @Test

132. public void testCrudReposiory(){

133. List<Person> persons = new ArrayList<>();

134.  

135. for(int i = 'a'; i <= 'z'; i++){

136. Person person = new Person();

137. person.setAddressId(i + 1);

138. person.setBirth(new Date());

139. person.setEmail((char)i + "" + (char)i + "@atguigu.com");

140. person.setLastName((char)i + "" + (char)i);

141.  

142. persons.add(person);

143. }

144.  

145. personService.savePersons(persons);

146. }

147.  

148. @Test

149. public void testModifying(){

150. // personRepsotory.updatePersonEmail(1, "mmmm@atguigu.com");

151. personService.updatePersonEmail("mmmm@atguigu.com", 1);

152. }

153.  

154. @Test

155. public void testNativeQuery(){

156. long count = personRepsotory.getTotalCount();

157. System.out.println(count);

158. }

159.  

160. @Test

161. public void testQueryAnnotationLikeParam(){

162. // List<Person> persons = personRepsotory.testQueryAnnotationLikeParam("%A%", "%bb%");

163. // System.out.println(persons.size());

164.  

165. // List<Person> persons = personRepsotory.testQueryAnnotationLikeParam("A", "bb");

166. // System.out.println(persons.size());

167.  

168. List<Person> persons = personRepsotory.testQueryAnnotationLikeParam2("bb", "A");

169. System.out.println(persons.size());

170. }

171.  

172. @Test

173. public void testQueryAnnotationParams2(){

174. List<Person> persons = personRepsotory.testQueryAnnotationParams2("aa@atguigu.com", "AA");

175. System.out.println(persons);

176. }

177.  

178. @Test

179. public void testQueryAnnotationParams1(){

180. List<Person> persons = personRepsotory.testQueryAnnotationParams1("AA", "aa@atguigu.com");

181. System.out.println(persons);

182. }

183.  

184. @Test

185. public void testQueryAnnotation(){

186. Person person = personRepsotory.getMaxIdPerson();

187. System.out.println(person);

188. }

189.  

190. @Test

191. public void testKeyWords2(){

192. List<Person> persons = personRepsotory.getByAddress_IdGreaterThan(1);

193. System.out.println(persons);

194. }

195.  

196. @Test

197. public void testKeyWords(){

198. List<Person> persons = personRepsotory.getByLastNameStartingWithAndIdLessThan("X", 10);

199. System.out.println(persons);

200.  

201. persons = personRepsotory.getByLastNameEndingWithAndIdLessThan("X", 10);

202. System.out.println(persons);

203.  

204. persons = personRepsotory.getByEmailInAndBirthLessThan(Arrays.asList("AA@atguigu.com", "FF@atguigu.com",

205. "SS@atguigu.com"), new Date());

206. System.out.println(persons.size());

207. }

208.  

209. @Test

210. public void testHelloWorldSpringData() throws FileNotFoundException, IOException, InstantiationException, IllegalAccessException{

211. System.out.println(personRepsotory.getClass().getName());

212.  

213. Person person = personRepsotory.getByLastName("AA");

214. System.out.println(person);

215. }

216.  

217. @Test

218. public void testJpa(){

219.  

220. }

221.  

222. @Test

223. public void testDataSource() throws SQLException {

224. DataSource dataSource = ctx.getBean(DataSource.class);

225. System.out.println(dataSource.getConnection());

226. }

227.  

228. }

六、JpaSpecificationExecutor接口

不属于Repository体系，实现一组 JPA Criteria 查询相关的方法 


Specification：封装  JPA Criteria 查询条件。

通常使用匿名内部类的方式来创建该接口的对象

 

示例代码：

Test代码，其他代码参考JpaRepository

 

1. /**

2. * 目标: 实现带查询条件的分页. id > 5 的条件

3. *

4. * 调用 JpaSpecificationExecutor 的 Page<T> findAll(Specification<T> spec, Pageable pageable);

5. * Specification: 封装了 JPA Criteria 查询的查询条件

6. * Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort

7. */

8. @Test

9. public void testJpaSpecificationExecutor(){

10. int pageNo = 3 - 1;

11. int pageSize = 5;

12. PageRequest pageable = new PageRequest(pageNo, pageSize);

13.  

14. //通常使用 Specification 的匿名内部类

15. Specification<Person> specification = new Specification<Person>() {

16. /**

17. * @param *root: 代表查询的实体类.

18. * @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以

19. * 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象.

20. * @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象

21. * @return: *Predicate 类型, 代表一个查询条件.

22. */

23. @Override

24. public Predicate toPredicate(Root<Person> root,

25. CriteriaQuery<?> query, CriteriaBuilder cb) {

26. Path path = root.get("id");

27. Predicate predicate = cb.gt(path, 5);

28. return predicate;

29. }

30. };

31.  

32. Page<Person> page = personRepsotory.findAll(specification, pageable);

33.  

34. System.out.println("总记录数: " + page.getTotalElements());

35. System.out.println("当前第几页: " + (page.getNumber() + 1));

36. System.out.println("总页数: " + page.getTotalPages());

37. System.out.println("当前页面的 List: " + page.getContent());

38. System.out.println("当前页面的记录数: " + page.getNumberOfElements());

39. }

 

七、自定义Repository接口

步骤：

 

• 定义一个接口: 声明要添加的, 并自实现的方法
• 提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法
• 声明 Repository 接口, 并继承 1) 声明的接口使用。

注意: 默认情况下, Spring Data 会在 base-package 中查找 "接口名Impl" 作为实现类. 也可以通过repository-impl-postfix　声明后缀

 

 

示例代码：

PersonDao接口

 

1. package com.test.springdata;

2.  

3. public interface PersonDao {

4.  

5. void test();

6.  

7. }

PersonDao实现类

 

1. package com.test.springdata;

2.  

3. import javax.persistence.EntityManager;

4. import javax.persistence.PersistenceContext;

5.  

6. public class PersonRepsotoryImpl implements PersonDao {

7.  

8. @PersistenceContext

9. private EntityManager entityManager;

10.  

11. @Override

12. public void test() {

13. Person person = entityManager.find(Person.class, 11);

14. System.out.println("-->" + person);

15. }

16.  

17. }

PersonRepository类需要继承PersonDao接口

 

Test方法

 

1. @Test

2. public void testCustomRepositoryMethod(){

3. personRepsotory.test();

4. }

 

八、@Query注解

8.1 使用@Query自定义查询，这种查询可以声明在Repository方法中，摆脱像命名查询那样的约束，将查询直接在响应的接口方法中声明，结构更为清晰，这是Spring data的特有实现。

 

1. //为 @Query 注解传递参数的方式1: 命名参数的方式.

2. @Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")

3. List<Person> testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName);

8.2 使用@Query的nativeQuery=true，这样可以使用原生的SQL查询

 

1. //设置 nativeQuery=true 即可以使用原生的 SQL 查询

2. @Query(value="SELECT count(id) FROM jpa_persons", nativeQuery=true)

3. long getTotalCount();

注：详细内容参考JpaRepository示例代码

 

九、@Modifying注解

在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个 UPDATE 或 DELETE 操作

 

1. //可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作. 注意: JPQL 不支持使用 INSERT

2. //在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个 UPDATE 或 DELETE 操作

3. //UPDATE 或 DELETE 操作需要使用事务, 此时需要定义 Service 层. 在 Service 层的方法上添加事务操作.

4. //默认情况下, SpringData 的每个方法上有事务, 但都是一个只读事务. 他们不能完成修改操作!

5. @Modifying

6. @Query("UPDATE Person p SET p.email = :email WHERE id = :id")

7. void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);

注意：在调用的地方必须加事务，没有事务不能正常执行