跳到主要内容
版本:4.4.3

定义仓库接口

ChatGPT-4o-mini 中英对照 Defining Repository Interfaces

要定义一个仓库接口,首先需要定义一个特定于领域类的仓库接口。该接口必须继承 Repository,并指定领域类和 ID 类型。如果你想为该领域类型公开 CRUD 方法,可以继承 CrudRepository 或其变体,而不是 Repository。

微调仓库定义​

典型的方法是扩展 CrudRepository,它为你提供了 CRUD 功能的方法。CRUD 代表创建(Create)、读取(Read)、更新(Update)、删除(Delete)。在 3.0 版本中,我们还引入了 ListCrudRepository,它与 CrudRepository 非常相似,但对于那些返回多个实体的方法,它返回的是一个 List,而不是 Iterable,你可能会觉得使用 List 更加方便。

如果你正在使用响应式存储,你可以选择 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 模块的绑定,以便为存储库定义做出决策:

  1. 如果仓库定义 扩展了特定模块的仓库,它是特定 Spring Data 模块的有效候选。

  2. 如果域类 使用特定模块的类型注解进行注解,它是特定 Spring Data 模块的有效候选。Spring Data 模块接受第三方注解(例如 JPA 的 @Entity)或提供自己的注解(例如 Spring Data MongoDB 和 Spring Data Elasticsearch 的 @Document)。

以下示例展示了一个使用模块特定接口(在此情况下为 JPA)的存储库:

示例 1. 使用特定模块接口的仓库定义

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 模块的有效候选者。

以下示例展示了一个使用泛型接口的仓库:

示例 2. 使用通用接口的仓库定义

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。

以下示例展示了一个使用带注解的领域类的仓库:

示例 3. 使用带注解的领域类定义的仓库

interface PersonRepository extends Repository<Person, Long> { … }

@Entity
class Person { … }

interface UserRepository extends Repository<User, Long> { … }

@Document
class User { … }

PersonRepository 引用了 Person,而 Person 使用了 JPA 的 @Entity 注解,因此这个仓库显然属于 Spring Data JPA。UserRepository 引用了 User,而 User 使用了 Spring Data MongoDB 的 @Document 注解。

以下不良示例展示了一个使用混合注解的领域类的仓库:

示例 4. 使用混合注解的领域类的仓库定义

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 { … }