自定义仓库实现

Doubao 中英对照 Custom Repository Implementations

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

自定义单个仓库

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

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

java

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

java

备注

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

注意

历史上，Spring Data 自定义仓库实现的发现遵循一种命名模式，即从仓库派生出自定义实现类名，实际上只允许单个自定义实现。

位于与仓库接口相同包中、符合「仓库接口名」后跟「实现后缀」这一规则的类型，会被视为自定义实现并按自定义实现处理。遵循该命名的类可能导致不期望的行为。

我们认为这种单自定义实现的命名方式已被弃用，并建议不要使用该模式。相反，请迁移到基于片段的编程模型。

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

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

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

  // Declare query methods here
}

java

用您的仓库接口继承片段接口，会将 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
  }
}

java

以下示例展示了一个继承 CrudRepository 的自定义仓库接口：

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

  // Declare query methods here
}

java

仓库可以由多个自定义实现组成，这些实现按照声明的顺序被导入。自定义实现的优先级高于基础实现和仓库切面。这种顺序让您可以覆盖基础仓库和切面的方法，并在两个片段提供相同方法签名时解决歧义。仓库片段并不局限于单个仓库接口中使用。多个仓库可以使用同一个片段接口，从而让您在不同仓库之间复用自定义实现。

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

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

java

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

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

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

java

配置

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

以下示例展示了一个使用默认后缀的仓库，以及一个为后缀设置自定义值的仓库：

示例 1. 配置示例

Java

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

java

XML

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

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

xml

上例中的第一个配置会尝试查找名为 com.acme.repository.CustomizedUserRepositoryImpl 的类，将其作为自定义仓库实现。第二个示例会尝试查找 com.acme.repository.CustomizedUserRepositoryMyPostfix。

歧义的解决

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

对于前面所示的 CustomizedUserRepository 的以下两个自定义实现，会使用第一个实现。它的 bean 名称为 customizedUserRepositoryImpl，即片段接口（CustomizedUserRepository）的名称加上后缀 Impl。

示例 2. 歧义实现的解决

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

java

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

  // Your custom implementation
}

java

如果您用 @Component("specialCustom") 注解 UserRepository 接口，那么 bean 名称加上 Impl 就会与在 com.acme.impl.two 中为该仓库实现定义的名称相匹配，从而使用它而不是第一个实现。

手动装配

如果您的自定义实现仅使用基于注解的配置和自动装配，那么上述方法就能很好地工作，因为它会被当作任何其他 Spring bean 一样处理。如果您的实现片段 bean 需要特殊装配，您可以声明该 bean，并按照上一节所述的约定为其命名。然后基础设施会按名称引用手动定义的 bean 定义，而不是自行创建一个。以下示例展示了如何手动装配一个自定义实现：

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

Java

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

java

XML

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

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

xml

通过 spring.factories 注册片段

正如配置一节中已经提到的，基础设施只会自动检测仓库基础包内的片段。因此，如果片段位于其他位置、或希望由外部归档（archive）提供，只要它们不共享一个公共命名空间，就不会被发现。在 spring.factories 中注册片段可以让您绕过这一限制，如下节所述。

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

首先，您只需要这个片段接口。注意其中的泛型 <T> 参数，用于使片段与仓库的领域类型保持一致。

public interface SearchExtension<T> {

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

java

假设实际的全文搜索可以通过一个 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());
    }
}

java

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

暴露调用元数据开销较大，因此默认处于禁用状态。要访问 RepositoryMethodContext.getContext()，您需要通知负责创建实际仓库的仓库工厂来暴露方法元数据。

Marker Interface

Adding the RepositoryMetadataAccess marker interface to the fragments implementation will trigger the infrastructure and enable metadata exposure for those repositories using the fragment.

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 {

    // ...
}

java

Bean Post Processor

The exposeMetadata flag can be set directly on the repository factory bean via a BeanPostProcessor.

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

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

java

Please do not just copy/paste the above but consider your actual use case which may require a more fine-grained approach as the above will simply enable the flag on every repository.

在片段声明和实现都准备就绪后，您就可以在 META-INF/spring.factories 文件中注册该扩展，并在需要时打包发布。

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

properties

现在您就可以使用自己的扩展了；只需将该接口添加到您的仓库中。

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

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

}

java

自定义基础仓库

上一节 所述的方法需要在您想自定义基础仓库行为、使所有仓库都受影响时，对每个仓库接口进行自定义。若要改为对所有仓库统一更改行为，您可以创建一个继承持久化技术专属仓库基类的实现。然后该类将充当仓库代理的自定义基类，如下例所示：

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

java

警告

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

最后一步是让 Spring Data 基础设施知晓这个自定义的仓库基类。在配置中，您可以通过使用 repositoryBaseClass 来做到这一点，如下例所示：

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

Java

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

java

XML

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

xml

自定义仓库工厂

通过 RepositoryFactoryCustomizer 自定义仓库工厂，可以直接访问参与仓库实例创建的组件。当您想调整代理创建的某些方面、而又不想引入一个完全自定义的仓库工厂 bean 时，该机制非常有用。以下示例演示了如何注册额外的监听器和代理通知器：

factoryBean.addRepositoryFactoryCustomizer(repositoryFactory -> {
	repositoryFactory.addInvocationListener(…);
	repositoryFactory.addQueryCreationListener(…);

	repositoryFactory.addRepositoryProxyPostProcessor((factory, repositoryInformation) -> factory.addAdvice(…));
});

java

RepositoryFactoryCustomizer 会与特定的仓库工厂 bean 关联，理想情况下通过 BeanPostProcessor 进行，从而只影响特定的仓库。请注意，customizer bean 不会被自动应用，以防止不期望的装配——这种情况在多仓库配置或使用多个 Spring Data 模块时尤为重要。

自定义仓库工厂 Bean

自定义仓库创建最强大的方法是提供一个自定义仓库工厂 bean，通常是 RepositoryFactorySupport、TransactionalRepositoryFactoryBeanSupport 或特定存储仓库工厂 bean 的子类。

自定义仓库工厂 bean 让您可以在完全访问底层仓库工厂的情况下，彻底更改仓库的创建过程。

请注意，这种方法需要付出最多的努力，通常只在您想更改仓库创建的核心方面时才需要。此外，您还需要考虑仓库元数据派生，它用于识别查询方法、基础实现方法和自定义实现。以下小结概述了关键方面：

• repositoryBaseClass：仓库基类定义了哪些方法由基类实现，以及哪些方法需要通过切面或自定义实现进行额外处理。

• repositoryFragmentsContributor：一个 RepositoryFragmentsContributor 允许在收集完所有标准片段之后，向仓库组合做出贡献。存储模块使用该机制来添加诸如 Querydsl 或按示例查询之类的功能。它还作为第三方扩展的 SPI。

• exposeMetadata：控制是否可通过 RepositoryMethodContext.getContext() 获取调用元数据。