Spring Data JPA框架Repository自定义实现


Posted in Java/Android onApril 28, 2022

1. Spring Data Repository自定义实现

Spring Data提供了各种选项来创建查询方法,只需少量编码。但是当这些选项不能满足你的需求时,你也可以为资源库方法提供你自己的自定义实现。本节主要介绍如何做到这一点。

1.1 自定义特殊repository

要用自定义的功能实现来丰富repository库,你必须首先定义一个片段接口和自定义功能的实现,如下所示。

  • 例1. 自定义接口
public interface CustomUserRepository {
  void customMethod(User user);
}
  • 例2. 自定义接口实现类
public class CustomUserRepositoryImpl implements CustomUserRepository {
  public void customMethod(User user) {
    // Your custom implementation
  }
}

实现类本身并不依赖于Spring Data,它可以是一个普通的Spring Bean对象。因此,你可以使用标准的依赖注入行为来注入对其他Bean(如JdbcTemplate)的引用,参与到切面中进行使用等等。

然后你可以让你的repository接口扩展片段接口,如下所示。

  • 例3. 修改你的repository接口定义, 让它扩展你自定义接口
public interface UserRepository extends CrudRepository<User, Long>, CustomUserRepository {
  // Declare query methods here
}

这样就用你的repository接口扩展自定义接口,结合了CRUD和自定义功能,并使其对客户端提供服务。

Spring Data repositories是通过使用形成repository组合的片段来实现的。片段是基础repository、功能方面(如QueryDsl),以及自定义接口和它们的实现。每当你为你的repository接口添加一个接口,你就通过添加一个片段来增强组合。基础资源库和资源库方面的实现是由每个Spring Data模块提供的。

下面的例子展示了自定义接口和它们的实现。

  • 例4. 片段与它们的实现
public interface HumanRepository {
  void humanMethod(User user);
}
public class HumanRepositoryImpl implements HumanRepository {
  public void humanMethod(User user) {
    // Your custom implementation
  }
}
public interface ContactRepository {
  void contactMethod1(User user);
  User contactMethod2(User user);
}
public class ContactRepositoryImpl implements ContactRepository {
  public void contactMethod1(User user) {
    // Your custom implementation
  }
  public User contactMethod2(User user) {
    // Your custom implementation
  }
}

下面的例子显示了一个扩展了CrudRepository的自定义仓库的接口。

  • 例5. 修改你的repository接口定义, 让它扩展多个你自定义接口
public interface UserRepository extends CrudRepository<User, Long>, HumanRepository, ContactRepository {
  // Declare query methods here
}

repository可以由多个自定义的实现组成,这些实现按其声明的顺序被导入。自定义实现的优先级高于基础实现和repository方面。这种排序可以让你覆盖基础repository和方面的方法,并在两个片段贡献相同的方法签名时解决歧义。repository片段不限于在单一repository接口中使用。多个repository可以使用一个片段接口,让你在不同的repository中重复使用定制的内容。

下面的例子显示了一个repository片段和它的实现。

  • 例6. 重写save(…)方法的片段代码
public interface CustomSave<T> {
  <S extends T> S save(S entity);
}
public class CustomSaveImpl<T> implements CustomSave<T> {
  public <S extends T> S save(S entity) {
    // Your custom implementation
  }
}
  • 例7 在repository接口中扩展例6中定义的接口
interface UserRepository extends CrudRepository<User, Long>, CustomSave<User> {
}
interface PersonRepository extends CrudRepository<Person, Long>, CustomSave<Person> {
}

1.2 配置类

如果你使用命名空间配置,repository基础设施会尝试通过扫描发现repository的包下面的类来自动检测自定义实现片段。这些类需要遵循命名空间元素的repository-impl-postfix属性附加到片段接口名称的命名惯例。这个后缀默认为 Impl。下面的例子显示了一个使用默认后缀的repository和一个为后缀设置自定义值的repository。

XML文件的配置示例

<repositories base-package="com.kkarma.repository" />
<repositories base-package="com.kkarma.repository" repository-impl-postfix="MyImpl" />

前面例子中的第一个配置试图查找一个叫做 com.kkatma.repository.CustomUserRepositoryImpl 的类,作为一个自定义的repository实现。第二个例子试图查找 com.kkarma.repository.CustomUserRepositoryMyImpl。

1.3 解决歧义

如果在不同的包中发现有多个类名匹配的实现,Spring Data会使用bean对象的名字来确定使用哪一个。

考虑到前面显示的CustomUserRepository的以下两个自定义实现,第一个实现被使用。它的bean是customUserRepositoryImpl,与片段接口(CustomUserRepository)加上后缀Impl的名字相匹配。

例8 解决歧义实现方式

package com.kkarma.impl.one;
class CustomUserRepositoryImpl implements CustomUserRepository {
  // Your custom implementation
}
package com.kkarma.impl.two;
@Component("specialCustomImpl")
class CustomUserRepositoryImpl implements CustomUserRepository {
  // Your custom implementation
}

如果你用 @Component("specialCustom")来注解 UserRepository接口,那么Bean的名字加上 Impl就与 com.kkarma.impl.two中为repository实现定义的名字相匹配,并被用来代替第一个接口。

1.4 手动装配

如果你的自定义实现只使用基于注解的配置和自动装配,前面所示的方法很好用,因为它被当作任何其他Spring Bean。如果你的实现片段Bean需要装配到容器,你可以根据前文所述的约定来声明Bean并为其命名。然后,基础设施通过名称来引用手动定义的Bean定义,而不是自己创建一个。下面的例子展示了如何手动装配一个自定义的实现。

例9 手动装配自定义实现类对象到容器

<repositories base-package="com.kkarma.repository" />
<beans:bean id="userRepositoryImpl" class="…">
  <!-- further configuration -->
</beans:bean>

1.5 自定义Base Repository

当你想定制base repository的行为时,上一节描述的方法需要定制每个repository的接口,以便所有的repository都受到影响。为了改变所有repository的行为,你可以创建一个扩展持久化技术特定repository基类的实现。然后这个类作为repository代理的自定义基类,如下面的例子所示。

例10 自定义repository的基类

class MyRepositoryImpl<T, ID> extends SimpleJpaRepository<T, ID> {
  private final EntityManager entityManager;
  MyRepositoryImpl(JpaEntityInformation entityInformation,
                          EntityManager entityManager) {
    super(entityInformation, entityManager);
    // Keep the EntityManager around to used from the newly introduced methods.
    this.entityManager = entityManager;
  }
  @Transactional
  public <S extends T> S save(S entity) {
    // implementation goes here
  }
}

最后一步是让Spring Data基础设施意识到自定义的repository基类。在Java配置中,你可以通过使用@Enable${store}Repositories注解的repositoryBaseClass属性来做到这一点,如下面例子所示。

例11 使用JavaConfig配置自定义repository基类

@Configuration
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

在XML命名空间中有一个相应的属性,如下面的例子中所示。

例12 使用XML配置自定义repository基类

<repositories base-package="com.kkarma.repository"
     base-class="….MyRepositoryImpl" />

到此这篇关于Spring Data JPA框架的Repository自定义实现详解的文章就介绍到这了!


Tags in this post...

Java/Android 相关文章推荐
SpringBoot2 参数管理实践之入参出参与校验的方式
Jun 16 Java/Android
spring cloud gateway中如何读取请求参数
Jul 15 Java/Android
springboot集成springCloud中gateway时启动报错的解决
Jul 16 Java/Android
关于springboot 配置date字段返回时间戳的问题
Jul 25 Java/Android
OpenCV实现普通阈值
Nov 17 Java/Android
springboot新建项目pom.xml文件第一行报错的解决
Jan 18 Java/Android
Java 深入探究讲解简单工厂模式
Apr 07 Java/Android
Java中Dijkstra(迪杰斯特拉)算法
May 20 Java/Android
Ubuntu18.04下QT开发Android无法连接设备问题解决实现
Jun 01 Java/Android
Android Gradle 插件自定义Plugin实现注意事项
Jun 16 Java/Android
java.util.NoSuchElementException原因及两种解决方法
Jun 28 Java/Android
JDK8中String的intern()方法实例详细解读
Sep 23 Java/Android
JAVA 线程池(池化技术)的实现原理
Apr 28 #Java/Android
Spring Data JPA框架自定义Repository接口
Apr 28 #Java/Android
Spring Data JPA框架持久化存储数据到数据库
Spring Data JPA框架的核心概念和Repository接口
Java 多态分析
Java由浅入深通关抽象类与接口(下篇)
Java由浅入深通关抽象类与接口(上篇)
You might like
php通过header发送自定义数据方法
2018/01/18 PHP
如何在PHP中使用数组
2020/06/09 PHP
8款非常棒的响应式jQuery 幻灯片插件推荐
2012/02/02 Javascript
node.js中的fs.exists方法使用说明
2014/12/17 Javascript
javascript正则表达式总结
2016/02/29 Javascript
JavaScript驾驭网页-CSS与DOM
2016/03/24 Javascript
简单谈谈JS数组中的indexOf方法
2016/10/13 Javascript
原生js实现水平方向无缝滚动
2017/01/10 Javascript
Node.js 使用递归实现遍历文件夹中所有文件
2017/09/18 Javascript
C#实现将一个字符转换为整数
2017/12/12 Javascript
nodejs之koa2请求示例(GET,POST)
2018/08/07 NodeJs
详解vuex数据传输的两种方式及this.$store undefined的解决办法
2019/08/26 Javascript
在VUE中实现文件下载并判断状态的方法
2019/11/08 Javascript
vue实现全屏滚动效果(非fullpage.js)
2020/03/07 Javascript
[01:00:14]2018DOTA2亚洲邀请赛 4.6 淘汰赛 VP vs TNC 第三场
2018/04/10 DOTA
跟老齐学Python之??碌某?? target=
2014/09/12 Python
Python本地与全局命名空间用法实例
2015/06/16 Python
Python 基础之字符串string详解及实例
2017/04/01 Python
python字符串的方法与操作大全
2018/01/30 Python
Python zip()函数用法实例分析
2018/03/17 Python
python版DDOS攻击脚本
2019/06/12 Python
Python queue队列原理与应用案例分析
2019/09/27 Python
python 利用turtle模块画出没有角的方格
2019/11/23 Python
Python打包工具PyInstaller的安装与pycharm配置支持PyInstaller详细方法
2020/02/27 Python
Python预测2020高考分数和录取情况
2020/07/08 Python
基于Python爬取搜狐证券股票过程解析
2020/11/18 Python
DNA测试:Orig3n
2019/03/01 全球购物
抽象方法、抽象类怎样声明
2014/10/25 面试题
生物技术研究生自荐信
2013/11/12 职场文书
大三毕业自我鉴定
2014/01/15 职场文书
党员教师工作决心书
2014/03/13 职场文书
四群教育工作实施方案
2014/03/26 职场文书
移交协议书
2014/08/19 职场文书
创业项目(超低成本创业项目)
2019/08/16 职场文书
如何用JavaScript实现一个数组惰性求值库
2021/05/05 Javascript
解决Pytorch dataloader时报错每个tensor维度不一样的问题
2021/05/28 Python