定义 Repository 接口

要定义一个 Repository 接口，首先需要定义一个特定于领域类的 Repository 接口。该接口必须扩展 Repository，并指定领域类和 ID 类型。如果想为该领域类型暴露 CRUD 方法，可以扩展 CrudRepository 或其变体，而不是 Repository。

微调 Repository 定义

有几种变体可以开始定义你的 Repository 接口。

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

如果使用响应式存储（reactive store），你可以选择 ReactiveCrudRepository 或 RxJava3CrudRepository，具体取决于你使用的响应式框架。

如果使用 Kotlin，可以选择 CoroutineCrudRepository，它利用了 Kotlin 的协程（coroutines）。

此外，如果需要允许指定 Sort 抽象（或在第一种情况下指定 Pageable 抽象）的方法，可以扩展 PagingAndSortingRepository、ReactiveSortingRepository、RxJava3SortingRepository 或 CoroutineSortingRepository。请注意，各种排序 Repository 在 Spring Data 3.0 版本之前不再扩展其各自的 CRUD Repository。因此，如果需要两者的功能，你需要同时扩展这两个接口。

如果你不想扩展 Spring Data 接口，也可以用 @RepositoryDefinition 注解你的 Repository 接口。扩展其中一个 CRUD Repository 接口会暴露一组完整的方法来操作你的实体。如果你希望有选择地暴露方法，可以将你想暴露的方法从 CRUD Repository 中复制到你的领域 Repository 中。这样做时，你可以改变方法的返回类型。Spring Data 将尽可能遵守返回类型。例如，对于返回多个实体的方法，你可以选择 Iterable<T>、List<T>、Collection<T> 或 VAVR list。

如果你的应用程序中的许多 Repository 应该具有相同的方法集，你可以定义自己的基础接口来继承。这样的接口必须用 @NoRepositoryBean 注解。这可以防止 Spring Data 试图直接创建它的实例并失败，因为它仍然包含一个泛型类型变量，无法确定该 Repository 的实体类型。

以下示例展示了如何选择性地暴露 CRUD 方法（在本例中是 findById 和 save）

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

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

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

结合多个 Spring Data 模块使用 Repository

在应用程序中使用唯一的 Spring Data 模块很简单，因为所有在定义范围内 Repository 接口都绑定到该 Spring Data 模块。有时，应用程序需要使用多个 Spring Data 模块。在这种情况下，Repository 定义必须区分不同的持久化技术。当在类路径上检测到多个 Repository 工厂时，Spring Data 进入严格的 Repository 配置模式。严格配置使用 Repository 或领域类的详细信息来决定 Repository 定义与哪个 Spring Data 模块绑定。

  1. 如果 Repository 定义 扩展了模块特定的 Repository，则它是特定 Spring Data 模块的有效候选项。

  2. 如果领域类 使用了模块特定的类型注解进行标注，则它是特定 Spring Data 模块的有效候选项。Spring Data 模块接受第三方注解（如 JPA 的 @Entity）或提供自己的注解（如用于 Spring Data MongoDB 和 Spring Data Elasticsearch 的 @Document）。

以下示例展示了一个使用模块特定接口的 Repository（本例中为 JPA）

示例 1. 使用模块特定接口的 Repository 定义
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 模块的有效候选项。

以下示例展示了一个使用通用接口的 Repository

示例 2. 使用通用接口的 Repository 定义
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 模块时这是可以的，但多个模块无法区分这些 Repository 应该绑定到哪个特定的 Spring Data 模块。

以下示例展示了一个使用带有注解的领域类的 Repository

示例 3. 使用带有注解的领域类的 Repository 定义
interface PersonRepository extends Repository<Person, Long> { … }

@Entity
class Person { … }

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

@Document
class User { … }

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

以下这个反面示例展示了一个使用带有混合注解的领域类的 Repository

示例 4. 使用带有混合注解的领域类的 Repository 定义
interface JpaPersonRepository extends Repository<Person, Long> { … }

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

@Entity
@Document
class Person { … }

此示例展示了一个同时使用 JPA 和 Spring Data MongoDB 注解的领域类。它定义了两个 Repository：JpaPersonRepository 和 MongoDBPersonRepository。一个用于 JPA，另一个用于 MongoDB。Spring Data 无法区分这两个 Repository，这会导致未定义的行为。

Repository 类型细节 和 区分领域类注解 用于严格的 Repository 配置，以识别特定 Spring Data 模块的 Repository 候选项。在同一个领域类型上使用多个特定于持久化技术的注解是可能的，并且可以在多个持久化技术中重用领域类型。然而，这样 Spring Data 就无法确定要绑定该 Repository 的唯一模块。

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

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

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