核心概念
Spring Data repository 抽象中的核心介面是 Repository
。它將要管理的領域類以及領域類的識別符號型別作為型別引數。這個介面主要作為一個標記介面,用於捕獲要使用的型別,並幫助您發現擴充套件此介面的其他介面。
Spring Data 將領域型別視為實體(entity),更具體地說是聚合(aggregate)。因此,您將在整個文件中看到“實體”一詞,它可以與“領域型別”或“聚合”互換使用。 正如您可能在引言中注意到的,它已經暗示了領域驅動設計(DDD)的概念。我們按照 DDD 的含義來考慮領域物件。領域物件具有識別符號(否則它們將是無識別符號的值物件),並且當使用某些模式訪問資料時,我們需要以某種方式引用這些識別符號。隨著我們討論 repository 和查詢方法,引用識別符號將變得更有意義。 |
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
。
repository 介面隱含了一些保留方法,例如 如果名為 |
我們還提供了特定於持久化技術的抽象,例如 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
。
除了查詢方法之外,還提供了 count 和 delete 查詢的派生。以下列表顯示了派生 count 查詢的介面定義:
interface UserRepository extends CrudRepository<User, Long> {
long countByLastname(String lastname);
}
以下列表顯示了派生 delete 查詢的介面定義:
interface UserRepository extends CrudRepository<User, Long> {
long deleteByLastname(String lastname);
List<User> removeByLastname(String lastname);
}
實體狀態檢測策略
下表描述了 Spring Data 提供的用於檢測實體是否是新的策略
@Id 屬性檢查(預設) |
預設情況下,Spring Data 檢查給定實體的識別符號屬性。如果識別符號屬性為 |
@Version 屬性檢查 |
如果存在使用 |
實現 Persistable |
如果實體實現了 注意:如果您使用 |
提供自定義 EntityInformation 實現 |
您可以透過建立模組特定 repository factory 的子類並覆蓋 |