跳到主要内容
版本:4.1.1

核心概念

Doubao 中英对照 Core concepts

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。

important

仓库接口隐含了一些保留方法,例如 findById(ID identifier),它们针对领域类型标识符属性,而不管其属性名是什么。请参阅“定义查询方法”了解更多信息。

如果名为 Id 的属性并不指向标识符,你可以用 @Query 注解你的查询方法以提供自定义查询。走这条路很容易导致混淆,并且不建议这样做,因为如果 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);
}
备注

扩展接口是否受支持取决于实际的存储模块。虽然本文档解释了通用方案,但请确保你使用的存储模块支持你想使用的接口。

要按每页 20 条的大小访问 User 的第二页,你可以这样做:

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

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

除了分页之外,滚动(scrolling)提供了一种更细粒度的访问方式,用于遍历较大结果集的数据块。

除了查询方法之外,还支持 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 为检测实体是否为新实体而提供的策略:

表 1. Spring Data 中检测实体是否为新实体的选项

@Id-属性检查(默认)默认情况下,Spring Data 会检查给定实体的标识符属性。如果标识符属性为 null,或者对于原始类型为 0,则认为该实体是新的。否则,认为它不是新的。
@Version-属性检查如果存在标注了 @Version 的属性且其为 null,或者对于原始类型的版本属性为 0,则认为该实体是新的。如果版本属性存在但具有不同的值,则认为该实体不是新的。如果不存在版本属性,Spring Data 会回退到检查标识符属性。
实现 Persistable如果实体实现了 Persistable,Spring Data 会将新实体检测委托给实体的 isNew(…) 方法。详情请参阅 Javadoc。

注意:如果你使用 AccessType.PROPERTY,Persistable 的属性将被检测并持久化。要避免这种情况,请使用 @Transient。