fastjson使用toJSONString时null值不序列化

image.png

问题描述：

在使用fastjson调用

JSON.toJSONString(obj);

方法将对象转换为json字符串时，如果对象obj的属性字段有值为null时，该属性字段不会被序列化。
比如：定义一个User实体类

public class User {
    private Integer id;
    private String name;
    private String icon;
    private Integer gender;

    public User(Integer id, String name, String icon, Integer gender) {
        this.id = id;
        this.name = name;
        this.icon = icon;
        this.gender = gender;
    }
}

创建一个User实体对象，并进行打印

User user = new User(1, "小明", null, 2);
String s = JSON.toJSONString(user);
System.out.println(s);

这里可以看到打印结果如下：

{"gender":2,"id":1,"name":"小明"}

并没有属性字段icon。
如果就这样回传数据给前端的话，可能会引起一些误会。下面来分析一下该问题。

问题分析：

其实fastjson的toJSONString()方法能传入的参数还可以增加枚举类型。
fastjson有一个枚举类SerializerFeature可以来设置转换时候的配置。
简单来说几个枚举类SerializerFeature常用的类型：

    QuoteFieldNames,        // 输出key时是否使⽤双引号，默认为true
    WriteMapNullValue,      // 是否输出值为null的属性字段，默认为false
    WriteNullListAsEmpty,   // List类型字段如果为null，输出为[]
    WriteNullStringAsEmpty, // String类型字段如果为null，输出为""
    WriteNullNumberAsZero,  // Number类型字段如果为null，输出为0
    WriteNullBooleanAsFalse,// Boolean类型字段如果为null，输出为false

解决方法：

通过上面的字段描述可以看到属性字段为null时没有输出是因为缺少WriteMapNullValue枚举类型，要解决这个问题，只需要在调用toJSONString()方法时加上WriteMapNullValue即可，如下：

JSON.toJSONString(obj, SerializerFeature.WriteMapNullValue);

在使用时，也可以根据自己的需求来添加其他枚举类型，直接在后边添加即可。

最后，希望可以帮助到有需要的码友。