定義倉庫介面

要定義一個倉庫介面，您首先需要定義一個特定於領域類的倉庫介面。該介面必須擴充套件 Repository 介面，並指定領域類和 ID 型別的泛型。如果您想為該領域型別暴露 CRUD 方法，您可以擴充套件 CrudRepository 或其變體之一，而不是 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。請注意，各種排序倉庫不再像 Spring Data 3.0 之前版本那樣擴充套件其各自的 CRUD 倉庫。因此，如果您需要兩者的功能，則需要同時擴充套件這兩個介面。

如果您不想擴充套件 Spring Data 介面，也可以使用 @RepositoryDefinition 註解您的倉庫介面。擴充套件其中一個 CRUD 倉庫介面將暴露一套完整的方法來操作您的實體。如果您希望有選擇地暴露方法，可以將您想暴露的方法從 CRUD 倉庫中複製到您的領域倉庫中。這樣做時，您可以更改方法的返回型別。如果可能，Spring Data 會尊重該返回型別。例如，對於返回多個實體的方法，您可以選擇 Iterable<T>、List<T>、Collection<T> 或 VAVR 列表。

如果應用程式中的許多倉庫應該擁有相同的方法集，您可以定義自己的基礎介面來繼承。此類介面必須使用 @NoRepositoryBean 註解。這會阻止 Spring Data 直接建立其例項，並避免因無法確定該倉庫的實體（因為它仍包含泛型型別變數）而失敗。

以下示例展示瞭如何有選擇地暴露 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);
}

在前面的示例中，您定義了一個所有領域倉庫的公共基礎介面，並暴露了 findById(…) 和 save(…) 方法。這些方法被路由到 Spring Data 提供的您選擇的儲存的基礎倉庫實現中（例如，如果您使用 JPA，實現是 SimpleJpaRepository），因為它們匹配 CrudRepository 中的方法簽名。因此，UserRepository 現在可以儲存使用者，按 ID 查詢單個使用者，並觸發按電子郵件地址查詢 Users 的查詢。

中間倉庫介面使用 @NoRepositoryBean 註解。請確保將該註解新增到所有 Spring Data 不應在執行時建立例項的倉庫介面上。

在使用多個 Spring Data 模組時使用倉庫

在應用程式中使用唯一的 Spring Data 模組很簡單，因為所有在定義範圍內的倉庫介面都繫結到該 Spring Data 模組。有時，應用程式需要使用多個 Spring Data 模組。在這種情況下，倉庫定義必須區分不同的持久化技術。當在類路徑中檢測到多個倉庫工廠時，Spring Data 會進入嚴格倉庫配置模式。嚴格配置使用倉庫或領域類上的詳細資訊來決定倉庫定義的 Spring Data 模組繫結

如果倉庫定義擴充套件特定於模組的倉庫介面，則它是該特定 Spring Data 模組的有效候選者。
如果領域類使用特定於模組的型別註解進行註解，則它是該特定 Spring Data 模組的有效候選者。Spring Data 模組既接受第三方註解（如 JPA 的 @Entity），也提供自己的註解（如 Spring Data MongoDB 和 Spring Data Elasticsearch 的 @Document）。

以下示例展示了一個使用特定於模組介面（本例中為 JPA）的倉庫

示例 1. 使用特定於模組介面的倉庫定義

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 模組的有效候選者。

以下示例展示了一個使用通用介面的倉庫

示例 2. 使用通用介面的倉庫定義

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 模組時這沒有問題，但多個模組無法區分這些倉庫應該繫結到哪個特定的 Spring Data 模組。

以下示例展示了一個使用帶有註解的領域類的倉庫

示例 3. 使用帶有註解的領域類的倉庫定義

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

@Entity
class Person { … }

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

@Document
class User { … }

PersonRepository 引用了 Person 類，該類使用 JPA 的 @Entity 註解進行註解，因此這個倉庫顯然屬於 Spring Data JPA。UserRepository 引用了 User 類，該類使用 Spring Data MongoDB 的 @Document 註解進行註解。

以下不良示例展示了一個使用帶有混合註解的領域類的倉庫

示例 4. 使用帶有混合註解的領域類的倉庫定義

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

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

@Entity
@Document
class Person { … }

這個示例展示了一個同時使用 JPA 和 Spring Data MongoDB 註解的領域類。它定義了兩個倉庫：JpaPersonRepository 和 MongoDBPersonRepository。一個用於 JPA，另一個用於 MongoDB。Spring Data 將無法區分這兩個倉庫，這會導致未定義的行為。

倉庫型別詳情和區分領域類註解用於嚴格倉庫配置，以識別特定 Spring Data 模組的倉庫候選者。在同一個領域型別上使用多個特定於持久化技術的註解是可能的，並且可以在多種持久化技術之間重用領域型別。然而，此時 Spring Data 將無法確定用於繫結該倉庫的唯一模組。

最後一種區分倉庫的方法是限定倉庫基礎包的範圍。基礎包定義了掃描倉庫介面定義的起始點，這意味著倉庫定義應位於適當的包中。預設情況下，註解驅動的配置使用配置類所在的包。XML 配置中的基礎包是強制性的。

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

註解驅動的基礎包配置

@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }