核心概念
Spring Data repository 抽象中的核心接口是 Repository
。它将要管理的领域类以及领域类的标识符类型作为类型参数。这个接口主要作为一个标记接口,用于捕获要使用的类型,并帮助您发现扩展此接口的其他接口。
Spring Data 将领域类型视为实体(entity),更具体地说是聚合(aggregate)。因此,您将在整个文档中看到“实体”一词,它可以与“领域类型”或“聚合”互换使用。 正如您可能在引言中注意到的,它已经暗示了领域驱动设计(DDD)的概念。我们按照 DDD 的含义来考虑领域对象。领域对象具有标识符(否则它们将是无标识符的值对象),并且当使用某些模式访问数据时,我们需要以某种方式引用这些标识符。随着我们讨论 repository 和查询方法,引用标识符将变得更有意义。 |
CrudRepository
和 ListCrudRepository
接口为所管理的实体类提供了复杂的 CRUD 功能。
CrudRepository
接口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.
}
1 | 保存给定的实体。 |
2 | 返回由给定 ID 标识的实体。 |
3 | 返回所有实体。 |
4 | 返回实体的数量。 |
5 | 删除给定的实体。 |
6 | 指示具有给定 ID 的实体是否存在。 |
此接口中声明的方法通常称为 CRUD 方法。ListCrudRepository
提供了等效的方法,但它们返回 List
,而 CrudRepository
方法返回 Iterable
。
repository 接口隐含了一些保留方法,例如 如果名为 |
我们还提供了特定于持久化技术的抽象,例如 JpaRepository 或 MongoRepository 。这些接口扩展了 CrudRepository ,除了像 CrudRepository 这样通用的与持久化技术无关的接口之外,它们还暴露了底层持久化技术的能力。 |
除了 CrudRepository
,还有 PagingAndSortingRepository
和 ListPagingAndSortingRepository
,它们增加了额外的方法,以便于对实体进行分页访问。
PagingAndSortingRepository
接口public interface PagingAndSortingRepository<T, ID> {
Iterable<T> findAll(Sort sort);
Page<T> findAll(Pageable pageable);
}
扩展接口需要由实际的存储模块支持。本文档解释了通用方案,但请确保您的存储模块支持您想要使用的接口。 |
要以每页 20 个项目的大小访问 User
的第二页,您可以这样做:
PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));
ListPagingAndSortingRepository
提供了等效的方法,但它返回一个 List
,而 PagingAndSortingRepository
方法返回一个 Iterable
。
除了查询方法之外,还提供了 count 和 delete 查询的派生。以下列表显示了派生 count 查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long countByLastname(String lastname);
}
以下列表显示了派生 delete 查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long deleteByLastname(String lastname);
List<User> removeByLastname(String lastname);
}
实体状态检测策略
下表描述了 Spring Data 提供的用于检测实体是否是新的策略
@Id 属性检查(默认) |
默认情况下,Spring Data 检查给定实体的标识符属性。如果标识符属性为 |
@Version 属性检查 |
如果存在使用 |
实现 Persistable |
如果实体实现了 注意:如果您使用 |
提供自定义 EntityInformation 实现 |
您可以通过创建模块特定 repository factory 的子类并覆盖 |