跳到主要内容

核心概念

ChatGPT-4o-mini 中英对照 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.
}
java

  • 保存给定的实体。

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

  • 返回所有实体。

  • 返回实体的数量。

  • 删除给定的实体。

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

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

important

该仓库接口暗示了一些保留方法，例如 findById(ID identifier)，它们针对域类型的标识符属性，无论其属性名称是什么。有关更多信息，请参阅“定义查询方法”。

如果名为 Id 的属性不指代标识符，您可以使用 @Query 注解您的查询方法以提供自定义查询。遵循该路径可能会导致混淆，并且不建议这样做，因为如果 ID 类型和您的 Id 属性的类型不一致，您将很快遇到类型限制。

备注

我们还提供特定于持久性技术的抽象，例如 JpaRepository 或 MongoRepository。这些接口扩展了 CrudRepository，并在相对通用的与持久性技术无关的接口（如 CrudRepository）之外，暴露了底层持久性技术的能力。

除了 CrudRepository，还有 PagingAndSortingRepository 和 ListPagingAndSortingRepository，它们增加了额外的方法，以便更方便地进行分页访问实体：

public interface PagingAndSortingRepository<T, ID>  {

  Iterable<T> findAll(Sort sort);

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

扩展接口的支持取决于实际的存储模块。虽然本文件解释了通用方案，但请确保您的存储模块支持您想要使用的接口。

要通过每页 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。

除了查询方法，计数和删除查询的查询派生也可用。以下列表显示了派生计数查询的接口定义：

interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}
java

以下列表显示了派生删除查询的接口定义：

interface UserRepository extends CrudRepository<User, Long> {

  long deleteByLastname(String lastname);

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

实体状态检测策略​

下表描述了 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。
提供自定义的 EntityInformation 实现你可以通过创建特定模块的仓库工厂的子类，并重写 getEntityInformation(…) 方法，来自定义仓库基础实现中使用的 EntityInformation 抽象。然后，你需要将特定模块仓库工厂的自定义实现注册为 Spring Bean。请注意，这通常是不必要的。
备注

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