FastJson的SerializerFeature序列化特性说明

短命女 2022-03-02 11:55 800阅读 0赞

### FastJson的SerializerFeature序列化特性说明 ###

*  FastJson 简单使用
 *  SerializerFeature
 *  SerializerFeature 说明
 *   *  WriteEnumUsingName || WriteEnumUsingToString
     *  DisableCircularReferenceDetect
     *  WriteDateUseDateFormat

# FastJson 简单使用 #

我们在使用fastjson的时候，一般来讲，只需要使用最简单的API，例如

String text = JSONObject.toJSONString(obj); //序列化
    VO vo = JSONObject.parseObject("{...}", VO.class); //反序列化

# SerializerFeature #

但是如果我们希望我们的JSON对象在序列化和反序列化有一些特殊的要求，例如使用单引号而不是双引号，我们可以通过配置来达到。

#{ 'a':'a','aa':'aa','ab':'ab','b':{ 'a':{ "$ref":".."},'name':'B'},'name':'A'}
    JSONObject.toJSONString(obj, SerializerFeature.UseSingleQuotes,  SerializerFeature.WriteMapNullValue,SerializerFeature.MapSortField);

public enum SerializerFeature { 
        QuoteFieldNames,
        UseSingleQuotes,
        WriteMapNullValue,
        WriteEnumUsingToString,
        WriteEnumUsingName,
        UseISO8601DateFormat,
        WriteNullListAsEmpty,
        WriteNullStringAsEmpty,
        WriteNullNumberAsZero,
        WriteNullBooleanAsFalse,
        SkipTransientField,
        SortField,
        /** @deprecated */
        @Deprecated
        WriteTabAsSpecial,
        PrettyFormat,
        WriteClassName,
        DisableCircularReferenceDetect,
        WriteSlashAsSpecial,
        BrowserCompatible,
        WriteDateUseDateFormat,
        NotWriteRootClassName,
        /** @deprecated */
        DisableCheckSpecialChar,
        BeanToArray,
        WriteNonStringKeyAsString,
        NotWriteDefaultValue,
        BrowserSecure,
        IgnoreNonFieldGetter,
        WriteNonStringValueAsString,
        IgnoreErrorGetter,
        WriteBigDecimalAsPlain,
        MapSortField;
    }

# SerializerFeature 说明 #

<table> 
 <thead> 
  <tr> 
   <th align="center">名称</th> 
   <th align="center">含义</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">QuoteFieldNames</td> 
   <td align="center">输出key时是否使用双引号，默认为true</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">UseSingleQuotes</td> 
   <td align="center">使用单引号而不是双引号，默认为false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteMapNullValue</td> 
   <td align="center">是否输出值为null的字段，默认为false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteEnumUsingToString</td> 
   <td align="center">Enum输出name()或者original，默认为false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteEnumUsingName</td> 
   <td align="center">enum值序列化为其Name，默认为true</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">UseISO8601DateFormat</td> 
   <td align="center">Date使用ISO8601格式输出，默认为false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteNullListAsEmpty</td> 
   <td align="center">List字段如果为null,输出为[],而非null</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteNullStringAsEmpty</td> 
   <td align="center">字符类型字段如果为null,输出为”“,而非null</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteNullNumberAsZero</td> 
   <td align="center">数值字段如果为null,输出为0,而非null</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteNullBooleanAsFalse</td> 
   <td align="center">Boolean字段如果为null,输出为false,而非null</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">SkipTransientField</td> 
   <td align="center">如果是true，类中的Get方法对应的Field是transient，序列化时将会被忽略。默认为true</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">SortField</td> 
   <td align="center">按字段名称排序后输出。默认为false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteTabAsSpecial</td> 
   <td align="center">把\t做转义输出，默认为false</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">PrettyFormat</td> 
   <td align="center">结果是否格式化,默认为false</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">WriteClassName</td> 
   <td align="center">序列化时写入类型信息，默认为false。反序列化是需用到</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">DisableCircularReferenceDetect</td> 
   <td align="center">消除对同一对象循环引用的问题，默认为false</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">WriteSlashAsSpecial</td> 
   <td align="center">对斜杠’/’进行转义</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">BrowserCompatible</td> 
   <td align="center">将中文都会序列化为\uXXXX格式，字节数会多一些，但是能兼容IE 6，默认为false</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">WriteDateUseDateFormat</td> 
   <td align="center">全局修改日期格式,默认为false。</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">DisableCheckSpecialChar</td> 
   <td align="center">一个对象的字符串属性中如果有特殊字符如双引号，将会在转成json时带有反斜杠转移符。如果不需要转义，可以使用这个属性。默认为false</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">NotWriteRootClassName</td> 
   <td align="center">含义</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">BeanToArray</td> 
   <td align="center">将对象转为array输出</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">WriteNonStringKeyAsString</td> 
   <td align="center">将属性key写为String</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">NotWriteDefaultValue</td> 
   <td align="center">不设默认值</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">BrowserSecure</td> 
   <td align="center"></td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">IgnoreNonFieldGetter</td> 
   <td align="center">忽略没有getter方法的属性</td> 
   <td align="left">不推荐</td> 
  </tr> 
  <tr> 
   <td align="center">WriteNonStringValueAsString</td> 
   <td align="center">不是String的字段写为String</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">IgnoreErrorGetter</td> 
   <td align="center">忽略掉getter方法出错的属性</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">WriteBigDecimalAsPlain</td> 
   <td align="center">大数字写成文本</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="center">MapSortField</td> 
   <td align="center">字段按照TreeMap排序，默认false</td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

## WriteEnumUsingName || WriteEnumUsingToString ##

目前版本的fastjson默认对enum对象使用WriteEnumUsingName属性，因此会将enum值序列化为其Name。  
使用WriteEnumUsingToString方法可以序列化时将Enum转换为toString()的返回值；同时override toString函数能够将enum值输出需要的形式。但是这样做会带来一个问题，对应的反序列化使用的Enum的静态方法valueof可能无法识别自行生成的toString()，导致反序列化出错。  
如果将节省enum序列化后的大小，可以将enum序列化其ordinal值，保存为int类型。fastJson在反序列化时，如果值为int，则能够使用ordinal值匹配，找到合适的对象。  
fastjson要将enum序列化为ordinal只需要禁止WriteEnumUsingName feature。  
首先根据默认的features排除WriteEnumUsingName,然后使用新的features序列化即可。

int features=SerializerFeature.config(JSONObject.DEFAULT_GENERATE_FEATURE, SerializerFeature.WriteEnumUsingName, false)
    JSONObject.toJSONString(obj,features,SerializerFeature.EMPTY);

## DisableCircularReferenceDetect ##

当进行toJSONString的时候，默认如果重用对象的话，会使用引用的方式进行引用对象。

[  
          {   
            "$ref": "$.itemSkuList[0].itemSpecificationList[0]"  
          },   
          {   
            "$ref": "$.itemSkuList[1].itemSpecificationList[0]"  
          }  
        ]

循环引用  
很多场景中，我们需要序列化的对象中存在循环引用，在许多的json库中，这会导致stackoverflow。在功能强大的fastjson中，你不需要担心这个问题。例如：

@Test
    public void test(){ 
    	A a = new A();
    	B b = new B(a);
    	a.setB(b);
    	String text = JSONObject.toJSONString(a);
    	System.out.println(text);//{"b":{"a":{"$ref":".."},"name":"B"},"name":"A"}
    	A a1 = JSONObject.parseObject(text, A.class);
    	System.out.println(a1 == a1.getB().getA());//true
    
    	String text2 = JSONObject.toJSONString(a,SerializerFeature.DisableCircularReferenceDetect);//throw java.lang.StackOverflowError
    }
    
    @Data
    class A{ 
    	String name ;
    
    	B b;
    
    	public A(){ 
    		this.name = "A";
    	}
    }
    
    @Data
    class B{ 
    
    	String name ;
    	A a;
    
    	public B(){ 
    		this.name = "B";
    	}
    
    	public B(A a){ 
    		this.name = "B";
    		this.a = a;
    	}
    }

引用是通过"$ref"来表示的  
引用描述

"$ref":".."  上一级
    "$ref":"@"   当前对象，也就是自引用
    "$ref":"$"   根对象
    "$ref":"$.children.0"   基于路径的引用，相当于 root.getChildren().get(0)

## WriteDateUseDateFormat ##

JSONObject.DEFFAULT_DATE_FORMAT = “yyyy-MM-dd”;
    JSONObject.toJSONString(obj, SerializerFeature.WriteDateUseDateFormat);