核心概念

Spring Data 儲存庫抽象化的核心介面是 Repository。它接受要管理的網域類別以及網域類別的識別符類型作為類型引數。此介面主要作為標記介面,用於捕獲要使用的類型,並幫助您發現擴展此介面的介面。

Spring Data 認為網域類型是實體,更具體來說是聚合。因此,您將在整個文件中看到術語「實體」,它可以與術語「網域類型」或「聚合」互換使用。

您可能已經注意到,簡介中已經暗示了網域驅動概念。我們從 DDD 的意義上考慮網域物件。網域物件具有識別符(否則這些將是無身分的值物件),並且當使用某些模式存取資料時,我們需要以某種方式引用識別符。當我們談論儲存庫和查詢方法時,引用識別符將變得更有意義。

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

儲存庫介面暗示了一些保留方法,例如 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

除了查詢方法之外,還可以使用查詢衍生來進行計數和刪除查詢。以下列表顯示了衍生計數查詢的介面定義

衍生計數查詢
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);
}

實體狀態偵測策略

下表描述了 Spring Data 為偵測實體是否為新實體提供的策略

表 1. Spring Data 中用於偵測實體是否為新實體的選項

@Id-屬性檢查(預設值)

預設情況下,Spring Data 會檢查給定實體的識別符屬性。如果識別符屬性為 null 或對於基本類型為 0,則假定實體為新實體。否則,假定它不是新實體。

@Version-屬性檢查

如果存在使用 @Version 註解的屬性且為 null,或者在基本類型版本屬性為 0 的情況下,則認為實體是新的。如果版本屬性存在但具有不同的值,則認為實體不是新的。如果不存在版本屬性,Spring Data 將回退到檢查識別符屬性。

實作 Persistable

如果實體實作了 Persistable,Spring Data 會將新實體偵測委派給實體的 isNew(…) 方法。請參閱 Javadoc 以取得詳細資訊。

注意:如果您使用 AccessType.PROPERTY,則將偵測並持久化 Persistable 的屬性。為避免這種情況,請使用 @Transient

提供自訂 EntityInformation 實作

您可以透過建立模組特定儲存庫工廠的子類別並覆寫 getEntityInformation(…) 方法來自訂在儲存庫基礎實作中使用的 EntityInformation 抽象。然後,您必須將模組特定儲存庫工廠的自訂實作註冊為 Spring Bean。請注意,這應該很少是必要的。