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-Integration执行过程
Jun 11 Java/Android
Springboot如何使用logback实现多环境配置?
Jun 16 Java/Android
SpringBoot2 参数管理实践之入参出参与校验的方式
Jun 16 Java/Android
Java各种比较对象的方式的对比总结
Jun 20 Java/Android
SpringAop日志找不到方法的处理
Jun 21 Java/Android
Springboot使用Spring Data JPA实现数据库操作
Jun 30 Java/Android
swagger如何返回map字段注释
Jul 03 Java/Android
JVM钩子函数的使用场景详解
Aug 23 Java/Android
Java SSM配置文件案例详解
Aug 30 Java/Android
springcloud整合seata
May 20 Java/Android
Mybatis-plus配置分页插件返回统一结果集
Jun 21 Java/Android
java实现web实时消息推送的七种方案
Jul 23 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 mysql_real_escape_string函数用法与实例教程
2013/09/30 PHP
thinkphp jquery实现图片上传和预览效果
2020/07/22 PHP
JavaScript 原型链学习总结
2010/10/29 Javascript
js中精确计算加法和减法示例
2014/03/28 Javascript
使用命令对象代替switch语句的写法示例
2015/02/28 Javascript
JS实现简单路由器功能的方法
2015/05/27 Javascript
jquery实现表单输入时提示文字滑动向上效果
2015/08/10 Javascript
如何实现移动端浏览器不显示 pc 端的广告
2015/10/15 Javascript
浅谈JS原型对象和原型链
2016/03/02 Javascript
JavaScript实现显示函数调用堆栈的方法
2016/04/21 Javascript
Vue.js基础知识汇总
2016/04/27 Javascript
微信小程序 数据访问实例详解
2016/10/08 Javascript
Vue + Webpack + Vue-loader学习教程之相关配置篇
2017/03/14 Javascript
mui框架移动开发初体验详解
2017/10/11 Javascript
JS 实现微信扫一扫功能
2018/09/14 Javascript
nodejs aes 加解密实例
2018/10/10 NodeJs
详解js中let与var声明变量的区别
2020/04/05 Javascript
Vue实现多标签选择器
2019/11/28 Javascript
vue组件传值的实现方式小结【三种方式】
2020/02/05 Javascript
Python实现Linux中的du命令
2017/06/12 Python
Python3.4学习笔记之列表、数组操作示例
2019/03/01 Python
python 统计文件中的字符串数目示例
2019/12/24 Python
解决Keras 中加入lambda层无法正常载入模型问题
2020/06/16 Python
python中如何使用虚拟环境
2020/10/14 Python
使用Python获取爱奇艺电视剧弹幕数据的示例代码
2021/01/12 Python
CSS3 真的会替代 SCSS 吗
2021/03/09 HTML / CSS
Java面试中常遇到的问题,也是需要注意的几点
2013/08/30 面试题
公司司机岗位职责范本
2014/03/03 职场文书
股份合作协议书
2014/04/12 职场文书
男女朋友协议书
2014/04/23 职场文书
2015年办公室主任工作总结
2015/04/09 职场文书
给老师的保证书怎么写
2015/05/09 职场文书
色戒观后感
2015/06/12 职场文书
开学第一周值周总结
2015/07/16 职场文书
三八妇女节致辞
2015/07/31 职场文书
大学生受助感言
2015/08/01 职场文书