定义 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 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 模块中使用 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 基础包范围。基础包定义了扫描 repository 接口定义的起始点，这意味着 repository 定义位于适当的包中。默认情况下，注解驱动的配置使用配置类所在的包。XML 配置中的基础包是强制性的。

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

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