快捷導(dǎo)航

springboot?ElasticSearch如何配置自定義轉(zhuǎn)換器ElasticsearchCustomConversions

更新時間：2023年08月11日 09:18:58 作者：子黃求知若渴

這篇文章主要介紹了springboot?ElasticSearch如何配置自定義轉(zhuǎn)換器ElasticsearchCustomConversions問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

問題場景

在將Timestamp類型存進(jìn)Elasticsearc后，將其取出時拋出異常。

從提示中可以看出缺少從Long轉(zhuǎn)換到Timestamp的類型轉(zhuǎn)換器。

原理及分析

在spring-data-elasticsearch中，java對象到j(luò)son的互相轉(zhuǎn)換是通過ElasticsearchConverter來進(jìn)行的。

使用springboot的自動配置機制能夠快速地完成elasticsearch的配置，導(dǎo)入spring-boot-starter-data-elasticsearch依賴后，spring將會自動向ioc容器中添加client，converter，template等Bean，只需要簡單地配置elasticSearch服務(wù)器信息后就可以使用。

在org.springframework.boot.autoconfigure.data.elasticsearch中通過@Import導(dǎo)入ElasticsearchDataConfiguration類，默認(rèn)的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則是當(dāng)容器中沒有相同類型的Bean才會進(jìn)行創(chuàng)建。

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

這里使用了MappingElasticsearchConverter來作為elasticsearch的默認(rèn)類型轉(zhuǎn)換器。

通過其源碼可以看出MappingElasticsearchConverter提供了兩種構(gòu)造方法，自動配置類使用的是第一種，其conversionService為空，MappingElasticsearchConverter會使用類DefaultConversionService對屬性conversions來進(jìn)行初始化，提供基礎(chǔ)的轉(zhuǎn)換功能。

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來設(shè)置自定義的轉(zhuǎn)換器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官方文檔章節(jié)6.1.3

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

使用方法

由于@ConditionalOnMissingBean的存在，我們只需要自己創(chuàng)建一個ElasticsearchConverter并添加到環(huán)境中既可。

首先先創(chuàng)建兩個Converter，分別用于Timestamp, Long的互相轉(zhuǎn)換。

@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的構(gòu)造方法發(fā)現(xiàn)，可以自行傳入ConversionService來初始化。

這里使用了defaultConversionService，避免其他的類型轉(zhuǎn)換受到影響，向其中添加自定義的兩個converter，并將其添加到MappingElasticsearchConverter構(gòu)造器參數(shù)中。

@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方法向其添加自定義轉(zhuǎn)換服務(wù)ElasticsearchCustomConversions。

首先創(chuàng)建一個ElasticsearchCustomConversions，添加兩個自定義的轉(zhuǎn)換器。

隨后在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;
}