fastjson2 和 spring 版本冲突问题解决，附各种 json 工具消息转换器写法

项目场景：

SpringMVC的HttpMessageConverter(消息转换器)自定义，原使用 fastjson1 ，需要升级为 fastjson2。
spring web版本为4.3.6，fastjson1版本为1.2.83， fastjson2版本为2.0.34。

问题描述

调用接口报错：

Caused by: java.lang.NoSuchMethodError: org.springframework.http.converter.HttpMessageNotReadableException.<init>(Ljava/lang/String;Ljava/lang/Throwable;Lorg/springframework/http/HttpInputMessage;)V
        at com.alibaba.fastjson2.support.spring.http.converter.FastJsonHttpMessageConverter.readType(FastJsonHttpMessageConverter.java:113)
        at com.alibaba.fastjson2.support.spring.http.converter.FastJsonHttpMessageConverter.read(FastJsonHttpMessageConverter.java:80)
        at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(AbstractMessageConverterMethodArgumentResolver.java:201)复制

原因分析：

原因：fastjson2 和 spring 版本冲突。

FastJson2 在 Spring 框架中作为 HTTP 消息转换器使用时，FastJsonHttpMessageConverter 类在尝试读取数据并将其转换为相应类型时，调用了上述 org.springframework.http.converter.HttpMessageNotReadableException 构造方法，该方法应接受三个参数：一个字符串类型（错误信息），一个 Throwable 类型（异常原因）和一个 org.springframework.http.HttpInputMessage 类型（HTTP 输入消息对象）:

但是运行环境中的 Spring HTTP 消息转换器不包含3个参数的构造方法:

解决方案：

1.这里的消息转换器和其他部分是完全解耦的，所以可以单独回退版本为：fastjson1.2.83

import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    FastJsonHttpMessageConverter messageConverter = new FastJsonHttpMessageConverter();
    messageConverter.setSupportedMediaTypes(Lists.newArrayList(MediaType.APPLICATION_JSON));
    FastJsonConfig fastJsonConfig = new FastJsonConfig();
    fastJsonConfig.setSerializeFilters(new NullValuePropertyFilter());
    fastJsonConfig.setSerializerFeatures(WriteMapNullValue, QuoteFieldNames, DisableCircularReferenceDetect);
    messageConverter.setFastJsonConfig(fastJsonConfig);
    converters.add(messageConverter);
}复制

2.使用 jackson 作为 HTTP 消息转换器

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    //在json转换之前先进行string转换, 否则会报错
    converters.add(new StringHttpMessageConverter());
    MappingJackson2HttpMessageConverter jacksonConverter = new MappingJackson2HttpMessageConverter();
    List<MediaType> supportedMediaTypes = Collections.singletonList(MediaType.APPLICATION_JSON);
    jacksonConverter.setSupportedMediaTypes(supportedMediaTypes);
    ObjectMapper objectMapper = new ObjectMapper();
    // 处理循环引用
    objectMapper.disable(SerializationFeature.FAIL_ON_SELF_REFERENCES);
    // 配置序列化时包含null值
    objectMapper.enable(SerializationFeature.WRITE_NULL_MAP_VALUES);
    jacksonConverter.setObjectMapper(objectMapper);
    converters.add(jacksonConverter);
}复制

3.升级 spring 版本

其他：

//fastjson2作为消息转换器
import com.alibaba.fastjson2.JSONWriter;
import com.alibaba.fastjson2.support.config.FastJsonConfig;
import com.alibaba.fastjson2.support.spring.http.converter.FastJsonHttpMessageConverter;
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    FastJsonHttpMessageConverter messageConverter = new FastJsonHttpMessageConverter();
    messageConverter.setSupportedMediaTypes(Lists.newArrayList(MediaType.APPLICATION_JSON));
    FastJsonConfig fastJsonConfig = new FastJsonConfig();
    fastJsonConfig.setWriterFilters(new NullValuePropertyFilter());
    // fastjson1 的 SerializerFeature.DisableCircularReferenceDetect:
    // 在fastjson2 中，代替的是 JSONWriter.Feature.ReferenceDetection，但语义相反，缺省不一样。
    // fastjson2 中的 JSONWriter.Feature.ReferenceDetection 缺省是关闭的，而 fastjson1 是默认打开的。
    fastJsonConfig.setWriterFeatures(JSONWriter.Feature.WriteNulls);
    messageConverter.setFastJsonConfig(fastJsonConfig);
    converters.add(messageConverter);
}复制

fastjson2 官方明确说明 兼容 spring5 和 spring6，未对更早的版本给予说明。