背景说明
在使用fastjson 1.2.60版本将对象转化为json字符串时,为处理Map值为null的情况,采用了WRITE_MAP_NULL_FEATURES属性,但该属性解析出来的key中缺少双引号,在key包含特殊字符时,如“-”和“:",下游服务在进行反序列化时出现无法解析的错误,从而出现问题。
Fastjson SerializerFeature介绍
使用fastjson解析为字符串时,需要处理一些特殊情况,比如想要在解析后的字符串中显示对象中为null的字段。这个时候就需要用到fastjson的SerializerFeature序列化属性,有以下几个常用属性:
属性 | 含义 |
---|---|
QuoteFieldNames | 输出key时是否使用双引号,默认为true |
UseSingleQuotes | 使用单引号而不是双引号,默认为false |
WriteMapNullValue | 是否输出值为null的字段,默认为false |
WriteEnumUsingToString | Enum输出name()或者original,默认为false |
UseISO8601DateFormat | Date使用ISO8601格式输出,默认为false |
WriteNullListAsEmpty | List字段如果为null,输出为[],而非null |
WriteNullStringAsEmpty | 字符类型字段如果为null,输出为”“,而非null |
WriteNullNumberAsZero | 数值字段如果为null,输出为0,而非null |
WriteNullBooleanAsFalse | Boolean字段如果为null,输出为false,而非null |
SkipTransientField | 如果是true,类中的Get方法对应的Field是transient,序列化时将会被忽略。默认为true |
SortField | 按字段名称排序后输出。默认为false |
PrettyFormat | 结果是否格式化,默认为false |
WriteClassName | 序列化时写入类型信息,默认为false。反序列化是需用到 |
DisableCircularReferenceDetect | 消除对同一对象循环引用的问题,默认为false |
WriteSlashAsSpecial | 对斜杠'/'进行转义 |
BrowserCompatible | 将中文都会序列化为uXXXX格式,字节数会多一些,但是能兼容IE 6,默认为false |
WriteDateUseDateFormat | 全局修改日期格式,默认为false。JSON.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd";JSON.toJSONString(obj, SerializerFeature.WriteDateUseDateFormat); |
DisableCheckSpecialChar | 一个对象的字符串属性中如果有特殊字符如双引号,将会在转成json时带有反斜杠转移符。如果不需要转义,可以使用这个属性。默认为false |
除了上述的属性之外,还有WRITE_MAP_NULL_FEATURES,是以下几个属性的组合:
public static final int WRITE_MAP_NULL_FEATURES
= WriteMapNullValue.getMask()
| WriteNullBooleanAsFalse.getMask()
| WriteNullListAsEmpty.getMask()
| WriteNullNumberAsZero.getMask()
| WriteNullStringAsEmpty.getMask()
;
fastjson WRITE_MAP_NULL_FEATURES 案列说明
map key不包含特殊字符
public static void main(String[] args) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", "小明");
map.put("age", 12);
map.put("sex", null);
System.out.println(JSON.toJSONString(map)); // {"name":"小明","age":12}
System.out.println(JSON.toJSONString(map, SerializerFeature.WriteMapNullValue)); // {"sex":null,"name":"小明","age":12}
System.out.println(JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES)); // {sex:null,name:"小明",age:12}
}
从上面测试可以看出,使用WRITE_MAP_NULL_FEATURES,输出的json字符串key中并不包含双引号,再进行反序列化测试结果:
public static void main(String[] args) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", "小明");
map.put("age", 12);
map.put("sex", null);
String test = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES); // {sex:null,name:"小明",age:12}
JSONObject jsonObject = JSON.parseObject(test);
System.out.println(JSON.toJSONString(jsonObject)); // {"name":"小明","age":12}
}
key包含特殊字符(“-” “:”)的反序列化
public static void main(String[] args) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", "小明");
map.put("age", 12);
map.put("sex", null);
// 包含特殊字符时 "-" 或者 ":"时
map.put("test:test", "test");
String test = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES);
System.out.println(test); // {test-test:"test",sex:null,name:"小明",age:12}
JSONObject jsonObject = JSON.parseObject(test);
System.out.println(JSON.toJSONString(jsonObject)); // 抛出异常 com.alibaba.fastjson.JSONException
}
结论
- 从上面的测试可以看出WRITE_MAP_NULL_FEATURES转化为json字符串时key是不包含双引号的,当key中不存在特殊字符("-"或“:")时,可以进行正常的反序列化操作,包含了上面的特殊字符时会出现无法解析的异常。
- 另外,对于不带双引号的key,Gson也存在这样的问题,但其可以正常解析含有"-"的特殊字符,无法解析包含":"情况。