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 相关文章推荐
gateway网关接口请求的校验方式
Jul 15 Java/Android
Java 实战项目之家居购物商城系统详解流程
Nov 11 Java/Android
springboot+zookeeper实现分布式锁
Mar 21 Java/Android
Spring Boot DevTools 全局配置学习指南
Mar 31 Java/Android
Android自定义ScrollView实现阻尼回弹
Apr 01 Java/Android
Java设计模式中的命令模式
Apr 28 Java/Android
Spring 使用注解开发
May 20 Java/Android
Android学习之BottomSheetDialog组件的使用
Jun 21 Java/Android
阿里面试Nacos配置中心交互模型是push还是pull原理解析
Jul 23 Java/Android
Java实现贪吃蛇游戏的示例代码
Sep 23 Java/Android
Android实现获取短信验证码并自动填充
May 21 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中$美元符号与Zen Coding冲突问题解决方法分享
2014/05/28 PHP
PHP实现过滤各种HTML标签
2015/05/17 PHP
php 实现301重定向跳转实例代码
2016/07/18 PHP
PHP页面跳转实现延时跳转的方法
2016/12/10 PHP
PHP使用mysqli操作MySQL数据库的简单方法
2017/02/04 PHP
PHP面向对象之事务脚本模式(详解)
2017/06/07 PHP
PHP大文件分片上传的实现方法
2018/10/28 PHP
PHP PDOStatement::columnCount讲解
2019/01/30 PHP
使用正则替换变量
2007/05/05 Javascript
JSON.parse 解析字符串出错的解决方法
2010/07/08 Javascript
js将long日期格式转换为标准日期格式实现思路
2013/04/07 Javascript
浅析return false的正确使用
2013/11/04 Javascript
我的NodeJs学习小结(一)
2014/07/06 NodeJs
jQuery中[attribute]选择器用法实例
2014/12/31 Javascript
JavaScript中字面量与函数的基本使用知识
2015/10/20 Javascript
jQuery实现悬浮在右上角的网页客服效果代码
2015/10/24 Javascript
Vue组件tree实现树形菜单
2017/04/13 Javascript
JS实现无缝循环marquee滚动效果
2017/05/22 Javascript
BootStrap 页签切换失效的解决方法
2017/08/17 Javascript
基于vue 实现token验证的实例代码
2017/12/14 Javascript
webpack4.0 入门实践教程
2018/10/08 Javascript
vue点击当前路由高亮小案例
2019/09/26 Javascript
JS如何实现网站中PC端和手机端自动识别并跳转对应的代码
2020/01/08 Javascript
js实现tab栏切换效果
2020/08/02 Javascript
详解python实现识别手写MNIST数字集的程序
2018/08/03 Python
python批量修改图片后缀的方法(png到jpg)
2018/10/25 Python
python 使用opencv 把视频分割成图片示例
2019/12/12 Python
HTML5新控件之日期和时间选择输入的实现代码
2018/09/13 HTML / CSS
canvas像素点操作之视频绿幕抠图
2018/09/11 HTML / CSS
世界上最大的艺术社区:SAA
2020/12/30 全球购物
商务英语本科生的自我评价分享
2013/11/15 职场文书
大学同学十年聚会感言
2014/02/21 职场文书
天地会口号
2014/06/17 职场文书
2014年安全生产工作总结
2014/11/13 职场文书
2014年前台个人工作总结
2014/11/14 职场文书
2016年“5.12”护士节致辞
2015/07/31 职场文书