核心概念

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

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

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

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);
}
扩展接口需要实际的存储模块支持。虽然本文档解释了总体方案,但请确保您的存储模块支持您想要使用的接口。

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

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