定义仓库接口

要定义一个仓库接口，您首先需要定义一个特定于领域类的仓库接口。该接口必须扩展 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 将无法确定用于绑定该仓库的唯一模块。

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

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

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