自定义存储库实现

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. 模糊实现的解决

package com.acme.impl.one;

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

package com.acme.impl.two;

@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>参数，以使片段与存储库域类型保持一致。

片段接口

package com.acme.search;

public interface SearchExtension<T> {

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

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

在上面的示例中，RepositoryMethodContext.getContext() 用于检索实际方法调用的元数据。RepositoryMethodContext 公开了与存储库关联的信息，例如域类型。在本例中，我们使用存储库域类型来识别要搜索的索引的名称。

公开调用元数据代价很高，因此默认情况下已禁用。要访问 RepositoryMethodContext.getContext()，您需要建议负责创建实际存储库的存储库工厂公开方法元数据。

公开存储库元数据

标记接口
Bean 后置处理器

将 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 {

    // ...
}

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

现在您已准备好使用您的扩展；只需将接口添加到您的存储库即可。

使用它

package io.my.movies;

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" />

在自定义实现中使用 `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);
  }

  …
}

这种方法的优点是，如果域类型被分配到不同的持久单元，则无需修改存储库以更改对持久单元的引用。