定义存储库接口 (Defining Repository Interfaces) _ Spring Data3.2.7中文文档(官方文档中文翻译)|Spring 教程 —

对于最新的稳定版本，请使用 Spring Data Commons 3.3.1！

要定义存储库接口，首先需要定义特定于域类的存储库接口。接口必须扩展并类型化为域类和 ID 类型。如果要公开该域类型的 CRUD 方法，可以扩展或其变体之一，而不是。RepositoryCrudRepositoryRepository

微调存储库定义

有几种变体可以开始使用存储库界面。

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

如果您使用的是响应式存储，则可以选择，或者取决于您使用的响应式框架。ReactiveCrudRepositoryRxJava3CrudRepository

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

此外，您可以扩展、、或如果需要允许指定抽象的方法，或者在第一种情况下指定抽象。请注意，各种排序存储库不再像在 Spring Data Versions 3.0 之前那样扩展其各自的 CRUD 存储库。因此，如果您想要两个接口的功能，则需要扩展这两个接口。PagingAndSortingRepositoryReactiveSortingRepositoryRxJava3SortingRepositoryCoroutineSortingRepositorySortPageable

如果你不想扩展 Spring Data 接口，你也可以用来注释你的存储库接口。扩展其中一个 CRUD 存储库接口会公开一整套方法来操作实体。如果您希望对要公开的方法有选择性，请将要公开的方法从 CRUD 存储库复制到域存储库中。执行此操作时，可以更改方法的返回类型。如果可能，Spring Data 将遵循返回类型。例如，对于返回多个实体的方法，可以选择、或 VAVR 列表。@RepositoryDefinitionIterable<T>List<T>Collection<T>

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

下面的示例演示如何有选择地公开 CRUD 方法（在本例中为和）：findByIdsave

选择性公开 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);
}

在前面的示例中，您为所有域存储库定义了一个通用基本接口，并公开了 .这些方法被路由到 Spring Data 提供的所选存储库的基本存储库实现中（例如，如果您使用 JPA，则实现为），因为它们与中的方法签名匹配。因此，现在可以保存用户，按 ID 查找单个用户，并触发查询以按电子邮件地址查找。findById(…)save(…)SimpleJpaRepositoryCrudRepositoryUserRepositoryUsers

中间存储库接口用 . 确保将该注释添加到Spring Data不应在运行时为其创建实例的所有存储库接口。@NoRepositoryBean

将存储库与多个 Spring 数据模块结合使用

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

如果存储库定义扩展了特定于模块的存储库，则它是特定 Spring Data 模块的有效候选者。
如果域类使用特定于模块的类型注释进行注释，则它是特定 Spring Data 模块的有效候选者。 Spring Data 模块接受第三方注解（如 JPA 的注解）或提供自己的注解（如 Spring Data MongoDB 和 Spring Data Elasticsearch）。@Entity@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并在其类型层次结构中扩展。它们是 Spring Data JPA 模块的有效候选模块。UserRepositoryJpaRepository

以下示例显示了使用泛型接口的存储库：

例 2.使用泛型接口的存储库定义

interface AmbiguousRepository extends Repository<User, Long> { … }

@NoRepositoryBean
interface MyBaseRepository<T, ID> extends CrudRepository<T, ID> { … }

interface AmbiguousUserRepository extends MyBaseRepository<User, Long> { … }

AmbiguousRepository并仅在其类型层次结构中扩展。虽然这在使用唯一的 Spring Data 模块时很好，但多个模块无法区分这些存储库应该绑定到哪个特定的 Spring Data。AmbiguousUserRepositoryRepositoryCrudRepository

以下示例显示了使用带有注释的域类的存储库：

例 3.使用带有注释的域类的存储库定义

interface PersonRepository extends Repository<Person, Long> { … }

@Entity
class Person { … }

interface UserRepository extends Repository<User, Long> { … }

@Document
class User { … }

PersonRepository引用，这是用 JPA 注释注释的，所以这个存储库显然属于 Spring Data JPA。 references，它用Spring Data MongoDB的注释进行注释。Person@EntityUserRepositoryUser@Document

以下错误示例显示了使用具有混合注释的域类的存储库：

例 4.使用具有混合注释的域类的存储库定义

interface JpaPersonRepository extends Repository<Person, Long> { … }

interface MongoDBPersonRepository extends Repository<Person, Long> { … }

@Entity
@Document
class Person { … }

此示例显示了同时使用 JPA 和 Spring Data MongoDB 注释的域类。它定义了两个存储库，以及 . 一个用于 JPA，另一个用于 MongoDB。 Spring Data 不再能够区分存储库，这会导致未定义的行为。JpaPersonRepositoryMongoDBPersonRepository

存储库类型详细信息和区分域类注释用于严格的存储库配置，以识别特定 Spring Data 模块的存储库候选者。可以在同一域类型上使用多个特定于持久性技术的注释，并且可以在多个持久性技术中重用域类型。但是，Spring Data无法再确定要绑定存储库的唯一模块。

区分存储库的最后一种方法是确定存储库基本包的范围。基本包定义了扫描存储库接口定义的起点，这意味着存储库定义位于相应的包中。默认情况下，注释驱动的配置使用配置类的包。基于 XML 的配置中的基本包是必需的。

以下示例显示了基础包的注释驱动配置：

基础包的注释驱动配置

@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }