核心概念
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
提供了与 PagingAndSortingRepository
类似的方法,但返回的是一个 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);
}