定义存储库接口

要定义存储库接口，您首先需要定义一个特定于域类的存储库接口。该接口必须扩展 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 列表。

如果应用程序中的许多存储库应该具有相同的 methods 集，您可以定义自己的基接口来继承。此类接口必须使用 @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(…)。这些方法被路由到您选择的存储的基存储库实现中（例如，如果您使用 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 { … }