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

总结

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

相关文章

  • springboot读取nacos配置文件的实现

    springboot读取nacos配置文件的实现

    SpringBoot注册服务到Nacos上,由Nacos来做服务的管理,本文主要介绍了springboot读取nacos配置文件的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • Mybatis实体类属性与数据库不一致解决方案

    Mybatis实体类属性与数据库不一致解决方案

    这篇文章主要介绍了Mybatis实体类属性与数据库不一致解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • JVM垃圾回收算法的概念与分析

    JVM垃圾回收算法的概念与分析

    这篇文章主要给大家介绍了关于JVM垃圾回收算法的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用JVM具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-12-12
  • java 如何实现正确的删除集合中的元素

    java 如何实现正确的删除集合中的元素

    这篇文章主要介绍了java 如何实现正确的删除集合中的元素,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • Java集合List的使用详细解析

    Java集合List的使用详细解析

    这篇文章主要介绍了Java集合List的使用详细解析,List集合类中元素有序、且可重复,集合中的每个元素都有其对应的顺序索引,鉴于Java中数组用来存储数据的局限性,我们通常使用java.util.List替代数组,需要的朋友可以参考下
    2023-11-11
  • Eclipse中maven异常Updating Maven Project的统一解决方案

    Eclipse中maven异常Updating Maven Project的统一解决方案

    今天小编就为大家分享一篇关于Eclipse中maven异常Updating Maven Project的统一解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • java时间戳转日期格式的实现代码

    java时间戳转日期格式的实现代码

    本篇文章是对java时间戳转日期格式的实现代码进行了详细的分析介绍,需要的朋友参考下
    2013-06-06
  • AsyncHttpClient RequestFilter请求筛选源码解读

    AsyncHttpClient RequestFilter请求筛选源码解读

    这篇文章主要为大家介绍了AsyncHttpClient RequestFilter请求筛选源码解读,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12
  • Java实现读取文件夹下(包括子目录)所有文件的文件名

    Java实现读取文件夹下(包括子目录)所有文件的文件名

    这篇文章主要介绍了Java实现读取文件夹下(包括子目录)所有文件的文件名,本文把代码组织成了一个模块,可以很方便的使用,需要的朋友可以参考下
    2015-06-06
  • springboot集成redis实现简单秒杀系统

    springboot集成redis实现简单秒杀系统

    这篇文章主要为大家详细介绍了springboot集成redis实现简单秒杀系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-12-12

最新评论