自定义 Repository 实现

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

自定义单个 Repository

要使用自定义功能丰富 repository，您必须首先定义一个片段接口以及该自定义功能的实现，如下所示

自定义 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 repositories 通过使用构成 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
}

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

以下示例显示了一个 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 中注册片段允许您规避此限制，如下面部分所述。

假设您想为您的组织提供一些可跨多个 repositories 使用的自定义搜索功能，利用文本搜索索引。

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

片段接口

public interface SearchExtension<T> {

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

假设实际的全文搜索可以通过上下文中注册为 Bean 的 SearchService 获得，以便您可以在我们的 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 工厂来暴露方法元数据。

暴露 Repository 元数据

标记接口
Bean Post Processor

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

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 {

    // ...
}

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

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 行为以影响所有 repositories 时自定义每个 repository 接口。要改为更改所有 repositories 的行为，您可以创建一个扩展特定持久化技术 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 工厂实现会使用它。如果 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" />