自定义仓库实现

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

@EnableRedisRepositories(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 提供，该 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 Post Processor

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

    // ...
}

exposeMetadata 标志可以通过 BeanPostProcessor 直接在仓库工厂 bean 上设置。

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
@EnableRedisRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }
<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />