核心概念

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

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

正如您可能在引言中注意到的,它已經暗示了領域驅動設計(DDD)的概念。我們按照 DDD 的含義來考慮領域物件。領域物件具有識別符號(否則它們將是無識別符號的值物件),並且當使用某些模式訪問資料時,我們需要以某種方式引用這些識別符號。隨著我們討論 repository 和查詢方法,引用識別符號將變得更有意義。

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);
}

實體狀態檢測策略

下表描述了 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 factory 的子類並覆蓋 getEntityInformation(…) 方法來自定義 repository 基礎實現中使用的 EntityInformation 抽象。然後,您必須將模組特定 repository factory 的自定義實現註冊為 Spring bean。請注意,這很少是必需的。

Cassandra 不提供在插入資料時生成識別符號的方法。因此,實體必須與識別符號值相關聯。Spring Data 預設使用識別符號檢查來確定實體是否為新的。如果您想使用審計,請務必使用樂觀鎖或實現 Persistable 來進行正確的實體狀態檢測。