自定义仓库实现

ChatGPT-4o-mini 中英对照 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。因此，您可以使用标准的依赖注入行为来注入对其他 beans（如 JdbcTemplate）的引用，参与切面等。

然后你可以让你的仓库接口扩展 fragment 接口，如下所示：

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

@EnableCouchbaseRepositories(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. 消除歧义实现

package com.acme.impl.one;

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

java

package com.acme.impl.two;

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

  // Your custom implementation
}

java

如果你在 UserRepository 接口上添加 @Component("specialCustom") 注解，那么加上 Impl 的bean名称将与在 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 注册片段

正如在配置部分中已经提到的，基础设施仅会自动检测位于仓库基础包中的碎片。因此，如果碎片位于其他位置或希望通过外部归档贡献，则如果它们没有共享公共命名空间，将无法被找到。通过在 spring.factories 中注册碎片，可以绕过此限制，具体说明将在接下来的部分中介绍。

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

首先，您需要的是片段接口。请注意泛型 <T> 参数，以便将片段与存储库域类型对齐。

package com.acme.search;

public interface SearchExtension<T> {

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

java

假设实际的全文搜索是通过一个 SearchService 提供的，该服务作为一个 Bean 注册在上下文中，因此您可以在我们的 SearchExtension 实现中使用它。运行搜索所需的只是集合（或索引）名称和一个对象映射器，该映射器将搜索结果转换为实际的领域对象，如下所示。

package com.acme.search;

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()，您需要建议负责创建实际存储库的存储库工厂暴露方法元数据。

标记接口

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

package com.acme.search;

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 后处理器

可以通过 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;
            }
        };
    }
}

java

请不要仅仅复制/粘贴上述代码，而是根据您的实际使用案例考虑，可能需要更精细的处理，因为上述代码将会在每个仓库上启用该标志。

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

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

properties

现在你已经准备好使用你的扩展；只需将接口添加到你的代码库中。

package io.my.movies;

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
@EnableCouchbaseRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

java

XML

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

xml