此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.4.0! |
定义存储库接口
要定义存储库接口,您首先需要定义特定于域类的存储库接口。
接口必须扩展并键入域类和 ID 类型。
如果要公开该域类型的 CRUD 方法,则可以扩展 ,或其变体之一,而不是 .Repository
CrudRepository
Repository
微调存储库定义
有几种变体可以开始使用 repository 界面。
典型的方法是 extend ,它为您提供了 CRUD 功能的方法。
CRUD 代表 Create、Read、Update、Delete。
在 3.0 版本中,我们还引入了与 非常相似的 ,但对于那些返回多个实体的方法,它返回 a 而不是 an,您可能会觉得这更容易使用。CrudRepository
ListCrudRepository
CrudRepository
List
Iterable
如果您使用的是反应式 store,则可以选择 ,或者取决于您使用的反应式框架。ReactiveCrudRepository
RxJava3CrudRepository
如果您使用的是 Kotlin,则可以选择哪个使用 Kotlin 的协程。CoroutineCrudRepository
此外,您可以扩展 , , , ,或者如果您需要允许指定抽象的方法,或者在第一种情况下允许指定抽象。
请注意,各种排序存储库不再像在 Spring Data Versions 3.0 之前的版本中那样扩展各自的 CRUD 存储库。
因此,如果想要两个接口的功能,则需要扩展这两个接口。PagingAndSortingRepository
ReactiveSortingRepository
RxJava3SortingRepository
CoroutineSortingRepository
Sort
Pageable
如果您不想扩展 Spring Data 接口,还可以使用 .
扩展其中一个 CRUD 存储库接口会公开一整套方法来操作您的实体。
如果您希望对公开的方法有选择性,请将要公开的方法从 CRUD 存储库复制到您的域存储库中。
执行此操作时,您可以更改方法的返回类型。
如果可能,Spring Data 将遵循 return 类型。
例如,对于返回多个实体的方法,您可以选择 VAVR 列表。@RepositoryDefinition
Iterable<T>
List<T>
Collection<T>
如果应用程序中的许多存储库应该具有相同的方法集,则可以定义自己的基本接口以从中继承。
此类接口必须用 .
这可以防止 Spring Data 尝试直接创建它的实例并失败,因为它无法确定该存储库的实体,因为它仍然包含泛型类型变量。@NoRepositoryBean
以下示例显示如何选择性地公开 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);
}
在前面的示例中,您为所有域存储库定义了一个通用的基本接口,并公开了 .这些方法将路由到 Spring Data 提供的所选存储的基本存储库实现中(例如,如果使用 JPA,则实现为 ),因为它们与 中的方法签名匹配。
因此,现在可以保存用户,按 ID 查找单个用户,并触发查询以按电子邮件地址查找。findById(…)
save(…)
SimpleJpaRepository
CrudRepository
UserRepository
Users
中间存储库接口用 .
确保将该 Comments 添加到 Spring Data 不应在运行时为其创建实例的所有存储库接口。@NoRepositoryBean |
使用具有多个 Spring Data 模块的存储库
在应用程序中使用唯一的 Spring Data 模块使事情变得简单,因为定义范围内的所有存储库接口都绑定到 Spring Data 模块。 有时,应用程序需要使用多个 Spring Data 模块。 在这种情况下,存储库定义必须区分持久性技术。 当它在类路径上检测到多个存储库工厂时, Spring Data 进入严格的存储库配置模式。 严格配置使用存储库或域类的详细信息来决定存储库定义的 Spring Data 模块绑定:
-
如果存储库定义扩展了特定于模块的存储库,则它是特定 Spring Data 模块的有效候选者。
-
如果域类使用特定于模块的类型 Comments 进行 Comments,则它是特定 Spring Data 模块的有效候选者。 Spring Data 模块接受第三方注释(例如 JPA)或提供自己的注释(例如用于 Spring Data MongoDB 和 Spring Data Elasticsearch)。
@Entity
@Document
以下示例显示了使用特定于模块的接口(在本例中为 JPA)的存储库:
interface MyRepository extends JpaRepository<User, Long> { }
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends JpaRepository<T, ID> { … }
interface UserRepository extends MyBaseRepository<User, Long> { … }
MyRepository
和 extend。
它们是 Spring Data JPA 模块的有效候选者。UserRepository
JpaRepository
以下示例显示了使用泛型接口的存储库:
interface AmbiguousRepository extends Repository<User, Long> { … }
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends CrudRepository<T, ID> { … }
interface AmbiguousUserRepository extends MyBaseRepository<User, Long> { … }
AmbiguousRepository
和 extend only 和 在其类型层次结构中。
虽然在使用唯一的 Spring Data 模块时这很好,但多个模块无法区分这些存储库应该绑定到哪个特定的 Spring Data。AmbiguousUserRepository
Repository
CrudRepository
以下示例显示了使用带有注释的域类的存储库:
interface PersonRepository extends Repository<Person, Long> { … }
@Entity
class Person { … }
interface UserRepository extends Repository<User, Long> { … }
@Document
class User { … }
PersonRepository
references ,它用 JPA 注释进行注释,因此此存储库显然属于 Spring Data JPA。 references ,它使用 Spring Data MongoDB 的注释进行注释。Person
@Entity
UserRepository
User
@Document
以下错误示例显示了使用具有混合注释的域类的存储库:
interface JpaPersonRepository extends Repository<Person, Long> { … }
interface MongoDBPersonRepository extends Repository<Person, Long> { … }
@Entity
@Document
class Person { … }
此示例显示了使用 JPA 和 Spring Data MongoDB 注释的域类。
它定义了两个存储库,以及 .
一个用于 JPA,另一个用于 MongoDB。
Spring Data 无法再区分存储库,这会导致未定义的行为。JpaPersonRepository
MongoDBPersonRepository
存储库类型详细信息和区分域类注释用于严格的存储库配置,以识别特定 Spring Data 模块的存储库候选者。 可以在同一域类型上使用多个特定于持久化技术的注释,并支持跨多个持久化技术重用域类型。 但是, Spring Data 无法再确定要绑定存储库的唯一模块。
区分存储库的最后一种方法是确定存储库基础包的范围。 基本包定义扫描存储库接口定义的起点,这意味着将存储库定义位于相应的包中。 默认情况下,注解驱动的配置使用 configuration 类的 package。 基于 XML 的配置中的基本软件包是必需的。
以下示例显示了基础包的注释驱动配置:
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }