定義 Repository 介面

若要定義 repository 介面，您首先需要定義一個特定於網域類別的 repository 介面。該介面必須擴充 Repository，並輸入網域類別和 ID 類型。如果您想要為該網域類型公開 CRUD 方法，您可以擴充 CrudRepository 或其變體之一，而不是 Repository。

微調 Repository 定義

有幾種變體可以開始使用您的 repository 介面。

典型方法是擴充 CrudRepository，它為您提供 CRUD 功能的方法。CRUD 代表 Create、Read、Update、Delete。在 3.0 版本中，我們還引入了 ListCrudRepository，它與 CrudRepository 非常相似，但對於那些傳回多個實體的方法，它傳回 List 而不是 Iterable，您可能會發現它更容易使用。

如果您正在使用反應式儲存區，您可以選擇 ReactiveCrudRepository 或 RxJava3CrudRepository，具體取決於您正在使用的反應式框架。

如果您正在使用 Kotlin，您可以選擇 CoroutineCrudRepository，它利用了 Kotlin 的協程。

此外，如果您需要允許指定 Sort 抽象或在第一種情況下指定 Pageable 抽象的方法，您可以擴充 PagingAndSortingRepository、ReactiveSortingRepository、RxJava3SortingRepository 或 CoroutineSortingRepository。請注意，各種排序 repository 不再像 Spring Data 3.0 之前的版本那樣擴充它們各自的 CRUD repository。因此，如果您想要同時具備兩者的功能，則需要同時擴充這兩個介面。

如果您不想擴充 Spring Data 介面，您也可以使用 @RepositoryDefinition 註解您的 repository 介面。擴充其中一個 CRUD repository 介面會公開一整套方法來操作您的實體。如果您希望有選擇性地公開要公開的方法，請從 CRUD repository 將您想要公開的方法複製到您的網域 repository 中。這樣做時，您可以變更方法的傳回類型。如果可能，Spring Data 將會遵守傳回類型。例如，對於傳回多個實體的方法，您可以選擇 Iterable<T>、List<T>、Collection<T> 或 VAVR 清單。

如果您的應用程式中的許多 repository 應該具有相同的方法集，您可以定義自己的基礎介面來繼承。此類介面必須使用 @NoRepositoryBean 註解。這可以防止 Spring Data 嘗試直接建立它的實例，並因無法判斷該 repository 的實體而失敗，因為它仍然包含泛型類型變數。

以下範例顯示如何有選擇性地公開 CRUD 方法 (在本例中為 findById 和 save)

有選擇性地公開 CRUD 方法
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends Repository<T, ID> {

  Optional<T> findById(ID id);

  <S extends T> S save(S entity);
}

interface UserRepository extends MyBaseRepository<User, Long> {
  User findByEmailAddress(EmailAddress emailAddress);
}

在先前的範例中，您為所有網域 repository 定義了一個共用的基礎介面，並公開了 findById(…) 以及 save(…)。這些方法會路由到 Spring Data 提供的您選擇的儲存區的基礎 repository 實作 (例如，如果您使用 JPA，則實作是 SimpleJpaRepository)，因為它們符合 CrudRepository 中的方法簽章。因此，UserRepository 現在可以儲存使用者、依 ID 尋找個別使用者，並觸發查詢以依電子郵件地址尋找 Users。

中繼 repository 介面使用 @NoRepositoryBean 註解。請確保將該註解新增至所有 Spring Data 不應在執行階段建立實例的 repository 介面。

將 Repository 與多個 Spring Data 模組搭配使用

在您的應用程式中使用唯一的 Spring Data 模組使事情變得簡單，因為已定義範圍內的所有 repository 介面都繫結到 Spring Data 模組。有時，應用程式需要使用多個 Spring Data 模組。在這種情況下，repository 定義必須區分持久性技術。當它偵測到類別路徑上有多個 repository 工廠時，Spring Data 會進入嚴格的 repository 組態模式。嚴格組態使用 repository 或網域類別的詳細資訊來決定 repository 定義的 Spring Data 模組繫結

  1. 如果 repository 定義 擴充了模組特定的 repository，則它是特定 Spring Data 模組的有效候選者。

  2. 如果網域類別使用 模組特定的類型註解進行註解，則它是特定 Spring Data 模組的有效候選者。Spring Data 模組接受第三方註解 (例如 JPA 的 @Entity) 或提供自己的註解 (例如 Spring Data MongoDB 和 Spring Data Elasticsearch 的 @Document)。

以下範例顯示了一個使用模組特定介面 (在本例中為 JPA) 的 repository

範例 1. 使用模組特定介面的 Repository 定義
interface MyRepository extends JpaRepository<User, Long> { }

@NoRepositoryBean
interface MyBaseRepository<T, ID> extends JpaRepository<T, ID> { … }

interface UserRepository extends MyBaseRepository<User, Long> { … }

MyRepository 和 UserRepository 在其類型階層中擴充了 JpaRepository。它們是 Spring Data JPA 模組的有效候選者。

以下範例顯示了一個使用泛型介面的 repository

範例 2. 使用泛型介面的 Repository 定義
interface AmbiguousRepository extends Repository<User, Long> { … }

@NoRepositoryBean
interface MyBaseRepository<T, ID> extends CrudRepository<T, ID> { … }

interface AmbiguousUserRepository extends MyBaseRepository<User, Long> { … }

AmbiguousRepository 和 AmbiguousUserRepository 在其類型階層中僅擴充了 Repository 和 CrudRepository。雖然在使用唯一的 Spring Data 模組時這很好，但多個模組無法區分這些 repository 應該繫結到哪個特定的 Spring Data。

以下範例顯示了一個使用帶有註解的網域類別的 repository

範例 3. 使用帶有註解的網域類別的 Repository 定義
interface PersonRepository extends Repository<Person, Long> { … }

@Entity
class Person { … }

interface UserRepository extends Repository<User, Long> { … }

@Document
class User { … }

PersonRepository 參考了使用 JPA @Entity 註解進行註解的 Person，因此此 repository 明顯屬於 Spring Data JPA。UserRepository 參考了使用 Spring Data MongoDB 的 @Document 註解進行註解的 User。

以下不良範例顯示了一個使用帶有混合註解的網域類別的 repository

範例 4. 使用帶有混合註解的網域類別的 Repository 定義
interface JpaPersonRepository extends Repository<Person, Long> { … }

interface MongoDBPersonRepository extends Repository<Person, Long> { … }

@Entity
@Document
class Person { … }

此範例顯示了一個同時使用 JPA 和 Spring Data MongoDB 註解的網域類別。它定義了兩個 repository，JpaPersonRepository 和 MongoDBPersonRepository。一個用於 JPA，另一個用於 MongoDB 用途。Spring Data 無法再區分這些 repository，這會導致未定義的行為。

Repository 類型詳細資訊 和 區分網域類別註解 用於嚴格的 repository 組態，以識別特定 Spring Data 模組的 repository 候選者。在同一個網域類型上使用多個持久性技術特定的註解是可能的，並且可以跨多個持久性技術重複使用網域類型。但是，Spring Data 無法再判斷要與之繫結 repository 的唯一模組。

區分 repository 的最後一種方法是透過設定 repository 基礎套件的範圍。基礎套件定義了掃描 repository 介面定義的起點，這表示 repository 定義位於適當的套件中。預設情況下，註解驅動的組態使用組態類別的套件。基於 XML 的組態中的基礎套件 是強制性的。

以下範例顯示了基礎套件的註解驅動組態

基礎套件的註解驅動組態
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }