自定义存储库实施

Spring Data 提供了各种选项来创建查询方法，只需很少的编码。但是，当这些选项不符合您的需求时，您也可以为存储库方法提供自己的自定义实现。本节介绍如何执行此操作。spring-doc.cn

自定义单个存储库

要使用自定义功能丰富存储库，您必须首先定义自定义功能的片段接口和实现，如下所示：spring-doc.cn

自定义存储库功能的接口

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定义存储库功能的实现

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

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

从历史上看， Spring Data 自定义存储库实现发现遵循一种命名模式，该模式从存储库派生自定义实现类名称，从而有效地允许单个自定义实现。spring-doc.cn

与仓库接口位于同一软件包中的类型，与仓库接口名称匹配，后跟 implementation 后缀。被视为自定义实现，并将被视为自定义实现。该名称后面的类可能会导致意外行为。spring-doc.cn

我们认为 single-custom implementation naming 已弃用，建议不要使用此模式。相反，请迁移到基于 Fragment 的编程模型。spring-doc.cn

实现本身不依赖于 Spring Data，可以是常规的 Spring bean。因此，您可以使用标准依赖关系注入行为来注入对其他 bean（例如 a ）、参与 aspects 等的引用。JdbcTemplatespring-doc.cn

然后，您可以让您的存储库接口扩展 fragment 接口，如下所示：spring-doc.cn

对存储库界面的更改

interface UserRepository extends CrudRepository<User, Long>, CustomizedUserRepository {

  // Declare query methods here
}

使用存储库接口扩展片段接口将 CRUD 和自定义功能相结合，并使其可供客户端使用。spring-doc.cn

Spring Data 存储库是通过使用形成存储库组合的片段来实现的。片段是基本存储库、功能方面（如 QueryDsl）和自定义接口及其实现。每次向存储库界面添加接口时，都会通过添加片段来增强合成。基本存储库和存储库方面实现由每个 Spring Data 模块提供。spring-doc.cn

以下示例显示了自定义接口及其实现：spring-doc.cn

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

以下示例显示了扩展：CrudRepositoryspring-doc.cn

对存储库界面的更改

interface UserRepository extends CrudRepository<User, Long>, HumanRepository, ContactRepository {

  // Declare query methods here
}

存储库可能由多个自定义实现组成，这些实现按其声明顺序导入。自定义实施的优先级高于基本实施和存储库方面。通过此排序，您可以覆盖基本存储库和方面方法，并在两个片段提供相同的方法签名时解决歧义。存储库片段不限于在单个存储库界面中使用。多个存储库可以使用片段界面，从而允许您在不同的存储库中重复使用自定义设置。spring-doc.cn

以下示例显示了存储库片段及其实现：spring-doc.cn

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

以下示例显示了使用上述存储库片段的存储库：spring-doc.cn

自定义存储库界面

interface UserRepository extends CrudRepository<User, Long>, CustomizedSave<User> {
}

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

配置

存储库基础结构会尝试通过扫描在其中找到存储库的软件包下的类来自动检测自定义实现片段。这些类需要遵循命名约定，即附加默认为 .Implspring-doc.cn

以下示例显示了使用默认后缀的存储库和为后缀设置自定义值的存储库：spring-doc.cn

示例 1.配置示例

Javaspring-doc.cn
XMLspring-doc.cn

@EnableJpaRepositories(repositoryImplementationPostfix = "MyPostfix")
class Configuration { … }

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

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

前面示例中的第一个配置尝试查找一个称为 to act a custom repository implementation的类。第二个示例尝试查找。com.acme.repository.CustomizedUserRepositoryImplcom.acme.repository.CustomizedUserRepositoryMyPostfixspring-doc.cn

歧义的解决

如果在不同的包中找到具有匹配类名的多个实现，则 Spring Data 将使用 Bean 名称来确定要使用的 Bean。spring-doc.cn

鉴于前面显示的以下两个自定义实现，使用第一个实现。它的 bean 名称是，它与片段接口（）加上后缀的 bean 名称匹配。CustomizedUserRepositorycustomizedUserRepositoryImplCustomizedUserRepositoryImplspring-doc.cn

示例 2.解决不明确的实施

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

@Component("specialCustomImpl")
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

如果使用对接口进行注释，则 bean 名称加将与中为存储库实现定义的名称匹配，并使用它而不是第一个名称。UserRepository@Component("specialCustom")Implcom.acme.impl.twospring-doc.cn

手动布线

如果您的自定义实现仅使用基于 Comments 的配置和自动装配，则前面显示的方法效果很好，因为它被视为任何其他 Spring bean。如果您的实现片段 Bean 需要特殊连接，则可以声明 Bean 并根据上一节中描述的约定对其进行命名。然后，基础结构按名称引用手动定义的 bean 定义，而不是自己创建一个定义。以下示例显示了如何手动连接自定义实现：spring-doc.cn

例 3.自定义实现的手动连接

Javaspring-doc.cn
XMLspring-doc.cn

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.factoriesspring-doc.cn

假设您希望利用文本搜索索引为您的组织提供一些可在多个存储库中使用的自定义搜索功能。spring-doc.cn

首先，您只需要 fragment 接口。记下 generic 参数，使片段与存储库域类型保持一致。<T>spring-doc.cn

片段接口

public interface SearchExtension<T> {

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

假设实际的全文搜索可以通过在上下文中注册为 a 的 a 获得，因此你可以在我们的实现中使用它。运行搜索所需的只是集合（或索引）名称和对象映射器，该对象映射器将搜索结果转换为实际的域对象，如下所示。SearchServiceBeanSearchExtensionspring-doc.cn

Fragment 实现

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

在上面的示例中，用于检索实际方法调用的元数据。公开附加到存储库的信息，例如域类型。在这种情况下，我们使用 repository domain type 来标识要搜索的索引的名称。RepositoryMethodContext.getContext()RepositoryMethodContextspring-doc.cn

公开调用元数据的成本很高，因此默认情况下处于禁用状态。要访问，您需要通知负责创建实际存储库的存储库工厂公开方法元数据。RepositoryMethodContext.getContext()spring-doc.cn

公开存储库元数据

Marker Interfacespring-doc.cn
Bean Post Processorspring-doc.cn

将 marker 接口添加到 fragments 实现将触发基础设施，并为使用该 fragment 的存储库启用元数据公开。RepositoryMetadataAccessspring-doc.cn

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 {

    // ...
}

可以通过 .exposeMetadataBeanPostProcessorspring-doc.cn

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

请不要只复制/粘贴上述内容，而是考虑您的实际用例，这可能需要更细粒度的方法，因为上述内容将仅在每个存储库上启用标志。spring-doc.cn

有了 fragment 声明和实现，您可以在文件中注册扩展名，并在需要时打包。META-INF/spring.factoriesspring-doc.cn

在中注册片段META-INF/spring.factories

com.acme.search.SearchExtension=com.acme.search.DefaultSearchExtension

现在，您已准备好使用您的扩展;只需将界面添加到您的存储库中即可。spring-doc.cn

使用

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

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

}

自定义 Base 仓库

当您想要自定义基本存储库行为以使所有存储库都受到影响时，上一节中描述的方法需要自定义每个存储库接口。要改为更改所有存储库的行为，您可以创建一个实现来扩展特定于持久性技术的存储库基类。然后，此类充当存储库代理的自定义基类，如以下示例所示：spring-doc.cn

自定义存储库基类

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

该类需要具有特定于 store 的存储库工厂实现使用的 super class 的构造函数。如果存储库基类具有多个构造函数，请覆盖采用 an 加上特定于商店的基础设施对象（例如 an 或 a template 类）的构造函数。EntityInformationEntityManager

最后一步是使 Spring Data 基础结构知道自定义的存储库基类。在配置中，您可以使用，如以下示例所示：repositoryBaseClassspring-doc.cn

示例 4.配置自定义存储库基类

Javaspring-doc.cn
XMLspring-doc.cn

@Configuration
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />