跳到主要内容

定义仓库接口

DeepSeek V3 中英对照 Defining Repository Interfaces

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

@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);
}
java

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

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> {}
java

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 {}
java

PersonRepository 引用了 Person,而 Person 使用了 JPA 的 @Entity 注解,因此这个仓库显然属于 Spring Data JPA。UserRepository 引用了 User,而 User 使用了 Spring Data MongoDB 的 @Document 注解。

下面的不良示例展示了一个使用混合注解的领域类的仓库:

示例 4:使用混合注解的领域类定义仓库

interface JpaPersonRepository extends Repository<Person, Long> {}

interface MongoDBPersonRepository extends Repository<Person, Long> {}

@Entity
@Document
class Person {}
java

这个示例展示了一个同时使用 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 {}
java