【Spring连载】使用Spring Data的Repositories----定义Repository接口

【Spring连载】使用Spring Data的Repositories----定义Repository接口

• 一、微调Repository定义
• [二、使用多个Spring Data模块的Repositories](#二、使用多个Spring Data模块的Repositories)

要定义repository接口，首先需要定义特定于域（domain）类的repository接口。接口必须继承Repository，并且类型为域类和ID类型。如果你想公开该域类型的CRUD方法，可以继承CrudRepository或其变体之一，而不是Repository。

一、微调Repository定义

有几种变体可以帮助你开始使用repository接口。

典型的方法是继承CrudRepository，它为你提供了CRUD功能的方法。CRUD代表创建、读取、更新、删除。在3.0版本中，框架还引入了ListCrudRepository，它与CrudRepository非常相似，但对于那些返回多个实体的方法，它返回的是List，而不是Iterable，你可能会发现它更容易使用。

如果你使用的是反应式（reactive ）存储，根据你使用的反应式框架，你可以选择ReactiveCrudRepository或RxJava3CrudRepository。

如果你正在使用Kotlin，您可以选择利用Kotlin协程的CoroutineCrudRepository。

此外，如果你需要允许指定排序抽象的方法，或者在第一种情况下是可分页抽象，则可以继承PagingAndSortingRepository、ReactiveSortingRepository、RxJava3SortingRepository或CoroutineSortingRepository。请注意，各种排序存储库不再像在Spring Data Versions 3.0之前那样扩展各自的CRUD repository。因此，如果您想要两个接口的功能，就需要继承这两个接口。

如果你不想继承Spring Data接口，也可以使用@RepositoryDefinition注解repository接口。继承其中一个CRUD存储库接口将公开一整套操作实体的方法。如果你希望对公开的方法有选择性，请将要公开的方法从CRUD repository复制到你的域repository中。这样做时，你可以更改方法的返回类型。如果可能的话，Spring Data将采用返回类型。例如，对于返回多个实体的方法，你可以选择Iterable, List, Collection或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查找单个用户，并触发查询以通过电子邮件地址查找用户。

中间（intermediate）存储库接口用@NoRepositoryBean进行注释。确保将该注解添加到所有不需要Spring Data在运行时为其创建实例的存储库接口中。

二、使用多个Spring Data模块的Repositories

在应用程序中使用唯一的Spring Data模块使事情变得简单，因为定义的范围中的所有存储库接口都绑定到Spring Data模块。有时，应用程序需要使用多个Spring Data模块。在这种情况下，存储库定义必须区分持久化技术。当Spring Data在类路径上检测到多个存储库工厂时，它将进入严格的（strict ）存储库配置模式。严格的配置使用存储库或域类的详细信息来决定存储库定义的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不能区分存储库，这导致了未定义的行为。

存储库类型详细信息（前述例1）和区分域类注解（前述例3）用于严格的（strict）存储库配置，以识别特定Spring Data模块的候选存储库。在同一域类型上使用多个特定于持久性技术的注解是可能的，并且可以跨多种持久性技术重用域类型。但是，Spring Data无法再确定用于绑定存储库的唯一模块。

区分存储库的最后一种方法是确定存储库基本包（base packages）的范围。基本包定义了扫描存储库接口定义的起点，这意味着存储库定义位于适当的包中。默认情况下，注解驱动的配置使用配置类的包。基于XML的配置中的基本包是必需的。

以下示例展示了基本包的注解驱动配置：
基本包的注解驱动配置

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