定义 Repository 接口

QWen Flash 中英对照 Defining Repository Interfaces

要定义 repository 接口，首先需要定义特定领域类的 repository 接口。该接口必须继承 Repository，并指定领域类和 ID 类型作为泛型参数。如果要为该领域类型暴露 CRUD 方法，可以继承 CrudRepository 或其变体，而不是 Repository。

微调仓库定义

有几种方法可以开始使用你的 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 注解你的 repository 接口。扩展 CRUD repository 接口中的某个接口会暴露出一整套用于操作实体的方法。如果你更希望有选择地暴露方法，可以将你希望暴露的 CRUD repository 方法复制到你的 domain repository 中。这样做时，你可以更改方法的返回类型。Spring Data 会在可能的情况下尊重该返回类型。例如，对于返回多个实体的方法，你可以选择 Iterable<T>、List<T>、Collection<T> 或 VAVR 列表。

如果应用程序中的许多 repository 应具有相同的方法集，你可以定义自己的基础接口供继承。此类接口必须使用 @NoRepositoryBean 进行注解。这会阻止 Spring Data 尝试直接创建其实例，并避免因无法确定该 repository 的实体而失败，因为它仍然包含一个泛型类型变量。

以下示例展示了如何选择性地暴露 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 的查询。

备注

中间 repository 接口使用 @NoRepositoryBean 注解。请确保将该注解添加到所有 Spring Data 在运行时不应创建实例的 repository 接口中。

在多个 Spring Data 模块中使用存储库

在应用中使用唯一的 Spring Data module 会让事情变得简单，因为所定义的 scope 中的所有 repository interfaces 都会绑定到该 Spring Data module。有时，应用需要使用多个 Spring Data module。在这种情况下，repository definition 必须区分 persistence technologies。当它在 class path 上检测到多个 repository factories 时，Spring Data 会进入 strict repository configuration mode。strict configuration 会利用 repository 或 domain class 上的细节来决定 repository definition 的 Spring Data module binding:

1. 如果仓储定义 扩展了特定模块的仓储，那么它是该特定 Spring Data 模块的有效候选。

2. 如果领域类 被特定模块的类型注解标注，那么它是该特定 Spring Data 模块的有效候选。Spring Data 模块接受第三方注解（例如 JPA 的 @Entity），或者提供自己的注解（例如 Spring Data MongoDB 和 Spring Data Elasticsearch 的 @Document）。

以下示例展示了一个使用模块特定接口的 repository（本例中为 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 模块的有效候选项。

以下示例展示了一个使用泛型接口的 repository：

示例 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. 使用带注解的领域类的 Repository 定义

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

@Entity
class Person { … }

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

@Document
class User { … }

java

PersonRepository 引用了 Person，而 Person 使用 JPA @Entity 注解进行标注，因此该 repository 显然属于 Spring Data JPA。UserRepository 引用了 User，而 User 使用 Spring Data MongoDB 的 @Document 注解进行标注。

以下反面示例展示了一个仓库，其中领域类使用了混合注解：

示例 4. 使用带有混合注解的领域类进行 Repository 定义

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 已无法区分这些仓库，这会导致未定义行为。

Repository 类型详情 和区分 domain class 注解 用于 strict repository configuration，以便为特定 Spring Data 模块识别 repository 候选项。可以在同一个 domain type 上使用多个 persistence technology-specific 注解，并支持在多个 persistence technology 之间复用 domain type。然而，Spring Data 随后可能无法确定用于绑定 repository 的唯一模块。

最后一种区分 repository 的方式是通过 scoping repository base packages。Base packages 定义了扫描 repository interface definitions 的起始点，这意味着 repository definitions 位于合适的 packages 中。默认情况下，annotation-driven configuration 使用 configuration class 的 package。XML-based configuration 中的 base package 是必需的。

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

@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }

java