定义存储库接口
要定义一个存储库接口,首先需要定义一个特定于域类的存储库接口。该接口必须继承 Repository 并声明为域类和 ID 类型。如果你想为该域类型公开 CRUD 方法,可以继承 CrudRepository 或其变体之一,而不是 Repository。
微调存储库定义
有几种不同的方式可以开始定义你的存储库接口。
典型的方法是继承 CrudRepository,它为你提供了 CRUD 功能的方法。CRUD 代表创建(Create)、读取(Read)、更新(Update)、删除(Delete)。从 3.0 版本开始,我们还引入了 ListCrudRepository,它与 CrudRepository 非常相似,但对于返回多个实体的方法,它返回一个 List 而不是 Iterable,这可能更容易使用。
如果你使用响应式存储,你可以选择 ReactiveCrudRepository 或 RxJava3CrudRepository,具体取决于你使用的响应式框架。
如果你使用 Kotlin,你可以选择 CoroutineCrudRepository,它利用了 Kotlin 的协程。
此外,如果你需要允许指定 Sort 抽象或在第一种情况下指定 Pageable 抽象的方法,你可以继承 PagingAndSortingRepository, ReactiveSortingRepository, RxJava3SortingRepository 或 CoroutineSortingRepository。请注意,各种排序存储库不再像 Spring Data 3.0 之前的版本那样继承其各自的 CRUD 存储库。因此,如果你想同时拥有两者的功能,则需要继承这两个接口。
如果你不想继承 Spring Data 接口,也可以使用 @RepositoryDefinition 注解你的存储库接口。继承其中一个 CRUD 存储库接口会暴露一套完整的方法来操作你的实体。如果你更喜欢选择性地暴露方法,可以将你想要暴露的方法从 CRUD 存储库复制到你的域存储库中。这样做时,你可以更改方法的返回类型。如果可能,Spring Data 会尊重返回类型。例如,对于返回多个实体的方法,你可以选择 Iterable<T>、List<T>、Collection<T> 或 VAVR 列表。
如果你的应用程序中的许多存储库应该具有相同的方法集,你可以定义自己的基础接口来继承。这样的接口必须使用 @NoRepositoryBean 注解。这可以防止 Spring Data 直接尝试创建它的实例并失败,因为它无法确定该存储库对应的实体,因为它仍然包含一个泛型类型变量。
以下示例展示了如何选择性地暴露 CRUD 方法(在本例中是 findById 和 save)
@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);
}
在前面的示例中,你为所有域存储库定义了一个通用的基础接口,并暴露了 findById(…) 以及 save(…) 方法。这些方法会被路由到 Spring Data 提供的你所选择的存储的基础存储库实现中(例如,如果你使用 JPA,实现是 SimpleJpaRepository),因为它们与 CrudRepository 中的方法签名匹配。因此,UserRepository 现在可以保存用户,按 ID 查找单个用户,并触发查询按电子邮件地址查找 Users。
中间存储库接口使用 @NoRepositoryBean 注解。请确保将该注解添加到所有 Spring Data 不应在运行时创建实例的存储库接口上。 |
在多个 Spring Data 模块中使用存储库
在应用程序中使用唯一的 Spring Data 模块会使事情变得简单,因为定义范围内的所有存储库接口都绑定到该 Spring Data 模块。有时,应用程序需要使用多个 Spring Data 模块。在这种情况下,存储库定义必须区分持久化技术。当在类路径上检测到多个存储库工厂时,Spring Data 会进入严格存储库配置模式。严格配置会使用存储库或域类上的详细信息来决定存储库定义的 Spring Data 模块绑定
-
如果存储库定义继承了模块特定的存储库,它是特定 Spring Data 模块的有效候选项。
-
如果域类使用模块特定的类型注解进行注解,它是特定 Spring Data 模块的有效候选项。Spring Data 模块接受第三方注解(例如 JPA 的
@Entity)或提供自己的注解(例如 Spring Data MongoDB 和 Spring Data Elasticsearch 的@Document)。
以下示例显示了一个使用模块特定接口(在本例中是 JPA)的存储库
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 模块的有效候选项。
以下示例显示了一个使用通用接口的存储库
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 模块时这没有问题,但多个模块无法区分这些存储库应该绑定到哪个特定的 Spring Data 模块。
以下示例显示了一个使用带有注解的域类的存储库
interface PersonRepository extends Repository<Person, Long> { … }
@Entity
class Person { … }
interface UserRepository extends Repository<User, Long> { … }
@Document
class User { … }
PersonRepository 引用了 Person,它使用了 JPA 的 @Entity 注解进行注解,因此这个存储库明确属于 Spring Data JPA。UserRepository 引用了 User,它使用了 Spring Data MongoDB 的 @Document 注解进行注解。
以下是一个不良示例,显示了一个使用带有混合注解的域类的存储库
interface JpaPersonRepository extends Repository<Person, Long> { … }
interface MongoDBPersonRepository extends Repository<Person, Long> { … }
@Entity
@Document
class Person { … }
此示例显示了一个域类同时使用了 JPA 和 Spring Data MongoDB 注解。它定义了两个存储库:JpaPersonRepository 和 MongoDBPersonRepository。一个用于 JPA,另一个用于 MongoDB。Spring Data 将无法区分这些存储库,从而导致未定义的行为。
存储库类型详细信息和区分域类注解用于严格的存储库配置,以识别特定 Spring Data 模块的存储库候选项。在同一个域类型上使用多个特定于持久化技术的注解是可能的,并且允许跨多个持久化技术重用域类型。但是,Spring Data 将无法确定绑定存储库的唯一模块。
区分存储库的最后一种方法是通过限定存储库基础包的范围。基础包定义了扫描存储库接口定义的起始点,这意味着存储库定义位于适当的包中。默认情况下,注解驱动的配置使用配置类的包。基于 XML 的配置中的基础包是强制性的。
以下示例展示了注解驱动的基础包配置
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }