核心概念
在 Spring Data 儲存庫抽象化中的核心介面是 Repository
。它接受要管理的領域類別以及領域類別的識別符類型作為類型引數。此介面主要作為一個標記介面,用於捕獲要使用的類型,並幫助您發現擴展此介面的其他介面。
Spring Data 將領域類型視為實體,更具體來說是聚合。因此,您會在文件中看到術語「實體」,它可以與術語「領域類型」或「聚合」互換使用。 正如您可能在引言中注意到的,它已經暗示了領域驅動的概念。我們從 DDD 的意義上考慮領域物件。領域物件具有識別符(否則它們將是無身分的數值物件),並且在處理某些存取資料的模式時,我們需要以某種方式引用識別符。當我們談論儲存庫和查詢方法時,引用識別符將變得更有意義。 |
CrudRepository
和 ListCrudRepository
介面為正在管理的實體類別提供複雜的 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
。
儲存庫介面暗示了一些保留方法,例如 如果名為 `Id` 的屬性未引用識別符,您可以使用 `@Query` 註釋您的查詢方法以提供自訂查詢。遵循該路徑很容易導致混淆,並且不建議這樣做,因為如果 `ID` 類型和 `Id` 屬性的類型不同,您將很快遇到類型限制。 |
我們還提供特定於持久性技術的抽象,例如 `JpaRepository` 或 `MongoRepository`。這些介面擴展了 `CrudRepository`,除了更通用的與持久性技術無關的介面(如 `CrudRepository`)之外,還公開了底層持久性技術的功能。 |
除了 `CrudRepository` 之外,還有 PagingAndSortingRepository
和 ListPagingAndSortingRepository
,它們添加了額外的方法來簡化對實體的分頁存取
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);
}