核心概念

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

Spring Data 將域型別視為實體,更確切地說是聚合。因此,您會看到文件中通篇使用“實體”一詞,它可以與“域型別”或“聚合”互換使用。

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

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

您可以使用 @Query 註解您的查詢方法來提供自定義查詢,如果名為 Id 的屬性不指向識別符號的話。走這條路很容易導致混淆,不鼓勵這樣做,因為如果 ID 型別和您的 Id 屬性型別不一致,您很快就會遇到型別限制。

我們還提供了特定於持久化技術的抽象,例如 JpaRepositoryMongoRepository。這些介面擴充套件了 CrudRepository,並且除了像 CrudRepository 這樣通用的與持久化技術無關的介面外,還暴露了底層持久化技術的能力。

除了 CrudRepository 外,還有 PagingAndSortingRepositoryListPagingAndSortingRepository,它們添加了額外的方法以方便對實體進行分頁訪問。

PagingAndSortingRepository 介面
public interface PagingAndSortingRepository<T, ID>  {

  Iterable<T> findAll(Sort sort);

  Page<T> findAll(Pageable pageable);
}
擴充套件介面是否受實際儲存模組支援。雖然本文件解釋了一般方案,但請確保您的儲存模組支援您想要使用的介面。

要訪問 User 的第二頁,每頁大小為 20,您可以執行以下操作:

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