核心概念

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

Spring Data 將領域型別視為實體,更具體地說,是聚合。因此,您將在整個文件中看到 "實體" 這個術語,它可以與 "領域型別" 或 "聚合" 互換使用。

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

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