springboot ElasticSearch如何配置自定义转换器ElasticsearchCustomConversions

 更新时间:2023年08月11日 09:18:58   作者:子黄求知若渴  
这篇文章主要介绍了springboot ElasticSearch如何配置自定义转换器ElasticsearchCustomConversions问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

问题场景

在将Timestamp类型存进Elasticsearc后,将其取出时抛出异常。

从提示中可以看出缺少从Long转换到Timestamp的类型转换器。

原理及分析

在spring-data-elasticsearch中,java对象到json的互相转换是通过ElasticsearchConverter来进行的。

使用springboot的自动配置机制能够快速地完成elasticsearch的配置,导入spring-boot-starter-data-elasticsearch依赖后,spring将会自动向ioc容器中添加client,converter,template等Bean,只需要简单地配置elasticSearch服务器信息后就可以使用。

在org.springframework.boot.autoconfigure.data.elasticsearch中通过@Import导入ElasticsearchDataConfiguration类,默认的converter就是通过这个类提供的。

//org.springframework.boot.autoconfigure.data.elasticsearch
@Import({ ElasticsearchDataConfiguration.BaseConfiguration.class,
		ElasticsearchDataConfiguration.RestClientConfiguration.class,
		ElasticsearchDataConfiguration.ReactiveRestClientConfiguration.class })
public class ElasticsearchDataAutoConfiguration {
}

在org.springframework.boot.autoconfigure.data.elasticsearch中可以看到方法elasticsearchConverter,使用@Bean将其注册到ioc容器中,@ConditionalOnMissingBean则是当容器中没有相同类型的Bean才会进行创建。

//org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataConfiguration.BaseConfiguration
@Bean
@ConditionalOnMissingBean
ElasticsearchConverter elasticsearchConverter(SimpleElasticsearchMappingContext mappingContext) {
    return new MappingElasticsearchConverter(mappingContext);
}

这里使用了MappingElasticsearchConverter来作为elasticsearch的默认类型转换器。

通过其源码可以看出MappingElasticsearchConverter提供了两种构造方法,自动配置类使用的是第一种,其conversionService为空,MappingElasticsearchConverter会使用类DefaultConversionService对属性conversions来进行初始化,提供基础的转换功能。

public MappingElasticsearchConverter(
    MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext) {
    this(mappingContext, null);
}
public MappingElasticsearchConverter(
    MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext,
    @Nullable GenericConversionService conversionService) {
    Assert.notNull(mappingContext, "MappingContext must not be null!");
    this.mappingContext = mappingContext;
    this.conversionService = conversionService != null ? conversionService : new DefaultConversionService();
    this.typeMapper = ElasticsearchTypeMapper.create(mappingContext);
}

同时MappingElasticsearchConverter类提供了setConversions来设置自定义的转换器CustomConversions。

通过向conversions添加自定义的converter来添加。

/**
	 * Set the {@link CustomConversions} to be applied during the mapping process. <br />
	 * Conversions are registered after {@link #afterPropertiesSet() bean initialization}.
	 *
	 * @param conversions must not be {@literal null}.
	 */
public void setConversions(CustomConversions conversions) {
    this.conversions = conversions;
}

这种方法来自于spring-data官方文档 章节6.1.3

原链接:https://docs.spring.io/spring-data/elasticsearch/docs/4.2.3/reference/html/#elasticsearch.mapping.meta-model

使用方法

由于@ConditionalOnMissingBean的存在,我们只需要自己创建一个ElasticsearchConverter并添加到环境中既可。

首先先创建两个Converter,分别用于Timestamp, Long的互相转换。

@WritingConverter
static class TimestampToLong implements Converter<Timestamp, Long> {
    @Override
    public Long convert(Timestamp source) {
        return source.getTime();
    }
}
@ReadingConverter
static class LongToTimestamp implements Converter<Long, Timestamp> {
    @Override
    public Timestamp convert(Long source) {
        return new Timestamp(source);
    }
}

方法1:

观察MappingElasticsearchConverter的构造方法发现,可以自行传入ConversionService来初始化。

这里使用了defaultConversionService,避免其他的类型转换受到影响,向其中添加自定义的两个converter, 并将其添加到MappingElasticsearchConverter构造器参数中。

@Bean
ElasticsearchConverter elasticsearchConverter(SimpleElasticsearchMappingContext mappingContext) {
    DefaultConversionService defaultConversionService = new DefaultConversionService();
    defaultConversionService.addConverter(new TimestampToLong());
    defaultConversionService.addConverter(new LongToTimestamp());
    return new MappingElasticsearchConverter(mappingContext, defaultConversionService);
}

方法2:

使用MappingElasticsearchConverter.setConversions方法向其添加自定义转换服务ElasticsearchCustomConversions。

首先创建一个ElasticsearchCustomConversions,添加两个自定义的转换器。

随后在elasticsearchConverter中通过setConversions添加到MappingElasticsearchConverter中。

@Bean
public ElasticsearchCustomConversions elasticsearchCustomConversions() {
    return new ElasticsearchCustomConversions(
        Arrays.asList(new TimestampToLong(), new LongToTimestamp()));
}
@Bean
public ElasticsearchConverter elasticsearchConverter(SimpleElasticsearchMappingContext mappingContext, ElasticsearchCustomConversions elasticsearchCustomConversions) {
    MappingElasticsearchConverter mappingElasticsearchConverter = new MappingElasticsearchConverter(mappingContext);
    mappingElasticsearchConverter.setConversions(elasticsearchCustomConversions);
    return mappingElasticsearchConverter;
}

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java通俗易懂系列设计模式之模板模式

    Java通俗易懂系列设计模式之模板模式

    这篇文章主要介绍了Java通俗易懂系列设计模式之模板模式,想了解设计模式的同学,可以仔细看一下
    2021-04-04
  • 详解MyBatis的Dao层实现和配置文件深入

    详解MyBatis的Dao层实现和配置文件深入

    这篇文章主要为大家详细介绍了MyBatis的Dao层实现和配置文件深入,文中的示例代码讲解详细,感兴趣的小伙伴快来跟随小编一起学习一下
    2022-07-07
  • Java异常的几个谜题_动力节点Java学院整理

    Java异常的几个谜题_动力节点Java学院整理

    本文给大家收藏整理java异常的几个谜题,非常不错,具有参考借鉴价值,需要的朋友参考下吧
    2017-06-06
  • MyBatis SpringMVC整合实现步骤详解

    MyBatis SpringMVC整合实现步骤详解

    这篇文章主要介绍了MyBatis SpringMVC整合实现步骤详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • SpringBoot实现分布式任务调度的详细步骤

    SpringBoot实现分布式任务调度的详细步骤

    随着互联网应用的规模和复杂度不断增加,单节点任务调度系统已经难以满足高并发、大数据量的处理需求,分布式任务调度成为了解决这一问题的重要手段,本文将介绍如何在Spring Boot中实现分布式任务调度,需要的朋友可以参考下
    2024-08-08
  • Java读取Properties文件的七种方法的总结

    Java读取Properties文件的七种方法的总结

    这篇文章主要介绍了Java读取Properties文件的七种方法的总结的相关资料,需要的朋友可以参考下
    2017-07-07
  • SpringBoot创建并简单使用的实现

    SpringBoot创建并简单使用的实现

    这篇文章主要介绍了SpringBoot创建并简单使用的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • Java跳过证书访问HTTPS详细代码示例

    Java跳过证书访问HTTPS详细代码示例

    在访问HTTPS网站时,Java会默认检查SSL证书是否有效,如果证书无效,则会阻止访问,这篇文章主要给大家介绍了关于Java跳过证书访问HTTPS的相关资料,需要的朋友可以参考下
    2024-02-02
  • SpringBoot Web开发之系统任务启动与路径映射和框架整合

    SpringBoot Web开发之系统任务启动与路径映射和框架整合

    这篇文章主要介绍了SpringBoot Web开发中的系统任务启动与路径映射和Servlet、Filter、Listener框架整合,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Maven引入外部jar的几种方法(小结)

    Maven引入外部jar的几种方法(小结)

    这篇文章主要介绍了Maven引入外部jar的几种方法(小结),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08

最新评论