自定义仓库实现

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

自定义单个仓库

要为仓库添加自定义功能，您必须首先定义一个片段接口以及自定义功能的实现，如下所示

自定义仓库功能的接口

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定义仓库功能的实现

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

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

在历史上，Spring Data 自定义仓库实现发现遵循一种命名模式，该模式从仓库派生自定义实现类名，从而有效只允许一个自定义实现。

位于与仓库接口相同的包中，并且名称匹配 仓库接口名称 后跟 实现后缀 的类型被视为自定义实现，并将被视为自定义实现。遵循该名称的类可能会导致不期望的行为。

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

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

然后您可以让您的仓库接口继承该片段接口，如下所示

您的仓库接口的变更

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

  // Declare query methods here
}

让您的仓库接口继承片段接口，可以将 CRUD 和自定义功能结合起来，并使其可供客户端使用。

Spring Data 仓库通过使用形成仓库组合的片段来实现。片段包括基本仓库、功能性方面（例如Querydsl）以及自定义接口及其实现。每次您向仓库接口添加一个接口时，都会通过添加一个片段来增强组合。基本仓库和仓库方面的实现由每个 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 的自定义仓库接口

您的仓库接口的变更

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

  // Declare query methods here
}

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

以下示例显示了一个仓库片段及其实现

覆盖 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
  }
}

以下示例显示了一个使用上述仓库片段的仓库

自定义仓库接口

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

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

配置

仓库基础设施尝试通过扫描在其找到仓库的包下面的类来自动检测自定义实现片段。这些类需要遵循命名约定，即附加一个后缀，默认值为 Impl。

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

示例 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 的类作为自定义仓库实现。第二个示例尝试查找 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 中为仓库实现定义的名称，并且将使用该实现而不是第一个实现。

手动装配

如果您的自定义实现仅使用基于注解的配置和自动装配，那么前面所示的方法效果很好，因为它被视为任何其他 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 注册片段

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

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

首先，您只需要片段接口。请注意泛型参数 <T> 以便使片段与仓库域类型对齐。

片段接口

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 暴露了附加到仓库的信息，例如域类型。在这种情况下，我们使用仓库域类型来标识要搜索的索引的名称。

暴露调用元数据成本很高，因此默认情况下是禁用的。要访问 RepositoryMethodContext.getContext()，您需要通知负责创建实际仓库的仓库工厂暴露方法元数据。

暴露仓库元数据

标记接口
Bean 后处理器

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

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 直接在仓库工厂 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;
            }
        };
    }
}

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

完成片段声明和实现后，您可以在 META-INF/spring.factories 文件中注册扩展，并在需要时将其打包。

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

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

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

使用它

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

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

}

自定义基本仓库

当您想自定义基本仓库行为以便所有仓库都受到影响时，上一节中描述的方法需要自定义每个仓库接口。为了改变所有仓库的行为，您可以创建一个实现来扩展特定于持久化技术的基本仓库类。然后，该类将作为仓库代理的自定义基类，如下例所示

自定义仓库基类

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
  }
}

该类需要有一个由特定存储仓库工厂实现使用的超类构造函数。如果仓库基类有多个构造函数，请覆盖接受 EntityInformation 加上特定存储基础设施对象（例如 EntityManager 或模板类）的那个。

最后一步是让 Spring Data 基础设施了解自定义的仓库基类。在配置中，您可以使用 repositoryBaseClass 来实现，如下例所示

示例 4. 配置自定义仓库基类

Java
XML

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

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