但行好事  莫问前程

fastjson SerializerFeature详解

1.添加依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.7</version>
</dependency>

2. 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 
WriteTabAsSpecial   把\t做转义输出,默认为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 
NotWriteRootClassName   含义  
BeanToArray 将对象转为array输出    
WriteNonStringKeyAsString   含义  
NotWriteDefaultValue    含义  
BrowserSecure   含义  
IgnoreNonFieldGetter    含义  
WriteEnumUsingName  含义

3. 演示示例

3.1 编写实体类User,Word来模拟各种数据类型
User实体如下(缺省setter,getter方法):

public class User {

    private int id;
    private String name;
    private String add;
    private String old;
}

Word实体如下(缺省setter,getter方法):

public class Word {

    private String d;
    private String e;
    private String f;
    private String a;
    private int b;
    private boolean c;
    private Date date;
    private Map<String , Object> map;
    private List<User> list;
}

3.2 编写Main进行测试
初始化数据如下:

public class Main {
    private static Word word;

    private static void init() {
        word = new Word();
        word.setA("a");
        word.setB(2);
        word.setC(true);
        word.setD("d");
        word.setE("");
        word.setF(null);
        word.setDate(new Date());

        List<User> list = new ArrayList<User>();
        User user1 = new User();
        user1.setId(1);
        user1.setOld("11");
        user1.setName("用户1");
        user1.setAdd("北京");
        User user2 = new User();
        user2.setId(2);
        user2.setOld("22");
        user2.setName("用户2");
        user2.setAdd("上海");
        User user3 = new User();
        user3.setId(3);
        user3.setOld("33");
        user3.setName("用户3");
        user3.setAdd("广州");

        list.add(user3);
        list.add(user2);
        list.add(null);
        list.add(user1);

        word.setList(list);
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("mapa", "mapa");
        map.put("mapo", "mapo");
        map.put("mapz", "mapz");
        map.put("user1", user1);
        map.put("user3", user3);
        map.put("user4", null);
        map.put("list", list);
        word.setMap(map);
    }

    public static void main(String[] args) {
        init();
        useSingleQuotes();
        // writeMapNullValue();
        // useISO8601DateFormat();
        // writeNullListAsEmpty();
        // writeNullStringAsEmpty();
        // sortField();
        // prettyFormat();
        // writeDateUseDateFormat();
        // beanToArray();
        //showJsonBySelf();
    }
}

3.2.1 UseSingleQuotes:使用单引号而不是双引号,默认为false

        /**
     * 1: UseSingleQuotes:使用单引号而不是双引号,默认为false
     */
    private static void useSingleQuotes() {
        System.out.println(JSONObject.toJSONString(word));
        System.out.println("设置useSingleQuotes后:");
        System.out.println(JSONObject.toJSONString(word,
                SerializerFeature.UseSingleQuotes));
    }

3.2.2 WriteMapNullValue:是否输出值为null的字段,默认为false

    /**
     * 2:WriteMapNullValue:是否输出值为null的字段,默认为false
     * 
     */
    private static void writeMapNullValue() {
        System.out.println(JSONObject.toJSONString(word));
        System.out.println("设置WriteMapNullValue后:");
        System.out.println(JSONObject.toJSONString(word, SerializerFeature.WriteMapNullValue));
    }

3.2.3 UseISO8601DateFormat:Date使用ISO8601格式输出,默认为false

    /**
     * 3:UseISO8601DateFormat:Date使用ISO8601格式输出,默认为false
     * 
     */
    private static void useISO8601DateFormat() {
        System.out.println(JSONObject.toJSONString(word));
        System.out.println("设置UseISO8601DateFormat后:");
        System.out.println(JSONObject.toJSONString(word, SerializerFeature.UseISO8601DateFormat));
    }

3.2.4 WriteNullListAsEmpty:List字段如果为null,输出为[],而非null,需要配合WriteMapNullValue使用,现将null输出

    /**
     * 4:
     * WriteNullListAsEmpty:List字段如果为null,输出为[],而非null
     * 需要配合WriteMapNullValue使用,现将null输出
     */
    private static void writeNullListAsEmpty() {
        word.setList(null);
        System.out.println(JSONObject.toJSONString(word));
        System.out.println("设置WriteNullListAsEmpty后:");
        System.out.println(JSONObject.toJSONString(word, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullListAsEmpty));
    }

3.2.5 WriteNullStringAsEmpty:字符类型字段如果为null,输出为””,而非null,需要配合WriteMapNullValue使用,现将null输出

    /**
     *  5:
     *  WriteNullStringAsEmpty:字符类型字段如果为null,输出为"",而非null
     *  需要配合WriteMapNullValue使用,现将null输出
     */
    private static void writeNullStringAsEmpty() {
        word.setE(null);
        System.out.println(JSONObject.toJSONString(word));
        System.out.println("设置WriteMapNullValue后:");
        System.out.println(JSONObject.toJSONString(word, SerializerFeature.WriteMapNullValue));
        System.out.println("设置WriteMapNullValue、WriteNullStringAsEmpty后:");
        System.out.println(JSONObject.toJSONString(word, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullStringAsEmpty));
    }

3.2.6 SortField:按字段名称排序后输出。默认为false

    /**
     * SortField:按字段名称排序后输出。默认为false
     * 这里使用的是fastjson:为了更好使用sort field martch优化算法提升parser的性能,fastjson序列化的时候,
     * 缺省把SerializerFeature.SortField特性打开了。
     * 反序列化的时候也缺省把SortFeidFastMatch的选项打开了。
     * 这样,如果你用fastjson序列化的文本,输出的结果是按照fieldName排序输出的,parser时也能利用这个顺序进行优化读取。
     * 这种情况下,parser能够获得非常好的性能。
     */
    private static void sortField() {
        System.out.println(JSON.toJSONString(word));
        System.out.println(JSON.toJSONString(word, SerializerFeature.SortField));
    }

3.2.7 PrettyFormat

 /**
     * 7:
     * PrettyFormat
     */
    private static void prettyFormat() {
        word.setMap(null);
        word.setList(null);
        System.out.println(JSON.toJSONString(word));
        System.out.println(JSON.toJSONString(word, SerializerFeature.PrettyFormat));
    }

3.2.8 WriteDateUseDateFormat:全局修改日期格式,默认为false。

    /**
     * 8:
     * WriteDateUseDateFormat:全局修改日期格式,默认为false。
     */
    private static void writeDateUseDateFormat() {
        word.setMap(null);
        word.setList(null);
        System.out.println(JSON.toJSONString(word));
        JSON.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd";
        System.out.println(JSON.toJSONString(word, SerializerFeature.WriteDateUseDateFormat));
    }

3.2.9 将对象转为array输出

     /**
     * 8:
     * 将对象转为array输出
     */
    private static void beanToArray() {
        word.setMap(null);
        word.setList(null);
        System.out.println(JSON.toJSONString(word));
        System.out.println(JSON.toJSONString(word, SerializerFeature.BeanToArray));
    }

3.2.9 自定义

     /**
     * 9:自定义
     * 格式化输出
     * 显示值为null的字段
     * 将为null的字段值显示为""
     * DisableCircularReferenceDetect:消除循环引用
     */
    private static void showJsonBySelf() {
        System.out.println(JSON.toJSONString(word));
        System.out.println(JSON.toJSONString(word, SerializerFeature.PrettyFormat,
                SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullStringAsEmpty,
                SerializerFeature.DisableCircularReferenceDetect,
                SerializerFeature.WriteNullListAsEmpty));
    }
打赏
欢迎关注人生设计师的微信公众账号
公众号ID:longjiazuoA

未经允许不得转载:人生设计师 » fastjson SerializerFeature详解

分享到:更多 ()

人生设计师-接受不同的声音

联系我关于我