定义 Repository 接口

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

微调 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。请注意，各种排序 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 列表。

如果你的应用程序中的许多 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 查找单个用户，并触发查询以根据电子邮件地址查找 User。

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

在多个 Spring Data 模块中使用 Repositories

在应用程序中使用单个 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 { … }