定义存储库接口

要定义存储库接口，首先需要定义一个特定于域类的存储库接口。该接口必须扩展 Repository 并被键入到域类和 ID 类型。如果您想公开该域类型的 CRUD 方法，则可以扩展 CrudRepository 或其变体之一，而不是 Repository。

微调存储库定义

有几种方法可以开始使用存储库接口。

典型的方法是扩展 CrudRepository，它为您提供了 CRUD 功能的方法。CRUD 代表创建、读取、更新、删除。在版本 3.0 中，我们还引入了 ListCrudRepository，它与 CrudRepository 非常相似，但对于返回多个实体的方法，它返回一个 List 而不是 Iterable，您可能会发现它更容易使用。

如果您使用的是反应式存储，则可以选择 ReactiveCrudRepository 或 RxJava3CrudRepository，具体取决于您使用的反应式框架。

如果您使用的是 Kotlin，则可以选择利用 Kotlin 协程的 CoroutineCrudRepository。

如果您需要允许指定 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 { … }