定义仓库接口

要定义一个仓库接口,首先需要定义一个特定于领域类的仓库接口。该接口必须继承 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 列表。

如果您应用中的许多仓库应该具有相同的方法集,您可以定义自己的基础接口来继承。这样的接口必须使用 @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 { … }