核心概念

Spring Data Repository 抽象的核心介面是 Repository。它將要管理的域類及其識別符號型別作為型別引數。此介面主要用作標記介面,用於捕獲要使用的型別,並幫助您發現擴充套件此介面的其他介面。

Spring Data 將域型別視為實體,更具體地說是聚合。因此,您將在整個文件中看到術語“entity”,它可以與“domain type”或“aggregate”互換使用。

正如您在引言中可能已經注意到的那樣,它已經暗示了領域驅動的概念。我們在 DDD 的意義上考慮域物件。域物件具有識別符號(否則它們將是無身份的值物件),並且在使用某些模式訪問資料時,我們需要以某種方式引用識別符號。當我們討論 repositories 和 query methods 時,引用識別符號將變得更有意義。

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),它們針對域型別識別符號屬性,無論其屬性名稱是什麼。有關此內容的更多資訊,請參閱“定義查詢方法”。

如果名為 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

除了查詢方法,還提供了 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);
}