定义仓库接口
要定义一个仓库接口,您首先需要定义一个特定于域类的仓库接口。该接口必须扩展 Repository
并针对域类和 ID 类型进行类型化。如果您想为该域类型公开 CRUD 方法,您可以扩展 CrudRepository
或其变体,而不是 Repository
。
微调仓库定义
您可以通过几种变体来开始您的仓库接口。
典型的做法是扩展CrudRepository
,它提供了用于CRUD功能的方法。CRUD代表创建、读取、更新、删除。在3.0版本中,我们还引入了ListCrudRepository
,它与CrudRepository
非常相似,但对于返回多个实体的方法,它返回一个List
而不是一个Iterable
,你可能会觉得更容易使用。
如果你使用的是响应式存储,你可能会选择ReactiveCrudRepository
,或者RxJava3CrudRepository
,具体取决于你使用的响应式框架。
如果你使用的是Kotlin,你可能会选择CoroutineCrudRepository
,它利用了Kotlin的协程。
此外,如果你需要允许指定Sort
抽象或在第一种情况下指定Pageable
抽象的方法,你可以扩展PagingAndSortingRepository
、ReactiveSortingRepository
、RxJava3SortingRepository
或CoroutineSortingRepository
。请注意,各种排序存储库不再像Spring Data 3.0之前的版本那样扩展它们各自的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)的存储库。
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 模块的有效候选者。
以下示例展示了一个使用泛型接口的存储库。
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。
以下示例展示了一个使用带有注释的域类的存储库。
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
注解进行标注。
以下错误示例展示了一个使用混合注解的域类的仓库。
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 无法再区分这些仓库,这会导致未定义的行为。
仓库类型详细信息 和 区分域类注解 用于严格的仓库配置,以识别特定 Spring Data 模块的仓库候选者。在同一个域类型上使用多个持久化技术特定的注解是可能的,并且能够跨多个持久化技术重用域类型。但是,Spring Data 无法再确定一个唯一的模块来绑定仓库。
区分仓库的最后一种方法是通过范围仓库基础包。基础包定义了扫描仓库接口定义的起点,这意味着仓库定义位于相应的包中。默认情况下,注解驱动的配置使用配置类的包。 基于 XML 的配置中的基础包 是必需的。
以下示例展示了基础包的注解驱动配置。
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }