跳到主要内容

核心概念

QWen Flash 中英对照 Core concepts

Spring Data repository abstraction 中的核心接口是 Repository。它将需要管理的领域类以及领域类的标识符类型作为类型参数。该接口主要作为标记接口,用于捕获要处理的类型,并帮助你发现扩展该接口的其他接口。

提示

Spring Data 将领域类型视为实体,更具体地说,是聚合。因此,你会在文档中看到 "entity" 一词,它可与 "domain type" 或 "aggregate" 互换使用。

你可能在介绍中已经注意到,它已经暗示了领域驱动概念。我们从 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.
}
java
  • 保存给定实体。

  • 返回由给定 ID 标识的实体。

  • 返回所有实体。

  • 返回实体数量。

  • 删除给定实体。

  • 指示具有给定 ID 的实体是否存在。

此接口中声明的方法通常被称为 CRUD 方法。ListCrudRepository 提供了等效的方法,但它们返回 List,而 CrudRepository 的方法返回 Iterable。

important

Repository 接口隐含了一些保留方法,例如 findById(ID identifier),这些方法针对领域类型的标识符属性,而不论其属性名称是什么。更多相关信息,请参阅“定义查询方法”。

你可以使用 @Query 注解查询方法,以便在名为 Id 的属性并不指代标识符时提供自定义查询。遵循这种方式很容易造成混淆,并且不建议这样做,因为如果 ID 类型与你的 Id 属性类型不一致,你很快就会遇到类型限制。

备注

我们还提供特定于持久化技术的抽象,例如 JpaRepository 或 MongoRepository。这些接口继承自 CrudRepository,除了像 CrudRepository 这样相当通用的、与持久化技术无关的接口之外,还暴露底层持久化技术的功能。

除了 CrudRepository 之外,还有 PagingAndSortingRepository 和 ListPagingAndSortingRepository,它们提供了额外的方法,以简化对实体的分页访问:

interface PagingAndSortingRepository<T, ID> extends Repository<T, ID> {

Iterable<T> findAll(Sort sort);

Page<T> findAll(Pageable pageable);
}
java
备注

Extension interfaces 需要由实际的 store module 提供支持。虽然本文档介绍了通用方案,请确保你的 store module 支持你希望使用的 interfaces。

要以 20 的页面大小访问 User 的第二页,你可以执行类似以下操作:

PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));
java

ListPagingAndSortingRepository 提供了等效方法,但返回 List,而 PagingAndSortingRepository 的方法返回 Iterable。

除了 pagination 之外,scrolling 提供了更细粒度的访问方式,用于遍历较大的 result sets 中的 chunks。

除了 query methods 之外,count 和 delete queries 也支持 query derivation。以下列表展示了 derived count query 的 interface definition:

interface UserRepository extends CrudRepository<User, Long> {

long countByLastname(String lastname);
}
java

以下代码清单显示了 derived delete query 的接口定义:

interface UserRepository extends CrudRepository<User, Long> {

long deleteByLastname(String lastname);

List<User> removeByLastname(String lastname);
}
java