核心概念
Spring Data 仓库抽象中的核心接口是 Repository
。它接受要管理的领域类以及领域类的标识符类型作为类型参数。此接口主要作为一个标记接口,用于捕获要处理的类型,并帮助你发现扩展此接口的接口。
Spring Data 将领域类型视为实体,更具体地说是聚合体。因此,在文档中你会看到“实体”这一术语,它可以与“领域类型”或“聚合体”互换使用。
正如你可能在介绍中已经注意到的,文档已经暗示了领域驱动设计的概念。我们以 DDD(领域驱动设计)的意义来考虑领域对象。领域对象具有标识符(否则这些将是无标识的值对象),并且在处理某些模式以访问数据时,我们以某种方式需要引用标识符。在讨论存储库和查询方法时,引用标识符将变得更加有意义。
CrudRepository 和 ListCrudRepository 接口为被管理的实体类提供了复杂的 CRUD 功能。
public interface CrudRepository<T, ID> extends Repository<T, ID> {
<S extends T> S save(S entity); 1
Optional<T> findById(ID primaryKey); 2
Iterable<T> findAll(); 3
long count(); 4
void delete(T entity); 5
boolean existsById(ID primaryKey); 6
// … more functionality omitted.
}
保存给定的实体。
返回由给定 ID 标识的实体。
返回所有实体。
返回实体的数量。
删除给定的实体。
指示是否存在具有给定 ID 的实体。
在该接口中声明的方法通常被称为 CRUD 方法。ListCrudRepository
提供了等效的方法,但它们返回 List
,而 CrudRepository
的方法返回 Iterable
。
仓库接口隐含了一些保留方法,如 findById(ID identifier)
,这些方法针对的是域类型的标识符属性,而不管其属性名称是什么。你可以在“定义查询方法”中了解更多相关信息。
如果一个名为 Id
的属性并不指向标识符,你可以使用 @Query
注解来为查询方法提供自定义查询。然而,这种做法容易导致混淆,因此不推荐使用,因为如果 ID
类型和 Id
属性的类型不一致,你很快就会遇到类型限制的问题。
我们还提供了特定于持久化技术的抽象,例如 JpaRepository
或 MongoRepository
。这些接口扩展了 CrudRepository
,并展示了底层持久化技术的能力,此外还提供了较为通用的、与持久化技术无关的接口,如 CrudRepository
。
除了 CrudRepository
之外,还有 PagingAndSortingRepository 和 ListPagingAndSortingRepository,它们提供了额外的方法,以便更轻松地实现分页访问实体:
public interface PagingAndSortingRepository<T, ID> {
Iterable<T> findAll(Sort sort);
Page<T> findAll(Pageable pageable);
}
扩展接口需要由实际的存储模块来支持。虽然本文档解释了通用的方案,但请确保您的存储模块支持您想要使用的接口。
要访问 User
的第二页,每页大小为 20,你可以执行类似以下的操作:
PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));
ListPagingAndSortingRepository
提供了等效的方法,但它返回一个 List
,而 PagingAndSortingRepository
的方法返回一个 Iterable
。
除了查询方法之外,还可以使用查询推导来生成计数和删除查询。以下列表展示了一个推导计数查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long countByLastname(String lastname);
}
以下列表展示了一个派生删除查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long deleteByLastname(String lastname);
List<User> removeByLastname(String lastname);
}