自定义存储库实现

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

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

在上面的示例中，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" />