定义仓库接口

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

微调仓库定义

有几种方式可以开始定义您的仓库接口。

典型的方法是扩展 CrudRepository,它提供了 CRUD 功能的方法。CRUD 代表 Create(创建)、Read(读取)、Update(更新)、Delete(删除)。在版本 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 list。

如果您的应用程序中的许多仓库应该拥有相同的方法集,您可以定义自己的基接口来继承。这样的接口必须使用 @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 引用了使用 JPA @Entity 注解注解的 Person,因此此仓库显然属于 Spring Data JPA。UserRepository 引用了使用 Spring Data MongoDB 的 @Document 注解注解的 User

以下不良示例展示了使用带混合注解的域类的仓库

示例 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 { … }