自定义仓库实现

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

@EnableLdapRepositories(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 中为仓库实现定义的 bean 名称匹配，并将使用它而不是第一个实现。

手动注入

如果你的自定义实现仅使用基于注解的配置和自动注入，前面展示的方法效果很好，因为它被视作任何其他 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);
}

假设实际的全文搜索可通过一个注册为上下文中的 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 暴露了附加到仓库的信息，例如域类型。在此情况下，我们使用仓库域类型来标识要搜索的索引名称。

暴露调用元数据成本较高，因此默认是禁用的。要访问 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
@EnableLdapRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }
<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />