核心概念

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

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

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

The CrudRepository and 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 介面隱含了一些保留方法,例如 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);
}
擴充套件介面需要由實際的儲存模組支援。雖然本文件解釋了一般方案,但請確保您的儲存模組支援您想要使用的介面。

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