跳到主要内容

核心概念

DeepSeek V3 中英对照 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
备注

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

要访问 User 的第二页，每页大小为 20，你可以执行如下操作：

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。请注意，这通常很少需要。 |