跳到主要内容

核心概念

ChatGPT-4o-mini 中英对照 Core concepts

Spring Data 仓库抽象中的核心接口是 Repository。它接受作为类型参数的领域类及其标识符类型。此接口主要作为标记接口，用于捕获要处理的类型，并帮助您发现扩展此接口的接口。

提示

Spring Data 将领域类型视为实体，更具体地说是聚合。因此，您将在文档中看到“实体”一词，它可以与“领域类型”或“聚合”互换使用。

正如您在介绍中可能已经注意到的，它已经暗示了领域驱动设计（DDD）的概念。我们从 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
备注

扩展接口需由实际的 store 模块支持。虽然本文档解释了通用方案，但请确保您的 store 模块支持您想要使用的接口。

要通过页面大小为 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。请注意，这通常不需要。