定义仓库接口

要定义仓库接口，首先需要定义特定于域类的仓库接口。该接口必须继承 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 list。

如果您的应用程序中的许多仓库应该具有相同的方法集，您可以定义自己的基础接口来继承。这样的接口必须使用 `@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 模块

  1. 如果仓库定义继承了模块特定的仓库，它是特定 Spring Data 模块的有效候选者。

  2. 如果域类使用了模块特定的类型注解进行标注，它是特定 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 { … }