JavaSpring boot 返回字段为null值被过滤

Posted 2022-11-25 攻城狮白玉

前言

最近因项目需要，从零开始重新搭建了一套框架给同事们用。在前后端对接的时候，发现后端提供的字段缺少了很多，即实体类为null值的字段，全部被过滤了。经排查，是fastjson的锅。

因为fastjson默认就把value为null的值给过滤掉，不输出空值。

 

俗话说，当你遇见问题时，找到问题的原因，你的问题就已经解决了一半。

环境：

• jdk1.8

• maven:3.6.3

• spring boot:2.2.13-RELEASE

• fastjson:1.28.0

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.80</version>
</dependency>

解决方法

解决方法也很简单，只需要加上一个配置文件即可，对于fastjson进行注解配置。

 

 其中，最主要的就是配置通过FastJsonConfig的setSerializerFeatures方法来配置fastJson的功能

com.alibaba.fastjson.support.config.FastJsonConfig#setSerializerFeatures

/**
 * 返回值过滤器
 * 
 * @Author: 攻城狮白玉 https://blog.csdn.net/zhh763984017
 * @Date: 2022/7/09 18:05
 */
@Configuration
public class FastjsonConverterConfig 

    @Bean
    public HttpMessageConverters customConverters() 
        // 定义一个转换消息的对象

        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();

        // 添加fastjson的配置信息 比如 ：是否要格式化返回的json数据
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        // 这里就是核心代码了，WriteMapNullValue把空的值的key也返回
        fastJsonConfig.setSerializerFeatures(SerializerFeature.WriteMapNullValue);

        List<MediaType> fastMediaTypes = new ArrayList<MediaType>();

        // 处理中文乱码问题
        fastJsonConfig.setCharset(Charset.forName("UTF-8"));
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        fastConverter.setSupportedMediaTypes(fastMediaTypes);
        // 在转换器中添加配置信息
        fastConverter.setFastJsonConfig(fastJsonConfig);

        StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
        stringConverter.setDefaultCharset(Charset.forName("UTF-8"));
        stringConverter.setSupportedMediaTypes(fastMediaTypes);

        // 将转换器添加到converters中
        return new HttpMessageConverters(stringConverter,fastConverter);
    

后记

从零开始搭一个新的框架出来真的是不容易。

尽管原来的框架依赖是多了点，重了点，但是旧有配置好的东西也多，是挺香的哇。

不过重新搭建新的框架，也让我重新审视了许多知识，对于框架的搭建使用上，该用奥卡姆剃刀的时候就得用奥卡姆剃刀，保持框架尽可能的干净。