自定义 Repository 实现

Spring Data 提供了多种选项，可以用很少的代码创建查询方法。但是，当这些选项不能满足您的需求时，您也可以为 repository 方法提供自己的自定义实现。本节描述了如何做到这一点。

定制单个 Repository

要使用自定义功能丰富 repository，您必须首先定义一个片段接口（fragment interface）和自定义功能的实现，如下所示

自定义 repository 功能的接口

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定义 repository 功能的实现

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  @Override
  public void someCustomMethod(User user) {
    // Your custom implementation
  }
}

与片段接口对应的类名中最重要的部分是 Impl 后缀。您可以通过设置 @Enable<StoreModule>Repositories(repositoryImplementationPostfix = …) 来自定义特定存储的后缀。

从历史上看，Spring Data 自定义 repository 实现的发现遵循命名模式，该模式从 repository 派生自定义实现类名，从而有效地只允许单个自定义实现。

位于与 repository 接口相同包中、匹配 *repository 接口名* 后跟 *实现后缀* 的类型被视为自定义实现，并将被当作自定义实现处理。遵循该名称的类可能会导致意外行为。

我们认为单个自定义实现的命名已弃用，建议不要使用此模式。请改为迁移到基于片段的编程模型。

实现本身不依赖于 Spring Data，可以是常规的 Spring bean。因此，您可以使用标准的依赖注入行为来注入对其他 bean（例如 JdbcTemplate）的引用，参与切面等。

然后，您可以让您的 repository 接口扩展片段接口，如下所示

对 repository 接口的更改

interface UserRepository extends CrudRepository<User, Long>, CustomizedUserRepository {

  // Declare query methods here
}

通过您的 repository 接口扩展片段接口可以将 CRUD 和自定义功能结合起来，并将其提供给客户端使用。

Spring Data repository 是通过形成 repository 组合的片段实现的。片段包括基本 repository、功能性方面（例如Querydsl）以及自定义接口及其实现。每次向 repository 接口添加接口时，您就通过添加片段来增强组合。基本 repository 和 repository 切面实现由每个 Spring Data 模块提供。

以下示例展示了自定义接口及其实现

片段及其实现

interface HumanRepository {
  void someHumanMethod(User user);
}

class HumanRepositoryImpl implements HumanRepository {

  @Override
  public void someHumanMethod(User user) {
    // Your custom implementation
  }
}

interface ContactRepository {

  void someContactMethod(User user);

  User anotherContactMethod(User user);
}

class ContactRepositoryImpl implements ContactRepository {

  @Override
  public void someContactMethod(User user) {
    // Your custom implementation
  }

  @Override
  public User anotherContactMethod(User user) {
    // Your custom implementation
  }
}

以下示例展示了扩展 CrudRepository 的自定义 repository 接口

对 repository 接口的更改

interface UserRepository extends CrudRepository<User, Long>, HumanRepository, ContactRepository {

  // Declare query methods here
}

Repository 可以由多个自定义实现组成，这些实现按照其声明顺序导入。自定义实现的优先级高于基本实现和 repository 切面。这种排序允许您覆盖基本 repository 和切面方法，并解决当两个片段贡献相同方法签名时的歧义。Repository 片段不仅限于在单个 repository 接口中使用。多个 repository 可以使用片段接口，从而允许您在不同 repository 之间重用定制。

以下示例展示了一个 repository 片段及其实现

覆盖 save(…) 的片段

interface CustomizedSave<T> {
  <S extends T> S save(S entity);
}

class CustomizedSaveImpl<T> implements CustomizedSave<T> {

  @Override
  public <S extends T> S save(S entity) {
    // Your custom implementation
  }
}

以下示例展示了使用上述 repository 片段的 repository

定制的 repository 接口

interface UserRepository extends CrudRepository<User, Long>, CustomizedSave<User> {
}

interface PersonRepository extends CrudRepository<Person, Long>, CustomizedSave<Person> {
}

配置

repository 基础设施尝试通过扫描找到 repository 所在包下方的类来自动检测自定义实现片段。这些类需要遵循追加后缀（默认为 Impl）的命名约定。

以下示例展示了一个使用默认后缀的 repository 和一个为后缀设置自定义值的 repository

示例 1. 配置示例

Java
XML

@EnableJpaRepositories(repositoryImplementationPostfix = "MyPostfix")
class Configuration { … }

<repositories base-package="com.acme.repository" />

<repositories base-package="com.acme.repository" repository-impl-postfix="MyPostfix" />

前一个示例中的第一个配置尝试查找名为 com.acme.repository.CustomizedUserRepositoryImpl 的类作为自定义 repository 实现。第二个示例尝试查找 com.acme.repository.CustomizedUserRepositoryMyPostfix。

歧义解决

如果在不同包中找到多个具有匹配类名的实现，Spring Data 会使用 bean 名称来识别要使用哪一个。

给定前面展示的 CustomizedUserRepository 的以下两个自定义实现，将使用第一个实现。其 bean 名称是 customizedUserRepositoryImpl，它与片段接口（CustomizedUserRepository）加上后缀 Impl 的名称匹配。

示例 2. 解决歧义实现

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

@Component("specialCustomImpl")
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

如果使用 @Component("specialCustom") 注解 UserRepository 接口，则 bean 名称加上 Impl 会匹配 com.acme.impl.two 中为 repository 实现定义的名称，并将使用它而不是第一个实现。

手动装配

如果您的自定义实现仅使用基于注解的配置和自动装配，则前面展示的方法效果很好，因为它被视为任何其他 Spring bean。如果您的实现片段 bean 需要特殊装配，您可以声明该 bean 并按照前面部分中描述的约定命名。然后，基础设施会按名称引用手动定义的 bean 定义，而不是自己创建一个。以下示例展示了如何手动装配自定义实现

示例 3. 自定义实现的手动装配

Java
XML

class MyClass {
  MyClass(@Qualifier("userRepositoryImpl") UserRepository userRepository) {
    …
  }
}

<repositories base-package="com.acme.repository" />

<beans:bean id="userRepositoryImpl" class="…">
  <!-- further configuration -->
</beans:bean>

使用 spring.factories 注册片段

正如配置部分已经提到的，基础设施只会在 repository 基本包内自动检测片段。因此，位于其他位置或希望由外部归档文件贡献的片段如果它们不共享共同的命名空间，将不会被找到。在 spring.factories 中注册片段允许您规避此限制，如下一节所述。

想象一下，您希望为您的组织提供一些可在多个 repository 中使用的自定义搜索功能，利用文本搜索索引。

首先，您需要片段接口。请注意通用参数 <T>，以便将片段与 repository 领域类型对齐。

片段接口

public interface SearchExtension<T> {

    List<T> search(String text, Limit limit);
}

假设实际的全文搜索通过 SearchService 可用，该服务在上下文中注册为 Bean，这样您就可以在我们的 SearchExtension 实现中消费它。运行搜索所需的所有信息是集合（或索引）名称以及一个对象映射器，该映射器将搜索结果转换为实际的领域对象，如下面所概述的。

片段实现

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Limit;
import org.springframework.data.repository.core.RepositoryMethodContext;

class DefaultSearchExtension<T> implements SearchExtension<T> {

    private final SearchService service;

    DefaultSearchExtension(SearchService service) {
        this.service = service;
    }

    @Override
    public List<T> search(String text, Limit limit) {
        return search(RepositoryMethodContext.getContext(), text, limit);
    }

    List<T> search(RepositoryMethodContext metadata, String text, Limit limit) {

        Class<T> domainType = metadata.getRepository().getDomainType();

        String indexName = domainType.getSimpleName().toLowerCase();
        List<String> jsonResult = service.search(indexName, text, 0, limit.max());

        return jsonResult.stream().map(…).collect(toList());
    }
}

在上面的示例中，RepositoryMethodContext.getContext() 用于检索实际方法调用的元数据。RepositoryMethodContext 暴露附加到 repository 的信息，例如领域类型。在这种情况下，我们使用 repository 领域类型来标识要搜索的索引名称。

暴露调用元数据是昂贵的，因此默认情况下禁用。要访问 RepositoryMethodContext.getContext()，您需要建议负责创建实际 repository 的 repository factory 暴露方法元数据。

暴露 Repository 元数据

标记接口
Bean 后处理器

将 RepositoryMetadataAccess 标记接口添加到片段实现中将触发基础设施，并为使用该片段的 repository 启用元数据暴露。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Limit;
import org.springframework.data.repository.core.support.RepositoryMetadataAccess;
import org.springframework.data.repository.core.RepositoryMethodContext;

class DefaultSearchExtension<T> implements SearchExtension<T>, RepositoryMetadataAccess {

    // ...
}

exposeMetadata 标志可以通过 BeanPostProcessor 直接设置在 repository factory bean 上。

import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport;
import org.springframework.lang.Nullable;

@Configuration
class MyConfiguration {

    @Bean
    static BeanPostProcessor exposeMethodMetadata() {

        return new BeanPostProcessor() {

            @Override
            public Object postProcessBeforeInitialization(Object bean, String beanName) {

                if(bean instanceof RepositoryFactoryBeanSupport<?,?,?> factoryBean) {
                    factoryBean.setExposeMetadata(true);
                }
                return bean;
            }
        };
    }
}

请不要直接复制/粘贴上述内容，而是考虑您实际的用例，这可能需要更精细的方法，因为上述方法会简单地在每个 repository 上启用该标志。

拥有片段声明和实现后，您可以在 META-INF/spring.factories 文件中注册扩展，并根据需要打包。

在 META-INF/spring.factories 中注册片段

com.acme.search.SearchExtension=com.acme.search.DefaultSearchExtension

现在您可以使用您的扩展了；只需将接口添加到您的 repository 中即可。

使用它

import com.acme.search.SearchExtension;
import org.springframework.data.repository.CrudRepository;

interface MovieRepository extends CrudRepository<Movie, String>, SearchExtension<Movie> {

}

定制基本 Repository

前面部分中描述的方法需要对每个 repository 接口进行定制，如果您想定制基本 repository 的行为以影响所有 repository。为了改为更改所有 repository 的行为，您可以创建一个扩展特定持久化技术 repository 基类的实现。然后，这个类将作为 repository 代理的自定义基类，如以下示例所示

自定义 repository 基类

class MyRepositoryImpl<T, ID>
  extends SimpleJpaRepository<T, ID> {

  private final EntityManager entityManager;

  MyRepositoryImpl(JpaEntityInformation entityInformation,
                          EntityManager entityManager) {
    super(entityInformation, entityManager);

    // Keep the EntityManager around to used from the newly introduced methods.
    this.entityManager = entityManager;
  }

  @Override
  @Transactional
  public <S extends T> S save(S entity) {
    // implementation goes here
  }
}

该类需要具有存储特定 repository factory 实现使用的超类构造函数。如果 repository 基类有多个构造函数，请覆盖接受 EntityInformation 和存储特定基础设施对象（例如 EntityManager 或模板类）的构造函数。

最后一步是让 Spring Data 基础设施了解定制的 repository 基类。在配置中，您可以使用 repositoryBaseClass 来做到这一点，如以下示例所示

示例 4. 配置自定义 repository 基类

Java
XML

@Configuration
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />