核心概念
Spring Data 存储库抽象中的核心接口是 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
。
我们还提供特定于持久化技术的抽象,例如 JpaRepository 或 MongoRepository 。这些接口扩展 CrudRepository 并在 CrudRepository 等相当通用的持久化技术无关接口之外公开底层持久化技术的 capabilities。
|
除了CrudRepository
,还有PagingAndSortingRepository
和ListPagingAndSortingRepository
,它们添加了额外的方法来简化对实体的分页访问。
PagingAndSortingRepository
接口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);
}