核心概念

Spring Data 仓库抽象中的核心接口是 Repository。 它以要管理的领域类及其标识符类型作为泛型参数。 该接口主要用作标记接口,用于捕获要操作的类型,并帮助你发现继承此接口的其他接口。spring-doc.cadn.net.cn

Spring Data 将领域类型视为实体,更具体地说是聚合(aggregate)。 因此,在整个文档中您会看到“实体”这一术语,它可以与“领域类型”或“聚合”互换使用。spring-doc.cadn.net.cn

正如你在引言中可能已经注意到的,其中已经暗示了领域驱动设计(DDD)的相关概念。 我们这里所说的领域对象,正是从 DDD 的角度来理解的。 领域对象具有标识符(否则它们就是无标识的值对象),当我们使用某些数据访问模式时,需要以某种方式引用这些标识符。 随着我们后续讨论仓储(repositories)和查询方法(query methods),引用标识符的意义将变得更加明确。spring-doc.cadn.net.cn

The CrudRepositoryListCrudRepository 接口为正在管理的实体类提供了高级的 CRUD 功能。spring-doc.cadn.net.cn

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 的方法返回的是 Iterablespring-doc.cadn.net.cn

该仓库接口隐含了一些保留方法,例如 findById(ID identifier),这些方法会针对领域类型的标识符属性,而不管该属性的实际名称是什么。 更多相关内容请参阅“定义查询方法”。spring-doc.cadn.net.cn

如果名为 @Query 的属性并非指代标识符,你可以使用 Id 注解为查询方法提供自定义查询。 这种做法很容易引起混淆,因此不建议采用,因为一旦 ID 类型与你的 Id 属性类型不一致,你很快就会遇到类型限制问题。spring-doc.cadn.net.cn

我们还提供了特定于持久化技术的抽象接口,例如 JpaRepositoryMongoRepository。 这些接口扩展了 CrudRepository,除了提供像 CrudRepository 这样较为通用的、与具体持久化技术无关的接口之外,还暴露了底层持久化技术自身的能力。

除了 CrudRepository 之外,还有 PagingAndSortingRepositoryListPagingAndSortingRepository,它们添加了额外的方法以简化对实体的分页访问:spring-doc.cadn.net.cn

PagingAndSortingRepository 接口
public interface PagingAndSortingRepository<T, ID>  {

  Iterable<T> findAll(Sort sort);

  Page<T> findAll(Pageable pageable);
}
扩展接口是否受支持取决于实际的存储模块。 尽管本文档说明了通用方案,但请确保您所使用的存储模块支持您想要使用的接口。

要以每页 20 条的分页大小访问 User 的第二页,你可以执行类似如下的操作:spring-doc.cadn.net.cn

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

ListPagingAndSortingRepository 提供了等效的方法,但返回的是 List,而 PagingAndSortingRepository 的方法返回的是 Iterablespring-doc.cadn.net.cn

除了分页之外,滚动(scrolling)还提供了更细粒度的访问方式,用于遍历大型结果集中的数据块。spring-doc.cadn.net.cn

除了查询方法之外,还可以为计数(count)和删除(delete)查询生成派生查询。 以下列表展示了派生计数查询的接口定义:spring-doc.cadn.net.cn

派生计数查询
interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}

以下代码清单展示了派生删除查询的接口定义:spring-doc.cadn.net.cn

派生的删除查询
interface UserRepository extends CrudRepository<User, Long> {

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}

实体状态检测策略

下表描述了 Spring Data 提供的用于检测实体是否为新实体的策略:spring-doc.cadn.net.cn

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

@Id 属性检查(默认)spring-doc.cadn.net.cn

默认情况下,Spring Data 会检查给定实体的标识符属性。 如果该标识符属性为 null,或者在基本类型的情况下为 0,则认为该实体是新建的。 否则,则认为该实体不是新建的。spring-doc.cadn.net.cn

@Version 属性检查spring-doc.cadn.net.cn

如果存在一个带有 @Version 注解的属性,并且其值为 null,或者对于基本类型(primitive type)的版本属性其值为 0,则该实体被视为新实体。 如果存在版本属性但其值不为上述情况,则该实体被视为非新实体。 如果没有版本属性,Spring Data 将回退到检查标识符(identifier)属性。spring-doc.cadn.net.cn

实现 Persistablespring-doc.cadn.net.cn

如果一个实体实现了 Persistable 接口,Spring Data 会将新实体的检测委托给该实体的 isNew(…) 方法。 详见 Javadocspring-doc.cadn.net.cn

注意:如果你使用 PersistableAccessType.PROPERTY 的属性将被检测并持久化。 为避免这种情况,请使用 @Transientspring-doc.cadn.net.cn

Cassandra 在插入数据时无法自动生成标识符。 因此,实体必须关联标识符值。 Spring Data 默认通过检查标识符来判断一个实体是否为新实体。 如果你想使用审计(auditing)功能,请确保使用乐观锁(Optimistic Locking),或者实现Persistable接口,以正确检测实体的状态。