跳到主要内容

核心概念

QWen Flash 中英对照 Core concepts

Spring Data 仓储抽象的核心接口是 Repository。它接受要管理的领域类以及领域类的标识符类型作为类型参数。该接口主要充当标记接口,用于捕获要处理的类型,并帮助你发现扩展此接口的其他接口。

提示

Spring Data 将 domain types 视为 entities,更具体地说是 aggregates。因此你会在文档中看到 term "entity",它可以与 term "domain type" 或 "aggregate" 互换使用。

正如你可能在 introduction 中注意到的那样,它已经暗示了 domain-driven 概念。我们按 DDD 的含义来考虑 domain objects。domain objects 有 identifiers(否则这些就是 identity-less value objects),并且在使用某些 patterns 访问数据时,我们总归需要 refer to identifiers。当我们谈到 repositories 和 query methods 时,refer to identifiers 将变得更有意义。

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),它们会针对领域类型的标识属性,而不管该属性的名称是什么。可在“Defining Query Methods”中阅读更多相关内容。

如果名为 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);
}
备注

Extension interfaces 需要由实际的 store module 支持。虽然本文档说明了通用方案,但请确保你的 store module 支持你要使用的接口。

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

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

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

除了 pagination 之外,scrolling 提供了更细粒度的访问方式,用于迭代较大数据集的块。

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

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。