Spring Data JPA框架自定义Repository接口


Posted in Java/Android onApril 28, 2022

自定义Repository接口

要定义一个repository接口,你首先需要自定义一个实体类专用的Repository接口。该接口必须扩展 Repository,并将其类型指定为实体类和实体类的 ID 类型。

如果你想为该实体类资源类型开放CRUD方法,请直接继承CrudRepository而不是Repository。

repository接口定义

通常,你的repository接口会扩展Repository、CrudRepository或PagingAndSortingRepository。

如果你不想扩展Spring Data接口,你也可以用@RepositoryDefinition来注解你的repository接口。

继承CrudRepository接口会公开一套完整的CRUD方法来操作你的实体类对象, 如果你希望自行决定暴露哪些方法,可以从CrudRepository中复制你想暴露的方法到你的自定义的repository接口中即可。

通过以上的操作可以让你在所提供的Spring Data Repositories功能的基础上定义自己的repository接口抽象。

下面通过实例展示了如何有选择地对外开放某些指定的CRUD方法(本例中对外开放findById和save接口方法)。

选择性对外暴露指定CRUD方法让其他人使用

@NoRepositoryBean
interface MyBaseRepository<T, ID> extends Repository<T, ID> {
  Optional<T> findById(ID id);
  <S extends T> S save(S entity);
}
interface UserRepository extends MyBaseRepository<User, Long> {
  User findByEmailAddress(EmailAddress emailAddress);
}

在前面的例子中,我们为所有的repository定义了一个通用的基础接口,并暴露了findById(…)以及save(…)方法。

这些方法被路由到Spring Data提供的你所选择的store的基础repository实现(例如,如果你使用JPA,实现就是SimpleJpaRepository),因为它们与CrudRepository中的方法签名一致。所以UserRepository现在可以保存用户,通过ID找到单个用户,并触发查询,通过电子邮件地址找到用户对象。

自定义的中间repository接口上需要添加@NoRepositoryBean。但是请特别注意,在所有Spring Data需要在运行时动态创建实例的repository接口上一定不要添加该注解。

就比如上面的示例代码,

- MyBaseRepository就是中间repository接口, 我们需要使用他来自定义对外开放哪些CRUD方法,需要添加@NoRepositoryBean注解, 这个注解的意思就是一个标记,为了通知JPA不要创建该接口的bean对象

这个@NoRepositoryBean就是用在中间repository接口上的, 但是从中间接口派生出具体的repository接口, 对应上面的示例代码就是UserRepository接口, 在这个接口上一定不要添加@NoRepositoryBean注解,如果添加了, 这个UserRepository接口的bean对象就不会注入到容器中了

使用Repository接口

在多个Spring Data模块中使用Repository接口

在你的应用程序中使用一个唯一的的Spring Data模块使事情变得简单,因为定义范围内的所有存储库接口都绑定到Spring Data模块。有时,应用程序需要使用一个以上的Spring Data模块。在这种情况下,存储库定义必须区分持久化技术。当它检测到类classpath路径下有多个repository factory时,Spring Data会进入严格的respository配置模式。严格的配置使用respository或域类的细节来决定respository定义的Spring Data模块绑定。

如果资源库定义扩展了特定模块的资源库,那么它就是特定Spring Data模块的有效候选者。

如果域类被注解了特定模块的类型注解,它就是特定Spring Data模块的有效候选者。Spring Data模块接受第三方注解(如JPA的@Entity)或提供自己的注解(如Spring Data MongoDB和Spring Data Elasticsearch的@Document)。

下面的例子显示了一个使用特定模块接口的存储库(本例中为 JPA)。

  • 例1. 使用module-specific接口的repository定义
interface MyRepository extends JpaRepository<User, Long> { }
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends JpaRepository<T, ID> { … }
interface UserRepository extends MyBaseRepository<User, Long> { … }

MyRepository和UserRepository在其类型层次上扩展了JpaRepository。它们是Spring Data JPA模块的有效候选者。

下面的例子显示了一个使用通用接口的repository接口。

  • 例2. 使用通用接口的repository定义
interface AmbiguousRepository extends Repository<User, Long> { … }
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends CrudRepository<T, ID> { … }
interface AmbiguousUserRepository extends MyBaseRepository<User, Long> { … }

AmbiguousRepository和AmbiguousUserRepository在其类型层次结构中只扩展了Repository和CrudRepository。虽然在使用唯一的Spring Data模块时,这很好,但多个模块无法区分这些repository接口应该被绑定到哪个特定的Spring Data。

下面的例子显示了一个使用带注解的领域类的repository接口。

  • 例3. 使用带注解的domain类的repository定义
interface PersonRepository extends Repository<Person, Long> { … }
@Entity
class Person { … }
interface UserRepository extends Repository<User, Long> { … }
@Document
class User { … }

PersonRepository引用了Person,它被JPA的@Entity注解所注解,所以这个repository接口显然属于Spring Data JPA。UserRepository引用了User,它被Spring Data MongoDB的@Document注释所注解。

下面的坏例子显示了一个使用混合注解的domain类的repository接口。

  • 例4. 使用混合注解的领域类的repository定义
interface JpaPersonRepository extends Repository<Person, Long> { … }
interface MongoDBPersonRepository extends Repository<Person, Long> { … }
@Entity
@Document
class Person { … }

这个例子展示了一个同时使用JPA和Spring Data MongoDB注解的领域类。它定义了两个repository接口:JpaPersonRepository和MongoDBPersonRepository。一个用于JPA,另一个用于MongoDB的使用。Spring Data不再能够区分这些repository接口库,这导致了未定义的行为。

repository接口类型细节和区分domian类注释用于严格的repository接口配置,以确定特定Spring Data模块的repository接口候选者。在同一domain类型上使用多个持久化技术的特定注解是可能的,并且能够在多个持久化技术中重复使用domian类型。然而,Spring Data就不能再确定一个唯一的模块来绑定repository接口了。

区分repository的最后一个方法是通过对repository接口基础包的扫描。基础包定义了扫描repository接口定义的起点,这意味着将repository接口的定义放在适当的包中。默认情况下,注解驱动的配置使用配置类的包。基于XML的配置中的基础包是强制性的。

下面的例子显示了注释驱动的基本包的配置。

  • 例5. 注释驱动的基础包配置
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
public class Configuration { 
}

到此这篇关于Spring Data JPA框架快速入门之自定义Repository接口的文章就介绍到这了!


Tags in this post...

Java/Android 相关文章推荐
Spring Cache和EhCache实现缓存管理方式
Jun 15 Java/Android
浅谈@Value和@Bean的执行顺序问题
Jun 16 Java/Android
总结Java对象被序列化的两种方法
Jun 30 Java/Android
使用Springboot实现健身房管理系统
Jul 01 Java/Android
Java反应式框架Reactor中的Mono和Flux
Jul 25 Java/Android
Java使用JMeter进行高并发测试
Nov 23 Java/Android
关于Spring配置文件加载方式变化引发的异常详解
Jan 18 Java/Android
Java字符缓冲流BufferedWriter
Apr 09 Java/Android
JAVA 线程池(池化技术)的实现原理
Apr 28 Java/Android
详解Flutter自定义应用程序内键盘的实现方法
Jun 14 Java/Android
Spring Security动态权限的实现方法详解
Jun 16 Java/Android
Java 中的 Lambda List 转 Map 的多种方法详解
Jul 07 Java/Android
Spring Data JPA框架持久化存储数据到数据库
Spring Data JPA框架的核心概念和Repository接口
Java 多态分析
Java由浅入深通关抽象类与接口(下篇)
Java由浅入深通关抽象类与接口(上篇)
Mybatis-Plus 使用 @TableField 自动填充日期
Apr 26 #Java/Android
Java 写一个简单的图书管理系统
Apr 26 #Java/Android
You might like
PHP 动态随机生成验证码类代码
2010/04/09 PHP
php导入excel文件到mysql数据库的方法
2015/01/14 PHP
Yii2.0高级框架数据库增删改查的一些操作
2015/11/16 PHP
win7 wamp 64位 php环境开启curl服务遇到的问题及解决方法
2018/09/16 PHP
基于ThinkPHP5框架使用QueryList爬取并存入mysql数据库操作示例
2019/05/25 PHP
jQuery列表拖动排列具体实现
2013/11/04 Javascript
js设置function参数默认值(适合没有传参情况)
2014/02/24 Javascript
jQuery中prependTo()方法用法实例
2015/01/08 Javascript
jquery分割字符串的方法
2015/06/24 Javascript
js实现将选中值累加到文本框的方法
2015/08/12 Javascript
jquery如何获取元素的滚动条高度等实现代码
2015/10/19 Javascript
jquery中用函数来设置css样式
2016/12/22 Javascript
js实现文字列表无缝滚动效果
2017/06/23 Javascript
SVG动画vivus.js库使用小结(实例代码)
2017/09/14 Javascript
详解自定义ajax支持跨域组件封装
2018/02/08 Javascript
nodeJS进程管理器pm2的使用
2019/01/09 NodeJs
vue使用recorder.js实现录音功能
2019/11/22 Javascript
vue实现简易的双向数据绑定
2020/12/29 Vue.js
详解Python列表赋值复制深拷贝及5种浅拷贝
2019/05/15 Python
python中对数据进行各种排序的方法
2019/07/02 Python
Python3实现将一维数组按标准长度分隔为二维数组
2019/11/29 Python
DataFrame 数据合并实现(merge,join,concat)
2020/06/14 Python
Python通用唯一标识符uuid模块使用案例
2020/09/10 Python
Pycharm操作Git及GitHub的步骤详解
2020/10/27 Python
H5 video poster属性设置视频封面的方法
2020/05/25 HTML / CSS
英国户外装备和冒险服装零售商:alloutdoor
2018/01/30 全球购物
幼儿园教学管理制度
2014/02/04 职场文书
积极贯彻学习两会精神总结
2014/03/17 职场文书
社区消防工作实施方案
2014/03/21 职场文书
节约用电标语
2014/06/17 职场文书
2015年防灾减灾工作总结
2015/07/24 职场文书
商业计划书格式、范文
2019/03/21 职场文书
vue实现移动端div拖动效果
2022/03/03 Vue.js
世界十大狙击步枪排行榜
2022/03/20 杂记
Java基础——Map集合
2022/04/01 Java/Android
德劲DE1105机评
2022/04/05 无线电