定义仓库接口
要定义仓库接口,你首先需要定义一个特定于领域类的仓库接口。该接口必须扩展 Repository,并以领域类和 ID 类型作为类型参数。如果你想为该领域类型暴露 CRUD 方法,可以扩展 CrudRepository 或其变体之一,而不是扩展 Repository。
微调仓库定义
有几种方式可以开始使用你的仓库接口。
典型的方法是扩展 CrudRepository,它为你提供 CRUD 功能的方法。CRUD 代表创建(Create)、读取(Read)、更新(Update)、删除(Delete)。在 3.0 版本中,我们还引入了 ListCrudRepository,它与 CrudRepository 非常相似,但对于那些返回多个实体的方法,它返回 List 而不是 Iterable,你可能会发现它更易于使用。
如果你使用响应式存储,你可以根据所使用的响应式框架选择 ReactiveCrudRepository 或 RxJava3CrudRepository。
如果你使用 Kotlin,你可以选择利用 Kotlin 协程的 CoroutineCrudRepository。
此外,如果你需要允许指定 Sort 抽象或在第一种情况下指定 Pageable 抽象的方法,则可以扩展 PagingAndSortingRepository、ReactiveSortingRepository、RxJava3SortingRepository 或 CoroutineSortingRepository。请注意,各种排序仓库不再像 3.0 之前的 Spring Data 版本那样扩展各自的 CRUD 仓库。因此,如果你需要两者的功能,就需要同时扩展这两个接口。
如果你不想扩展 Spring Data 接口,也可以用 @RepositoryDefinition 注解你的仓库接口。扩展其中一个 CRUD 仓库接口会暴露一整套用于操作实体的方法。如果你希望对所暴露的方法有所选择,可以将你想暴露的方法从 CRUD 仓库复制到你的领域仓库中。这样做时,你可以更改方法的返回类型。Spring Data 会在可能的情况下遵从该返回类型。例如,对于返回多个实体的方法,你可以选择 Iterable<T>、List<T>、Collection<T> 或 VAVR 列表。
如果你的应用程序中的许多仓库应该具有相同的方法集,你可以定义自己的基接口来继承。这样的接口必须用 @NoRepositoryBean 注解。这会阻止 Spring Data 尝试直接创建它的实例并因此失败,因为它无法确定该仓库的实体,毕竟它仍然包含一个泛型类型变量。
以下示例展示了如何有选择地暴露 CRUD 方法(本例中为 findById 和 save):
@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 模块绑定:
- 如果仓库定义扩展模块特定的仓库,则它是特定 Spring Data 模块的有效候选。
- 如果领域类标注了模块特定的类型注解,则它是特定 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> { … }
MyRepository 和 UserRepository 在其类型层次结构中扩展了 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> { … }
AmbiguousRepository 和 AmbiguousUserRepository 在其类型层次结构中仅扩展了 Repository 和 CrudRepository。虽然在使用唯一的 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 注解的领域类。它定义了两个仓库,JpaPersonRepository 和 MongoDBPersonRepository。一个用于 JPA,另一个用于 MongoDB。Spring Data 无法再区分这些仓库,这会导致未定义的行为。
区分仓库的最后一种方式是通过划定仓库基包的作用域。基包定义了扫描仓库接口定义的起点,这意味着仓库定义要位于相应的包中。默认情况下,注解驱动的配置使用配置类所在的包。基于 XML 的配置中的基包是必需的。
以下示例展示了基包的注解驱动配置:
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }