定义存储库接口

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

微调存储库定义

您可以通过几种方式开始使用存储库接口。

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

如果您使用的是反应式存储,您可以选择ReactiveCrudRepositoryRxJava3CrudRepository,具体取决于您使用的反应式框架。

如果您使用的是Kotlin,您可以选择CoroutineCrudRepository,它利用了Kotlin的协程。

此外,如果您需要允许指定Sort抽象或在第一种情况下指定Pageable抽象的方法,您可以扩展PagingAndSortingRepositoryReactiveSortingRepositoryRxJava3SortingRepositoryCoroutineSortingRepository。请注意,与Spring Data 3.0之前的版本不同,各种排序存储库不再扩展它们各自的CRUD存储库。因此,如果您想要两种功能,则需要扩展这两个接口。

如果您不想扩展Spring Data接口,您也可以使用@RepositoryDefinition注解您的存储库接口。扩展其中一个CRUD存储库接口会公开一组完整的用于操作实体的方法。如果您希望选择要公开的方法,请将您想要公开的方法从CRUD存储库复制到您的域存储库中。这样做时,您可以更改方法的返回类型。Spring Data将尽可能地尊重返回类型。例如,对于返回多个实体的方法,您可以选择Iterable<T>List<T>Collection<T>或VAVR列表。

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

以下示例展示了如何选择性地公开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);
}

在前面的示例中,您为所有域存储库定义了一个通用的基本接口,并公开了 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> { … }

MyRepositoryUserRepository 在其类型层次结构中扩展了 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> { … }

AmbiguousRepositoryAmbiguousUserRepository 仅在其类型层次结构中扩展 RepositoryCrudRepository。虽然在使用唯一的 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 注释的域类。它定义了两个存储库,JpaPersonRepositoryMongoDBPersonRepository。一个用于 JPA,另一个用于 MongoDB 使用。Spring Data 现在无法区分这些存储库,这会导致未定义的行为。

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

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

以下示例显示了基本包的基于注释的配置

基本包的基于注释的配置
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }