核心概念

Spring Data Repository 抽象的核心接口是 Repository。它将要管理的域类以及域类的标识符类型作为类型参数。该接口主要用作标记接口,用于捕获要使用的类型,并帮助您发现继承此接口的接口。

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

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

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

Repository 接口暗示了一些保留方法,例如 findById(ID identifier),这些方法针对域类型标识符属性,无论其属性名是什么。有关更多信息,请参阅“定义查询方法”。

您可以使用 @Query 注解您的查询方法来提供自定义查询,如果名为 Id 的属性不指向标识符的话。走这条路很容易导致混淆,不鼓励这样做,因为如果 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

除了查询方法,还提供了用于 count 和 delete 查询的查询派生。以下列表显示了派生 count 查询的接口定义:

派生 Count 查询
interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}

以下列表显示了派生 delete 查询的接口定义:

派生 Delete 查询
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 实现

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