Core concepts

Spring Data 存储库抽象中的中心接口是 Repository。它取管理的领域类以及作为类型参数的领域类的标识符类型。此接口主要充当标记接口,用于捕获要处理的类型,并帮助你发现扩展此接口的接口。https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/CrudRepository.html[CrudRepository] 和 ListCrudRepository 接口提供被管理的实体类的复杂 CRUD 功能。

CrudRepository Interface
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 Saves the given entity.
2 返回由给定 ID 标识的实体。
3 Returns all entities.
4 返回实体的数量。
5 Deletes the given entity.
6 指示是否存在一个具有给定 ID 的实体。

在此接口中声明的方法通常称为 CRUD 方法。ListCrudRepository 提供等效方法,但它们在 CrudRepository 方法返回 Iterable 的位置返回 List

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

除了 CrudRepository 之外,还有 PagingAndSortingRepositoryListPagingAndSortingRepository,它们添加了更多方法,可以轻松地对实体进行分页访问:

PagingAndSortingRepository interface
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

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

Derived Count Query
interface UserRepository extends CrudRepository<User, Long> {

  long countByLastname(String lastname);
}

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

Derived Delete Query
interface UserRepository extends CrudRepository<User, Long> {

  long deleteByLastname(String lastname);

  List<User> removeByLastname(String lastname);
}

Entity State Detection Strategies

  • @Id-Property 检查(默认):如果实体的 ID 属性为 null 或 0(对于基本类型),则实体被认为是新的。

  • @Version-Property 检查:如果带有 @Version 注释的属性存在且为 null,或者对于基本类型的版本属性为 0,则实体被认为是新的。

  • 实现 Persistable:如果实体实现了 Persistable,Spring Data 将委托新检测到实体的 isNew(…​) 方法。

  • 提供自定义 EntityInformation 实现:通过创建模块特定存储库工厂的子类并覆盖 getEntityInformation(…​) 方法,可以自定义存储库基本实现中使用的 EntityInformation 抽象。

下表描述了 Spring Data 提供的策略,用于检测实体是否新创建:

Table 1. Options for detection whether an entity is new in Spring Data

@Id-Property inspection (the default)

默认情况下,Spring Data 将检查给定实体的标识符属性。如果标识符属性对于基本类型为 null0,那么该实体将被视为新的。否则,它将被视为不是新的。

@Version-Property inspection

如果存在带 @Version 注释的属性,并且为 null,或者在版本属性为基本类型 0 的情况下,该实体将被视为新的。如果版本属性存在但具有不同的值,则将该实体视为不是新的。如果不存在版本属性,则 Spring Data 将回退到检查标识符属性。

Implementing Persistable

如果实体实现了 Persistable,Spring Data 会将新检测委托给实体的 isNew(…)`方法。有关详细信息,请参阅 JavadocNote: Properties of `Persistable will get detected and persisted if you use AccessType.PROPERTY. To avoid that, use @Transient.

提供自定义 EntityInformation 实现

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