定义仓库接口

要定义一个仓库接口，首先需要定义一个特定于域类的仓库接口。该接口必须扩展 Repository 并针对域类和 ID 类型进行类型化。如果你想为该域类型公开 CRUD 方法，你可以扩展 CrudRepository 或其变体，而不是 Repository。

微调仓库定义

有几种方法可以开始使用你的仓库接口。

典型的方法是扩展 CrudRepository，它为你提供 CRUD 功能的方法。CRUD 代表创建、读取、更新、删除。在 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 { … }