核心概念

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

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

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

The CrudRepositoryListCrudRepository 接口为被管理的实体类提供了复杂的 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 属性的类型不同,您会很快遇到类型限制。

我们还提供了特定于持久化技术的抽象,例如 JpaRepositoryMongoRepository。这些接口扩展了 CrudRepository,并在 CrudRepository 等通用的、与持久化技术无关的接口之外,暴露了底层持久化技术的能力。

除了 CrudRepository,还有 PagingAndSortingRepositoryListPagingAndSortingRepository,它们添加了额外的方法,以便于对实体进行分页访问。

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.PROPERTYPersistable 的属性将被检测并持久化。为避免这种情况,请使用 @Transient

提供自定义的 EntityInformation 实现

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

Spring Data Commons