自定义仓库实现

DeepSeek V3 中英对照 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 自定义仓库实现类的发现遵循了一种命名模式，该模式从仓库接口派生出自定义实现类的名称，从而有效地允许单一自定义实现。

与仓库接口位于同一包中的类型，如果匹配 仓库接口名称 后跟 实现后缀，则被视为自定义实现，并会作为自定义实现处理。使用该命名方式的类可能会导致不期望的行为。

我们认为单一自定义实现的命名方式已过时，建议不要使用此模式。相反，建议迁移到基于片段（fragment-based）的编程模型。

实现本身并不依赖于 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：解析模糊实现

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") 注解，那么生成的 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 注册 Fragments

正如在配置部分所述，基础设施只会自动检测仓库基础包中的片段。因此，如果片段位于其他位置或希望通过外部归档文件贡献，且它们没有共享一个共同的命名空间，那么这些片段将不会被发现。通过在 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
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

java

XML

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

xml

在自定义实现中使用 JpaContext

在处理多个 EntityManager 实例和自定义仓库实现时，你需要将正确的 EntityManager 注入到仓库实现类中。你可以通过在 @PersistenceContext 注解中显式命名 EntityManager 来实现，或者如果 EntityManager 是 @Autowired 的，可以通过使用 @Qualifier 来实现。

自 Spring Data JPA 1.9 起，Spring Data JPA 包含了一个名为 JpaContext 的类，它允许你通过管理的域类获取 EntityManager，前提是该域类仅由应用程序中的一个 EntityManager 实例管理。以下示例展示了如何在自定义存储库中使用 JpaContext：

示例 5. 在自定义仓库实现中使用 JpaContext

class UserRepositoryImpl implements UserRepositoryCustom {

  private final EntityManager em;

  @Autowired
  public UserRepositoryImpl(JpaContext context) {
    this.em = context.getEntityManagerByManagedType(User.class);
  }

  …
}

java

这种方法的优势在于，如果域类型被分配到不同的持久化单元，存储库无需修改即可更改对持久化单元的引用。