FastJson序列化的注意点

深藏阁楼爱情的钟 2021-12-14 14:31 387阅读 0赞

最近在开发过程中，用FastJson将javabean序列化成String打印到日志中时，发现部分bean属性缺失检查发现，这是由于FastJson的序列化机制产生了影响

public class DemoBean {
        private String name;
        private Integer age;
        private boolean isMale;
        //注意看这个get方法名
        public String getRealName() {
            return name;
        }
        public Integer getAge() {
            return age;
        }
        public boolean isMale() {
            return isMale;
        }
    }

我们先定一个DemoBean，其中对于name属性的get方法，特殊命名，将该对象转jsonStr后结果为：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTQ0ODYx_size_16_color_FFFFFF_t_70]  
我们发现，打印时并没有打印出name属性，取而代之的是realName属性

这里就是FastJson的序列化规则产生了影响，它以Bean的get()方法来进行序列化工作，对于返回类型为boolean的方法是根据is()方法来进行序列化工作

关于源码，大家可以看下这个类com.alibaba.fastjson.util.TypeUtils.computeGetters(…)

所以当我们的javaBean中有属性的get()方法命名不一样时，通过FastJson转化出来的String 就会变得不一样

有什么办法让上面的例子不打印realName属性呢，可以使用

com.alibaba.fastjson.serializer.SerializerFeature
    
    System.err.println("DemoBean: " + JSON.toJSONString(demoBean, SerializerFeature.IgnoreNonFieldGetter));

下面附上几个常用的序列化特性

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>WriteMapNullValue</td> 
   <td>是否输出值为null的字段，默认为false</td> 
  </tr> 
  <tr> 
   <td>UseISO8601DateFormat</td> 
   <td>Date使用ISO8601格式输出，默认输出System.currentTimeMillis()</td> 
  </tr> 
  <tr> 
   <td>WriteNullStringAsEmpty</td> 
   <td>字符类型字段如果为null,输出为”“,而非null，默认为false</td> 
  </tr> 
  <tr> 
   <td>SortField</td> 
   <td>按字段名称排序后输出，默认为false</td> 
  </tr> 
  <tr> 
   <td>PrettyFormat</td> 
   <td>结果是否格式化，可视化输出(树形)，默认为false</td> 
  </tr> 
  <tr> 
   <td>WriteClassName</td> 
   <td>序列化时写入类型信息，反序列化是需用到，默认为false</td> 
  </tr> 
  <tr> 
   <td>DisableCircularReferenceDetect</td> 
   <td>消除对同一对象循环引用的问题，默认为false</td> 
  </tr> 
 </tbody> 
</table>

这里也说明下DisableCircularReferenceDetect特性  
FastJson循环引用检查默认开启的原因：在序列化前，会检查javaBean是否存在循环引用，如果有循环引用，则用$ref来表示，以避免StackOverflowError，我们看下例子

@Test
    public void test2() throws Exception {
        CircleDemoB demoB = new CircleDemoB();
        demoB.setDemoName("B");
        CircleDemoA demoA = new CircleDemoA();
        demoA.setDemoName("A");
    
    
        demoA.setCircleDemoB(demoB);
        demoB.setCircleDemoA(demoA);
    
        List demoList = new ArrayList();
        demoList.add(demoA);
        demoList.add(demoB);
        System.out.println("circleDemo: " + JSON.toJSONString(demoList));
        System.err.println("circleDemo: " + JSON.toJSONString(demoList, SerializerFeature.DisableCircularReferenceDetect));
    }

CircleDemoB 与CircleDemoA 存在循环引用，运行结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTQ0ODYx_size_16_color_FFFFFF_t_70 1]  
当开启循环引用检查时，通过$ref来打印该变量引用，而关闭了循环引用就会出现异常，所以对于特性的使用(开关)需要慎重

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTQ0ODYx_size_16_color_FFFFFF_t_70]: /images/20211214/481f460f49684bb28cdd1906ec0b00d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTQ0ODYx_size_16_color_FFFFFF_t_70 1]: /images/20211214/6b29f3c9ce394b0083429941bd3d5ce6.png