定义仓库接口

要定义仓库接口，首先需要定义一个特定于领域类的仓库接口。该接口必须扩展 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。请注意，与 Spring Data 3.0 之前的版本不同，各种排序仓库不再扩展其各自的 CRUD 仓库。因此，如果你需要两者的功能，则需要同时扩展这两个接口。

如果不想扩展 Spring Data 接口，也可以使用 @RepositoryDefinition 注解标注你的仓库接口。扩展其中一个 CRUD 仓库接口会暴露一套完整的方法来操作实体。如果你想选择性地暴露方法，可以将你想要暴露的方法从 CRUD 仓库复制到你的领域仓库中。这样做时，可以更改方法的返回类型。Spring Data 会尽可能尊重返回类型。例如，对于返回多个实体的方法，你可以选择 Iterable<T>、List<T>、Collection<T> 或 VAVR 列表。

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

以下示例展示了如何选择性地暴露 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);
}

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

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

将仓库与多个 Spring Data 模块一起使用

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

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

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

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

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

仓库类型详细信息和区分领域类注解用于严格仓库配置模式，以识别特定 Spring Data 模块的仓库候选。在同一个领域类型上使用多个特定于持久化技术的注解是可能的，并且可以在多种持久化技术中复用领域类型。但是，这样 Spring Data 就无法再确定一个唯一的模块来绑定仓库。

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

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

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