定义仓库接口

要定义仓库接口,首先需要定义一个针对特定领域类的仓库接口。该接口必须扩展 Repository,并且使用领域类和 ID 类型进行类型化。如果想为该领域类型暴露 CRUD 方法,可以扩展 CrudRepository 或其变体之一,而不是 Repository

微调仓库定义

可以通过几种变体来开始定义仓库接口。

典型的方法是扩展 CrudRepository,它提供了 CRUD 功能的方法。CRUD 代表创建 (Create)、读取 (Read)、更新 (Update)、删除 (Delete)。从 3.0 版本开始,我们还引入了 ListCrudRepository,它与 CrudRepository 非常相似,但对于返回多个实体的方法,它返回 List 而不是 Iterable,这可能更容易使用。

如果正在使用响应式存储,可以根据使用的响应式框架选择 ReactiveCrudRepositoryRxJava3CrudRepository

如果正在使用 Kotlin,可以选择 CoroutineCrudRepository,它利用了 Kotlin 的协程。

此外,如果需要允许指定 Sort 抽象或在第一种情况下指定 Pageable 抽象的方法,可以扩展 PagingAndSortingRepositoryReactiveSortingRepositoryRxJava3SortingRepositoryCoroutineSortingRepository。请注意,各种排序仓库不再像 Spring Data 3.0 之前的版本那样扩展其各自的 CRUD 仓库。因此,如果想要两者的功能,需要同时扩展这两个接口。

如果不想扩展 Spring Data 接口,还可以使用 @RepositoryDefinition 注解标注仓库接口。扩展 CRUD 仓库接口之一将暴露一套完整的方法来操作实体。如果倾向于选择性地暴露方法,可以将想要暴露的方法从 CRUD 仓库复制到领域仓库中。这样做时,可以更改方法的返回类型。如果可能,Spring Data 会遵循返回类型。例如,对于返回多个实体的方法,可以选择 Iterable<T>List<T>Collection<T> 或 VAVR 列表。

如果应用程序中的许多仓库应该拥有相同的方法集合,可以定义自己的基础接口来继承。这样的接口必须使用 @NoRepositoryBean 进行注解。这可以防止 Spring Data 尝试直接创建其实例并失败,因为它无法确定该仓库对应的实体,因为它仍然包含泛型类型变量。

以下示例展示了如何选择性地暴露 CRUD 方法(在本例中为 findByIdsave

选择性地暴露 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);
}

在前面的示例中,为所有领域仓库定义了一个通用的基础接口,并暴露了 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> { … }

MyRepositoryUserRepository 在其类型层次结构中扩展了 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> { … }

AmbiguousRepositoryAmbiguousUserRepository 在其类型层次结构中只扩展了 RepositoryCrudRepository。在使用唯一的 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,它使用了 JPA 的 @Entity 注解进行标注,因此该仓库显然属于 Spring Data JPA。UserRepository 引用了 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 注解的领域类。它定义了两个仓库,JpaPersonRepositoryMongoDBPersonRepository。一个用于 JPA,另一个用于 MongoDB。Spring Data 无法再区分这些仓库,这会导致未定义的行为。

仓库类型详细信息区分领域类注解 用于严格的仓库配置,以识别特定 Spring Data 模块的仓库候选者。在同一个领域类型上使用多个特定持久化技术的注解是可能的,并可以在多个持久化技术之间重用领域类型。但是,Spring Data 随后将无法确定用于绑定仓库的唯一模块。

最后一种区分仓库的方法是通过限定仓库基础包。基础包定义了扫描仓库接口定义的起始点,这意味着仓库定义应该位于适当的包中。默认情况下,注解驱动的配置使用配置类所在的包。在基于 XML 的配置中的基础包是强制性的。

以下示例展示了基础包的注解驱动配置

基础包的注解驱动配置
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }