跳到主要内容
版本:5.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 提供等效的方法,但 CrudRepository 的方法返回 Iterable,而这些方法返回 List。

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 提供等效的方法,但 PagingAndSortingRepository 的方法返回 Iterable,而这些方法返回 List。

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

除了查询方法之外,还支持针对计数查询和删除查询的查询派生。以下清单展示了派生计数查询的接口定义:

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);
}

实体状态检测策略​

下表描述了 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。
备注

Cassandra 在插入数据时不提供生成标识符的手段。因此,实体必须与标识符值相关联。Spring Data 默认通过检查标识符来确定实体是否为新。如果您想使用审计,请务必使用乐观锁定,或实现 Persistable,以正确检测实体状态。