定义仓库接口

Doubao 中英对照 Defining Repository Interfaces

要定义仓库接口，您首先需要定义一个特定于领域类的仓库接口。该接口必须扩展 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。请注意，与 3.0 之前的 Spring Data 版本不同，各种排序仓库不再扩展各自对应的 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);
}

java

在前一个示例中，您为所有领域仓库定义了一个公共基接口，并暴露了 findById(…) 和 save(…)。这些方法会被路由到 Spring Data 所提供的、您所选存储的仓库基实现中（例如，如果您使用 JPA，该实现就是 SimpleJpaRepository），因为它们与 CrudRepository 中的方法签名相匹配。因此，UserRepository 现在可以保存用户、按 ID 查找单个用户，并触发查询以按电子邮件地址查找 Users。

备注

中间仓库接口标注了 @NoRepositoryBean。请确保为所有不应让 Spring Data 在运行时创建实例的仓库接口都加上该注解。

在多个 Spring Data 模块中使用仓库

在应用中只使用一个 Spring Data 模块会让事情变得简单，因为所定义范围内的所有仓库接口都会绑定到该 Spring Data 模块。有时，应用需要使用不止一个 Spring Data 模块。在这种情况下，仓库定义必须能够区分不同的持久化技术。当 Spring Data 检测到 class path 上存在多个仓库工厂时，它会进入严格仓库配置模式。严格配置会利用仓库或领域类的细节，来为某个仓库定义决定应绑定哪个 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> { … }

java

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

java

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

java

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

java

这个示例展示了一个同时使用 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 { … }

java