后台服务返回Json数据出现$ref的问题解决方案

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/pp_fzp/article/details/81983105

问题出现:使用FastJson的JSONArray类型作为返回数据,当像JSONArray对象中添加JSONObject对象,而JSONObject对象中包含相同的节点数据时,FastJson会防止返回数据栈溢出的问题,自动将JSONArray中相同的节点数据使用引用方式代替,即:{"$ref":$....[0]}

解决方案:

FastJson提供了相关的配置参数禁用循环引用。所以当我们再返回数据前对JSONArray进行进行操作即可,代码如下:

// jsonArray参数为原要返回的JSONArray数据
JSONArray jsonArrayRtn= JSONArray.parseArray(JSON.toJSONString(jsonArray, SerializerFeature.DisableCircularReferenceDetect));

当然FastJson还提供了其它配置参数,源文件如下:

//
// 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;
        }
    }
}
名称 含义 备注
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   不推荐

猜你喜欢

转载自blog.csdn.net/pp_fzp/article/details/81983105