定義 Repository 介面

要定義 repository 介面，首先需要定義一個特定於領域類的 repository 介面。該介面必須繼承 Repository，並且需要指定領域類和 ID 型別。如果你想為該領域型別暴露 CRUD 方法，可以繼承 CrudRepository 或其變體之一，而不是 Repository。

微調 Repository 定義

有幾種方法可以開始定義你的 repository 介面。

典型的方法是繼承 CrudRepository，它提供了 CRUD 功能的方法。CRUD 代表建立（Create）、讀取（Read）、更新（Update）、刪除（Delete）。從 3.0 版本開始，我們還引入了 ListCrudRepository，它與 CrudRepository 非常相似，但對於那些返回多個實體的方法，它返回 List 而不是 Iterable，你可能會覺得 List 更易於使用。

如果你正在使用響應式儲存，可以根據所使用的響應式框架選擇 ReactiveCrudRepository 或 RxJava3CrudRepository。

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

此外，如果你需要允許指定 Sort 抽象或（對於第一個）Pageable 抽象的方法，可以繼承 PagingAndSortingRepository、ReactiveSortingRepository、RxJava3SortingRepository 或 CoroutineSortingRepository。請注意，與 Spring Data 3.0 版本之前不同，各種排序 repository 不再繼承其各自的 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 介面上。

在多個 Spring Data 模組中使用 Repository

在應用程式中使用單一 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）。

以下示例展示了使用特定於模組介面的 repository（在本例中是 JPA）

示例 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 引用了 Person，它使用了 JPA 的 @Entity 註解，因此這個 repository 顯然屬於 Spring Data JPA。UserRepository 引用了 User，它使用了 Spring Data MongoDB 的 @Document 註解。

以下糟糕的示例展示了使用帶有混合註解的領域類的 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 基礎包（base package）。基礎包定義了掃描 repository 介面定義的起點，這意味著 repository 定義應位於適當的包中。預設情況下，註解驅動的配置使用配置類的包。而基於 XML 的配置中的基礎包是強制性的。

以下示例展示了註解驅動的基礎包配置

註解驅動的基礎包配置
@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }