Spring技术内幕之Spring Data JPA-自定义Repository实现

1.自定义Repository方法接口,让接口的实现类来继承这个中间接口而不是Repository接口

1. package com.data.jpa.dao;
2. 
   
3. import java.io.Serializable;
4. import java.util.List;
5. import java.util.Map;
6. 
   
7. import org.springframework.data.jpa.repository.JpaRepository;
8. import org.springframework.data.repository.NoRepositoryBean;
9. /**
10. * 自定义Repository的方法接口
11. * @author xiaowen
12. * @param <T> 领域对象即实体类
13. * @param <ID>领域对象的注解
14. */
15. @NoRepositoryBean
16. public interface CustomRepository <T, ID extends Serializable> extends JpaRepository<T, ID> {
17. /**
18. * 保存对象<br/>
19. * 注意：如果对象id是字符串，并且没有赋值，该方法将自动设置为uuid值
20. * @param item
21. * 持久对象，或者对象集合
22. * @throws Exception
23. */
24. public void store(Object... item);
25. 
    
26. /**
27. * 更新对象数据
28. *
29. * @param item
30. * 持久对象，或者对象集合
31. * @throws Exception
32. */
33. public void update(Object... item);
34. 
    
35. /**
36. * 执行ql语句
37. * @param qlString 基于jpa标准的ql语句
38. * @param values ql中的?参数值,单个参数值或者多个参数值
39. * @return 返回执行后受影响的数据个数
40. */
41. public int executeUpdate(String qlString, Object... values);
42. 
    
43. /**
44. * 执行ql语句
45. * @param qlString 基于jpa标准的ql语句
46. * @param params key表示ql中参数变量名，value表示该参数变量值
47. * @return 返回执行后受影响的数据个数
48. */
49. public int executeUpdate(String qlString, Map<String, Object> params);
50. 
    
51. /**
52. * 执行ql语句，可以是更新或者删除操作
53. * @param qlString 基于jpa标准的ql语句
54. * @param values ql中的?参数值
55. * @return 返回执行后受影响的数据个数
56. * @throws Exception
57. */
58. public int executeUpdate(String qlString, List<Object> values);
59. 
    
60. /***还可以定义分页相关方法,此处暂不支持**/
61. }

2.自定义repository的方法接口实现类,作为Repository代理的自定义类来执行,该类主要提供自定义的公用方法

1. package com.data.jpa.dao.impl;
2. 
   
3. import java.io.Serializable;
4. import java.lang.reflect.Field;
5. import java.lang.reflect.Method;
6. import java.util.List;
7. import java.util.Map;
8. 
   
9. import javax.persistence.EntityManager;
10. import javax.persistence.Id;
11. import javax.persistence.Query;
12. 
    
13. import org.apache.log4j.Logger;
14. import org.springframework.data.jpa.repository.support.SimpleJpaRepository;
15. 
    
16. import com.data.jpa.dao.CustomRepository;
17. import com.data.jpa.util.ReflectHelper;
18. import com.data.jpa.util.UUIDUtil;
19. 
    
20. /**
21. * 自定义repository的方法接口实现类,该类主要提供自定义的公用方法
22. *
23. * @author xiaowen
24. * @date 2016年5月30日 @ version 1.0
25. * @param <T>
26. * @param <ID>
27. */
28. public class CustomRepositoryImpl<T, ID extends Serializable> extends SimpleJpaRepository<T, Serializable>
29. implements CustomRepository<T, Serializable> {
30. 
    
31. @SuppressWarnings("unused")
32. private Logger logger = Logger.getLogger(CustomRepositoryImpl.class);
33. /**
34. * 持久化上下文
35. */
36. private final EntityManager entityManager;
37. 
    
38. public CustomRepositoryImpl(Class<T> domainClass, EntityManager em) {
39. super(domainClass, em);
40. this.entityManager = em;
41. }
42. 
    
43. @Override
44. public void store(Object... item) {
45. if(null!=item){
46. for(Object entity : item){
47. innerSave(entity);
48. }
49. }
50. }
51. 
    
52. @Override
53. public void update(Object... item) {
54. if (null != item) {
55. for (Object entity : item) {
56. entityManager.merge(entity);
57. }
58. }
59. }
60. 
    
61. @Override
62. public int executeUpdate(String qlString, Object... values) {
63. Query query = entityManager.createQuery(qlString);
64. if (values != null) {
65. for (int i = 0; i < values.length; i++) {
66. query.setParameter(i + 1, values[i]);
67. }
68. }
69. return query.executeUpdate();
70. }
71. 
    
72. @Override
73. public int executeUpdate(String qlString, Map<String, Object> params) {
74. Query query = entityManager.createQuery(qlString);
75. for (String name : params.keySet()) {
76. query.setParameter(name, params.get(name));
77. }
78. return query.executeUpdate();
79. }
80. 
    
81. @Override
82. public int executeUpdate(String qlString, List<Object> values) {
83. Query query = entityManager.createQuery(qlString);
84. for (int i = 0; i < values.size(); i++) {
85. query.setParameter(i + 1, values.get(i));
86. }
87. return query.executeUpdate();
88. }
89. 
    
90. /**
91. * 保存对象
92. * @param item 保存对象
93. * @return
94. */
95. private Serializable innerSave(Object item) {
96. try {
97. if(item==null)return null;
98. Class<?> clazz = item.getClass();
99. Field idField = ReflectHelper.getIdField(clazz);
100. Method getMethod = null;
101. if(idField!=null){
102. Class<?> type = idField.getType();
103. Object val = idField.get(item);
104. if(type == String.class && (val==null || "".equals(val))){
105. idField.set(item, UUIDUtil.uuid());
106. }
107. }else{
108. Method[] methods = clazz.getDeclaredMethods();
109. for (Method method : methods) {
110. Id id = method.getAnnotation(Id.class);
111. if (id != null) {
112. Object val = method.invoke(item);
113. if(val==null || "".equals(val)){
114. String methodName = "s" + method.getName().substring(1);
115. Method setMethod = clazz.getDeclaredMethod(methodName, method.getReturnType());
116. if(setMethod!=null){
117. setMethod.invoke(item, UUIDUtil.uuid());
118. }
119. }
120. getMethod = method;
121. break;
122. }
123. }
124. }
125. entityManager.persist(item);
126. entityManager.flush();
127. if(idField!=null){
128. return (Serializable) idField.get(item);
129. }
130. if(getMethod!=null){
131. return (Serializable)getMethod.invoke(item);
132. }
133. return null;
134. } catch (Exception e) {
135. e.printStackTrace();
136. throw new RuntimeException(e);
137. }
138. }
139. }

3. 扩展jpaRepository,让所有的repository共享起自定义的方法 

1. package com.data.jpa.config;
2. 
   
3. import java.io.Serializable;
4. 
   
5. import javax.persistence.EntityManager;
6. 
   
7. import org.springframework.data.jpa.repository.JpaRepository;
8. import org.springframework.data.jpa.repository.support.JpaRepositoryFactory;
9. import org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean;
10. import org.springframework.data.repository.core.RepositoryMetadata;
11. import org.springframework.data.repository.core.support.RepositoryFactorySupport;
12. 
    
13. import com.data.jpa.dao.impl.CustomRepositoryImpl;
14. /**
15. * 创建一个自定义的FactoryBean去替代默认的工厂类
16. * @author xiaowen
17. * @date 2016年5月30日
18. * @ version 1.0
19. * @param <R>
20. * @param <T>
21. * @param <I>
22. */
23. public class CustomRepositoryFactoryBean <R extends JpaRepository<T, I>, T, I extends Serializable>
24. extends JpaRepositoryFactoryBean<R, T, I> {
25. 
    
26. @SuppressWarnings("rawtypes")
27. protected RepositoryFactorySupport createRepositoryFactory(EntityManager em) {
28. return new CustomRepositoryFactory(em);
29. }
30. 
    
31. private static class CustomRepositoryFactory<T, I extends Serializable>
32. extends JpaRepositoryFactory {
33. 
    
34. private final EntityManager em;
35. 
    
36. public CustomRepositoryFactory(EntityManager em) {
37. super(em);
38. this.em = em;
39. }
40. 
    
41. @SuppressWarnings("unchecked")
42. protected Object getTargetRepository(RepositoryMetadata metadata) {
43. return new CustomRepositoryImpl<T, I>(
44. (Class<T>) metadata.getDomainType(), em);
45. }
46. 
    
47. protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
48. return CustomRepositoryImpl.class;
49. }
50. }
51. 
    
52. }

4.配置factory-class

1. package com.data.jpa.config;
2. 
   
3. import org.springframework.context.annotation.Configuration;
4. import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
5. import org.springframework.data.web.config.EnableSpringDataWebSupport;
6. /**
7. * 通过注解配置factory-class
8. * @author xiaowen
9. * @date 2016年5月30日
10. * @ version 1.0
11. */
12. @Configuration
13. @EnableJpaRepositories(basePackages = "com.data.jpa**.dao",
14. repositoryFactoryBeanClass = CustomRepositoryFactoryBean.class)
15. @EnableSpringDataWebSupport
16. public class JpaDataConfig {
17. 
    
18. }

当然也可以在xml文件中配置

1. <repositories base-package="com.acme.repository"
2. factory-class="com.acme.MyRepositoryFactoryBean" />

5.使用自定义的CustomRepository接口

1. package com.data.jpa.dao;
2. 
   
3. import com.data.jpa.dao.domain.Persion;
4. 
   
5. /**
6. * PersionRepository,通过继承自定义的CustomRepository获取提供自定义的公用方法,当然也可以自定义方法
7. * @author xiaowen
8. * @date 2016年5月30日
9. * @ version 1.0
10. */
11. public interface PersionRepository extends CustomRepository<Persion, Integer> {
12. /**
13. * 通过用户名查询用户
14. * @param userName
15. * @return
16. */
17. public Persion findByuserName(String userName);
18. }

6.使用PersionRepository,直接通过Spring的注解注入即可

1. package com.data.jpa.controller;
2. 
   
3. import org.springframework.beans.factory.annotation.Autowired;
4. import org.springframework.stereotype.Controller;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.ResponseBody;
7. 
   
8. import com.data.jpa.dao.PersionRepository;
9. 
   
10. @Controller
11. @RequestMapping("/perison")
12. public class PersionController {
13. @Autowired
14. private PersionRepository persionRepository;
15. 
    
16. @RequestMapping("/index")
17. public String index(){
18. return "index";
19. 
    
20. }
21. 
    
22. @RequestMapping("/search")
23. public @ResponseBody String search(String userName){
24. persionRepository.findByuserName(userName);
25. 
    
26. return "success!";
27. }
28. 
    
29. }

相关实体类/工具类代码

1.Persion

1. package com.data.jpa.dao.domain;
2. 
   
3. import javax.persistence.Entity;
4. import javax.persistence.Id;
5. import javax.persistence.Table;
6. /**
7. * persion类
8. * @author xiaowen
9. * @date 2016年5月30日
10. * @ version 1.0
11. */
12. @Entity
13. @Table(name = "t_persion")
14. public class Persion {
15. @Id
16. private String id;
17. 
    
18. private String userName;
19. 
    
20. private String userSex;
21. 
    
22. /**
23. * @return the id
24. */
25. public String getId() {
26. return id;
27. }
28. 
    
29. /**
30. * @param id the id to set
31. */
32. public void setId(String id) {
33. this.id = id;
34. }
35. 
    
36. /**
37. * @return the userName
38. */
39. public String getUserName() {
40. return userName;
41. }
42. 
    
43. /**
44. * @param userName the userName to set
45. */
46. public void setUserName(String userName) {
47. this.userName = userName;
48. }
49. 
    
50. /**
51. * @return the userSex
52. */
53. public String getUserSex() {
54. return userSex;
55. }
56. 
    
57. /**
58. * @param userSex the userSex to set
59. */
60. public void setUserSex(String userSex) {
61. this.userSex = userSex;
62. }
63. 
    
64. 
    
65. 
    
66. }

2.UUID工具类

1. package com.data.jpa.util;
2. 
   
3. import java.util.UUID;
4. 
   
5. /**
6. * UUID工具类
7. * @author xiaowen
8. * @date 2016年5月30日
9. * @ version 1.0
10. */
11. public class UUIDUtil {
12. /**
13. * 获取生成的uuid
14. * @return
15. */
16. public static String uuid(){
17. return UUID.randomUUID().toString().replaceAll("-", "");
18. }
19. 
    
20. }

3. 反射相关方法工具类

1. package com.data.jpa.util;
2. 
   
3. import java.lang.reflect.Field;
4. 
   
5. import javax.persistence.Id;
6. 
   
7. /**
8. * 反射相关方法工具类
9. * @author xiaowen
10. * @date 2016年5月30日
11. * @ version 1.0
12. */
13. public class ReflectHelper {
14. /**
15. * 获取实体类的字段信息
16. * @param clazz 实体类
17. * @return 字段集合
18. */
19. public static Field getIdField(Class<?> clazz){
20. Field[] fields = clazz.getDeclaredFields();
21. Field item = null;
22. for (Field field : fields) {
23. //获取实体类中标识@Id的字段
24. Id id = field.getAnnotation(Id.class);
25. if (id != null) {
26. field.setAccessible(true);
27. item = field;
28. break;
29. }
30. }
31. if(item==null){
32. Class<?> superclass = clazz.getSuperclass();
33. if(superclass!=null){
34. item = getIdField(superclass);
35. }
36. }
37. return item;
38. 
    
39. 
    
40. }
41. }

https://blog.csdn.net/u011659172/article/details/51537602