自定义 Repository 实现

Spring Data 提供了多种选项，可以用很少的代码创建查询方法。但是当这些选项不适合您的需求时，您也可以为 repository 方法提供自己的自定义实现。本节介绍如何实现。

自定义单个 Repository

要使用自定义功能来丰富 repository，您必须首先定义一个 fragment 接口和用于自定义功能的实现，如下所示：

自定义 Repository 功能的接口
interface CustomizedUserRepository {
  void someCustomMethod(User user);
}
自定义 Repository 功能的实现
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  @Override
  public void someCustomMethod(User user) {
    // Your custom implementation
  }
}

与 fragment 接口对应的类名中最重要部分是 Impl 后缀。您可以通过设置 @Enable<StoreModule>Repositories(repositoryImplementationPostfix = …) 来自定义特定于存储的后缀。

从历史上看，Spring Data 自定义 repository 实现的发现遵循一个命名模式，该模式从 repository 派生自定义实现类名，实际只允许一个自定义实现。

与 repository 接口位于同一包中的类型，如果匹配 repository 接口名称 后跟 实现后缀，则被视为自定义实现并将作为自定义实现进行处理。遵循该名称的类可能导致意外的行为。

我们认为这种单一自定义实现的命名方式已弃用，建议不要使用此模式。请改用基于 fragment 的编程模型。

实现本身不依赖于 Spring Data，可以是常规的 Spring bean。因此，您可以使用标准的依赖注入行为来注入对其他 bean（例如 JdbcTemplate）的引用，参与切面等。

然后您可以让您的 repository 接口扩展该 fragment 接口，如下所示：

对 Repository 接口的更改
interface UserRepository extends CrudRepository<User, Long>, CustomizedUserRepository {

  // Declare query methods here
}

使用您的 repository 接口扩展 fragment 接口将 CRUD 和自定义功能结合起来，并使其可供客户端使用。

Spring Data repositories 是通过使用构成 repository 组合的 fragment 来实现的。fragment 是基本 repository、功能性切面（例如 Querydsl）以及自定义接口及其实现。每次您向 repository 接口添加一个接口时，都会通过添加一个 fragment 来增强组合。基本 repository 和 repository 切面实现由每个 Spring Data 模块提供。

以下示例展示了自定义接口及其实现

Fragment 及其实现
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 的自定义 repository 的接口

对 Repository 接口的更改
interface UserRepository extends CrudRepository<User, Long>, HumanRepository, ContactRepository {

  // Declare query methods here
}

Repositories 可以由多个自定义实现组成，这些实现按照它们的声明顺序导入。自定义实现比基本实现和 repository 切面具有更高的优先级。此顺序允许您覆盖基本 repository 和切面方法，并在两个 fragment 提供相同方法签名时解决歧义。Repository fragment 的使用不限于单个 repository 接口。多个 repository 可以使用一个 fragment 接口，从而可以在不同的 repository 之间重用自定义。

以下示例展示了一个 repository fragment 及其实现

覆盖 save(…) 的 Fragment
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
  }
}

以下示例展示了一个使用上述 repository fragment 的 repository

自定义的 Repository 接口
interface UserRepository extends CrudRepository<User, Long>, CustomizedSave<User> {
}

interface PersonRepository extends CrudRepository<Person, Long>, CustomizedSave<Person> {
}

配置

repository 基础设施会尝试通过扫描找到 repository 的包下的类来自动检测自定义实现 fragment。这些类需要遵循命名约定，即附加一个默认为 Impl 的后缀。

以下示例展示了一个使用默认后缀的 repository 和一个为后缀设置自定义值的 repository

示例 1. 配置示例

  • Java

  • XML

@EnableJdbcRepositories(repositoryImplementationPostfix = "MyPostfix")
class Configuration { … }
<repositories base-package="com.acme.repository" />

<repositories base-package="com.acme.repository" repository-impl-postfix="MyPostfix" />

上述示例中的第一个配置尝试查找名为 com.acme.repository.CustomizedUserRepositoryImpl 的类作为自定义 repository 实现。第二个示例尝试查找 com.acme.repository.CustomizedUserRepositoryMyPostfix。

歧义的解决

如果在不同的包中找到了具有匹配类名的多个实现，Spring Data 会使用 bean 名称来标识要使用哪一个。

考虑到前面展示的 CustomizedUserRepository 的以下两个自定义实现，将使用第一个实现。其 bean 名称为 customizedUserRepositoryImpl，这与 fragment 接口（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 中为 repository 实现定义的名称相匹配，并使用它而不是第一个实现。

手动装配

如果您的自定义实现仅使用基于注解的配置和自动装配，前面展示的方法将很好地工作，因为它被视为任何其他 Spring bean。如果您的实现 fragment 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 注册 Fragment

如配置部分所述，基础设施只在 repository 基本包内自动检测 fragment。因此，位于其他位置或希望由外部存档贡献的 fragment，如果它们不共享公共命名空间，将找不到。在 spring.factories 中注册 fragment 可以让您规避此限制，如下一节所述。

假设您希望提供一些自定义搜索功能，这些功能可用于您组织内的多个 repository，并利用文本搜索索引。

首先，您需要的是 fragment 接口。请注意泛型参数 <T>，它用于使 fragment 与 repository 领域类型对齐。

Fragment 接口
package com.acme.search;

public interface SearchExtension<T> {

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

假设实际的全文本搜索通过上下文内注册为 Bean 的 SearchService 可用，这样您就可以在我们的 SearchExtension 实现中使用它。运行搜索所需的一切是集合（或索引）名称以及一个将搜索结果转换为实际领域对象的对象映射器，如下所述。

Fragment 实现
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 暴露了附加到 repository 的信息，例如领域类型。在这种情况下，我们使用 repository 领域类型来标识要搜索的索引名称。

暴露调用元数据成本较高，因此默认禁用。要访问 RepositoryMethodContext.getContext()，您需要通知负责创建实际 repository 的 repository 工厂暴露方法元数据。

暴露 Repository 元数据

  • 标记接口

  • Bean 后置处理器

将 RepositoryMetadataAccess 标记接口添加到 fragment 实现中将触发基础设施，并为那些使用该 fragment 的 repository 启用元数据暴露。

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 直接在 repository 工厂 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;
            }
        };
    }
}

请不要直接复制/粘贴以上内容，而是考虑您的实际用例，这可能需要更精细的方法，因为上述方法会简单地在每个 repository 上启用该标志。

准备好 fragment 声明和实现后，您可以在 META-INF/spring.factories 文件中注册扩展，并在需要时打包。

在 META-INF/spring.factories 中注册 Fragment
com.acme.search.SearchExtension=com.acme.search.DefaultSearchExtension

现在您就可以使用您的扩展了；只需将接口添加到您的 repository 中即可。

使用它
package io.my.movies;

import com.acme.search.SearchExtension;
import org.springframework.data.repository.CrudRepository;

interface MovieRepository extends CrudRepository<Movie, String>, SearchExtension<Movie> {

}

自定义基本 Repository

上一节中描述的方法要求在您想要自定义基本 repository 行为以影响所有 repository 时，对每个 repository 接口进行自定义。相反，要更改所有 repository 的行为，您可以创建一个扩展特定持久化技术 repository 基类的实现。然后，该类将作为 repository 代理的自定义基类，如下例所示：

自定义 Repository 基类
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
  }
}
该类需要有一个超类构造函数，供特定存储的 repository 工厂实现使用。如果 repository 基类有多个构造函数，请覆盖接受 EntityInformation 和特定存储基础设施对象（例如 EntityManager 或模板类）的那个。

最后一步是让 Spring Data 基础设施知晓自定义的 repository 基类。在配置中，您可以通过使用 repositoryBaseClass 来实现，如下例所示：

示例 4. 配置自定义 repository 基类

  • Java

  • XML

@Configuration
@EnableJdbcRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }
<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />