Mongo BsonUndefined 转换问题（自定义Mongo类型转换器）

BsonUndefined 转换问题

关于这个问题的出现，是在业务中使用存储函数时，如果某个字段值为null，存入到数据库中会出现undefined，而随后查询会抛出ConverterNotFoundException异常信息，如下所示：

org.springframework.core.convert.ConverterNotFoundException: No converter found capable of converting from type [org.bson.BsonUndefined] to type [java.lang.Integer]

从异常信息可以看出是缺少Bson的类型转换器，当探寻mongo类型转换器的源码发现，的确没有BsonUndefined到基本数据类型的转换器。那么此问题要怎么解决呢？可以明确的解决方案有：

• 从数据源头解决问题，即使得不出现undefined
• 添加一个支持BsonUndefined的转换器。

若从源头解决，直接在调用存储函数的时候将每个字段做一次空处理，并且手动处理数据库中已存在的历史数据（设null值）；若自定义类型转换器，又该如何实现呢？

使用框架API插入数据时框架会做一次空处理，不会出现此情况

自定义Mongo类型转换器

要自定义Mongo的类型转换器，可以利用如下三个接口，具体每个接口使用说明请参见源码注释。

org.springframework.core.convert.converter.Converter
org.springframework.core.convert.converter.ConverterFactory
org.springframework.core.convert.converter.GenericConverter

BsonUndefined类型转换器定义

这里我们选择ConverterFactory来实现BsonUndefined类型转换器，首先定义转换器，如下所示：

这里选择将BsonUndefined转null处理

import org.bson.BsonUndefined;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import org.springframework.data.convert.ReadingConverter;

/**
 * @author lazycece
 * @date 2020/4/10
 */
@ReadingConverter
public class BsonUndefinedParseConverter implements ConverterFactory<BsonUndefined, Object> {

    @Override
    public <T extends Object> Converter<BsonUndefined, T> getConverter(Class<T> targetType) {
        return source -> null;
    }
}

然后将器注入到mongo的配置中即可，如下所示：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.core.convert.MongoCustomConversions;

import java.util.ArrayList;
import java.util.List;

/**
 * @author lazycece
 * @date 2020/4/13
 */
@Configuration
public class MongoConfig {

    @Bean
    public MongoCustomConversions mongoCustomConversions() {
        List<Object> converters = new ArrayList<>();
        converters.add(new BsonUndefinedParseConverter());
        return new MongoCustomConversions(converters);
    }
}

此时便可以解决问题了，为什么这样注入自定义类型转换器就可以解决问题了呢？就需要探寻mogno配置的源码了。

自定义转换器注入原理

笔者用的是SpringBoot进行开发，所以这里是分析SpringBoot对mongo转换器的自动配置源码。

SpringBoot在启动过程中自动配置mongo配置信息阶段，便会生成类型映射转换器MappingMongoConverter实例，此时会将默认的转换器注入，并且允许我们定义自己的类型转换器MongoCustomConversions；而当类型映射器创建成功之后即是生成MongoTemplate实例。关键源码如下所示：

@Configuration
@ConditionalOnBean(MongoDbFactory.class)
class MongoDbFactoryDependentConfiguration {

	private final MongoProperties properties;

	MongoDbFactoryDependentConfiguration(MongoProperties properties) {
		this.properties = properties;
	}

	@Bean
	@ConditionalOnMissingBean(MongoOperations.class)
	public MongoTemplate mongoTemplate(MongoDbFactory mongoDbFactory, MongoConverter converter) {
		return new MongoTemplate(mongoDbFactory, converter);
	}

	@Bean
	@ConditionalOnMissingBean(MongoConverter.class)
	public MappingMongoConverter mappingMongoConverter(MongoDbFactory factory, MongoMappingContext context,
			MongoCustomConversions conversions) {
		DbRefResolver dbRefResolver = new DefaultDbRefResolver(factory);
		MappingMongoConverter mappingConverter = new MappingMongoConverter(dbRefResolver, context);
		mappingConverter.setCustomConversions(conversions);
		return mappingConverter;
	}
	/**
	 *
	 * other class information
	 */
}

此时再跟进源码找到MongoCustomConversions实例的生成点，可以看见如下关键代码：

/**
 * Base configuration class for Spring Data's mongo support.
 *
 * @author Madhura Bhave
 */
@Configuration
class MongoDataConfiguration {

	private final ApplicationContext applicationContext;

	private final MongoProperties properties;

	MongoDataConfiguration(ApplicationContext applicationContext, MongoProperties properties) {
		this.applicationContext = applicationContext;
		this.properties = properties;
	}
    /**
	 *
	 * other class information
	 */

	@Bean
	@ConditionalOnMissingBean
	public MongoCustomConversions mongoCustomConversions() {
		return new MongoCustomConversions(Collections.emptyList());
	}

}

可以看出在生成MongoCustomConversions实例时用到了@ConditionalOnMissingBean注解，该注解的作用是：当未自定义时会生成一个空的MongoCustomConversions。所以我们自定义类型转换器的时候，手动注入MongoCustomConversions实例即可加入我们想要的类型转换器。