fastjson:SerializerFeature屬性使用

琦彥發表於2017-11-08

fastjson:SerializerFeature原始碼

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.alibaba.fastjson.serializer;
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,
    DisableCheckSpecialChar,
    BeanToArray,
    WriteNonStringKeyAsString,
    NotWriteDefaultValue,
    BrowserSecure,
    IgnoreNonFieldGetter;
    private final int mask = 1 << this.ordinal();
    private SerializerFeature() {
    }
    public final int getMask() {
        return this.mask;
    }
    public static boolean isEnabled(int features, SerializerFeature feature) {
        return (features & feature.getMask()) != 0;
    }
    public static boolean isEnabled(int features, int fieaturesB, SerializerFeature feature) {
        int mask = feature.getMask();
        return (features & mask) != 0 || (fieaturesB & mask) != 0;
    }
    public static int config(int features, SerializerFeature feature, boolean state) {
        if(state) {
            features |= feature.getMask();
        } else {
            features &= ~feature.getMask();
        }
        return features;
    }
    public static int of(SerializerFeature[] features) {
        if(features == null) {
            return 0;
        } else {
            int value = 0;
            SerializerFeature[] var2 = features;
            int var3 = features.length;
            for(int var4 = 0; var4 < var3; ++var4) {
                SerializerFeature feature = var2[var4];
                value |= feature.getMask();
            }
            return value;
        }
    }
}

SerializerFeature屬性解釋

名稱 含義 備註
QuoteFieldNames 輸出key時是否使用雙引號,預設為true  
UseSingleQuotes 使用單引號而不是雙引號,預設為false  
WriteMapNullValue 是否輸出值為null的欄位,預設為false  
WriteEnumUsingToString

Enum輸出name()或者original,預設為false

 
  1. 目前版本的fastjon預設對enum物件使用WriteEnumUsingName屬性,因此會將enum值序列化為其Name。
  2. 使用WriteEnumUsingToString方法可以序列化時將Enum轉換為toString()的返回值;同時override toString函式能夠將enum值輸出需要的形式。但是這樣做會帶來一個問題,對應的反序列化使用的Enum的靜態方法valueof可能無法識別自行生成的toString(),導致反序列化出錯。
  3. 如果將節省enum序列化後的大小,可以將enum序列化其ordinal值,儲存為int型別。fastJson在反序列化時,如果值為int,則能夠使用ordinal值匹配,找到合適的物件。
    fastjson要將enum序列化為ordinal只需要禁止WriteEnumUsingName feature。
    首先根據預設的features排除WriteEnumUsingName,然後使用新的features序列化即可。

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

     

     

 
WriteEnumUsingName    
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  
WriteTabAsSpecial 把\t做轉義輸出,預設為false 不推薦
PrettyFormat 結果是否格式化,預設為false 不推薦
WriteClassName 序列化時寫入型別資訊,預設為false。反序列化是需用到 不推薦
DisableCircularReferenceDetect 消除對同一物件迴圈引用的問題,預設為false

當進行toJSONString的時候,預設如果重用物件的話,會使用引用的方式進行引用物件。

  1.  [  
  2.       {  
  3.         "$ref""$.itemSkuList[0].itemSpecificationList[0]"  
  4.       },   
  5.       {  
  6.         "$ref""$.itemSkuList[1].itemSpecificationList[0]"  
  7.       }  
  8.     ]  

 

迴圈引用

很多場景中,我們需要序列化的物件中存在迴圈引用,在許多的json庫中,這會導致stackoverflow。在功能強大的fastjson中,你不需要擔心這個問題。例如:

 

  1. A a = new A();  
  2. B b = new B(a);  
  3. a.setB(b);  
  4. String text = JSON.toJSONString(a); //{"b":{"a":{"$ref":".."}}}  
  5. A a1 = JSON.parseObject(text, A.class);  
  6. Assert.assertTrue(a1 == a1.getB().getA());  

     

引用是通過"$ref"來表示的

引用描述

  • "$ref":".."  上一級
  • "$ref":"@"   當前物件,也就是自引用
  • "$ref":"$"   根物件
  • "$ref":"$.children.0"   基於路徑的引用,相當於 root.getChildren().get(0)

 

 

 

不推薦
WriteSlashAsSpecial 對斜槓’/’進行轉義 不推薦
BrowserCompatible 將中文都會序列化為\uXXXX格式,位元組數會多一些,但是能相容IE 6,預設為false 不推薦
WriteDateUseDateFormat 全域性修改日期格式,預設為false。
JSON.DEFFAULT_DATE_FORMAT = “yyyy-MM-dd”;
JSON.toJSONString(obj, SerializerFeature.WriteDateUseDateFormat);
不推薦
DisableCheckSpecialChar 一個物件的字串屬性中如果有特殊字元如雙引號,將會在轉成json時帶有反斜槓轉移符。如果不需要轉義,可以使用這個屬性。預設為false 不推薦
NotWriteRootClassName 含義 不推薦
BeanToArray 將物件轉為array輸出 不推薦
WriteNonStringKeyAsString   不推薦
NotWriteDefaultValue   不推薦
BrowserSecure   不推薦
IgnoreNonFieldGetter   不推薦

JAVA使用

JSONObject.toJSONString(實體, SerializerFeature.WriteMapNullValue))

 

相關文章