核心概念

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

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

正如您在引言中可能已经注意到的那样,它已经暗示了领域驱动设计 (DDD) 的概念。我们从 DDD 的角度考虑领域对象。领域对象具有标识符(否则它们将是无标识符的值对象),并且在使用某些模式访问数据时,我们需要以某种方式引用标识符。当我们讨论仓库和查询方法时,引用标识符将变得更有意义。

`CrudRepository``ListCrudRepository` 接口为正在管理的实体类提供了复杂的 CRUD 功能。

`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` 方法返回 `Iterable`。

仓库接口隐含了一些保留方法,例如 `findById(ID identifier)`,它针对领域类型标识符属性,而不管其属性名称如何。有关此内容的更多信息,请阅读“定义查询方法”。

如果名为 `Id` 的属性没有引用标识符,您可以使用 `@Query` 注解您的查询方法以提供自定义查询。遵循此路径很容易导致混淆,并且不建议这样做,因为如果 `ID` 类型和 `Id` 属性的类型不同,您很快就会遇到类型限制。

我们还提供特定于持久化技术的抽象,例如 `JpaRepository` 或 `MongoRepository`。这些接口扩展了 `CrudRepository`,除了相当通用的与持久化技术无关的接口(例如 `CrudRepository`)之外,还公开了底层持久化技术的 capabilities。

除了 `CrudRepository` 之外,还有 `PagingAndSortingRepository``ListPagingAndSortingRepository`,它们添加了其他方法以简化对实体的分页访问。

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

  Iterable<T> findAll(Sort sort);

  Page<T> findAll(Pageable pageable);
}
扩展接口必须受实际存储模块的支持。虽然本文档解释了总体方案,但请确保您的存储模块支持您想要使用的接口。

要按 20 的页面大小访问 `User` 的第二页,您可以执行以下操作:

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

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

除了查询方法外,还可用于计数和删除查询的查询派生。以下列表显示了派生计数查询的接口定义:

派生计数查询
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

提供自定义的EntityInformation实现

您可以通过创建模块特定存储库工厂的子类并覆盖getEntityInformation(…)方法来自定义存储库基础实现中使用的EntityInformation抽象。然后,您必须将模块特定存储库工厂的自定义实现注册为Spring Bean。请注意,这很少需要。