自定义 Repository 实现

Spring Data 提供了各种选项来创建几乎无需编码的查询方法。但是，当这些选项不能满足您的需求时，您也可以为 repository 方法提供自己的自定义实现。本节描述了如何实现这一点。

定制单个 Repositories

要通过自定义功能丰富 repository，您必须首先定义一个片段接口和自定义功能的实现，如下所示：

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

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

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

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

与 repository 接口位于同一包中，匹配 *repository 接口名称* 后跟 *实现后缀* 的类型被视为自定义实现，并将被视为自定义实现。遵循该名称的类可能导致不期望的行为。

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

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

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

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

  // Declare query methods here
}

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

Spring Data repositories 通过使用构成 repository 组合的片段来实现。片段是基础 repository、功能切面（例如Querydsl）以及自定义接口及其实现。每次向 repository 接口添加接口时，都会通过添加一个片段来增强组合。基础 repository 和 repository 切面实现由每个 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 的自定义 repository 接口：

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

  // Declare query methods here
}

Repositories 可以由多个自定义实现组成，这些实现按照声明的顺序导入。自定义实现的优先级高于基础实现和 repository 切面。这种排序允许您覆盖基础 repository 和切面方法，并在两个片段贡献相同方法签名时解决歧义。Repository 片段不限于在单个 repository 接口中使用。多个 repositories 可以使用一个片段接口，从而允许您在不同 repositories 之间重用自定义。

以下示例显示了一个 repository 片段及其实现：

覆盖 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
  }
}

以下示例显示了一个使用前面 repository 片段的 repository：

定制的 repository 接口
interface UserRepository extends CrudRepository<User, Long>, CustomizedSave<User> {
}

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

配置

repository 基础架构尝试通过扫描找到 repository 的包下的类来自动检测自定义实现片段。这些类需要遵循默认后缀为 Impl 的命名约定。

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

示例 1. 配置示例

  • Java

  • XML

@EnableCouchbaseRepositories(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，这与片段接口 (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。如果您的实现片段 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 注册片段

正如配置部分已经提到的，基础架构仅在 repository 基础包中自动检测片段。因此，如果片段位于其他位置或希望由外部存档贡献，则如果它们不共享一个公共命名空间，将找不到它们。如以下部分所述，在 spring.factories 中注册片段可以绕过此限制。

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

首先，您只需要片段接口。请注意泛型参数 <T> 以使片段与 repository 域类型对齐。

片段接口
package com.acme.search;

public interface SearchExtension<T> {

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

假设实际的全文搜索通过注册为上下文中的 Bean 的 SearchService 提供，因此您可以在 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 公开附加到 repository 的信息，例如域类型。在本例中，我们使用 repository 域类型来标识要搜索的索引的名称。

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

暴露 Repository 元数据

  • 标记接口

  • BeanPostProcessor

将 RepositoryMetadataAccess 标记接口添加到片段实现将触发基础架构，并为使用该片段的 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 {

    // ...
}

可以通过 BeanPostProcessor 直接在 repository 工厂 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;
            }
        };
    }
}

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

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

在 META-INF/spring.factories 中注册片段
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 的行为，以便所有 repositories 都受到影响。要改变所有 repositories 的行为，您可以创建一个扩展特定持久化技术 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
@EnableCouchbaseRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }
<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />