Java常用json序列化工具的部分局限性

Problem

在写Java的Unit Test时，对于Unit Test所期望的值，一般是利用工具从test/resources目录下将expectResult.json读取进来并用json序列化工具进行反序列化来获得Unit Test所期望的结果，并与测试的实际结果进行对比。然而若是反序列化所用的类来源于第三方库（即不能更改任何代码），会遇到很大的问题。以下以本人对阿里云的StreamRecord类进行反序列化时遇到的问题进行描述：

StreamRecord类的定义如下：

public class StreamRecord {

    public enum RecordType {
        /**
         * PUT类型
         * 如果对应行已存在，该Record需要覆盖原有数据。
         */
        PUT,

        /**
         * UPDATE类型
         * 如果对应行已存在，该Record是在原有数据上的更新。
         */
        UPDATE,

        /**
         * DELETE类型
         * 表明要删除对应的行。
         */
        DELETE
    }

    /**
     * Record的类型
     */
    private RecordType recordType;

    /**
     * 对应行的主键
     */
    private PrimaryKey primaryKey;

    /**
     * 对应行的时序信息
     */
    private RecordSequenceInfo sequenceInfo;

    /**
     * 该Record包含的属性列，为RecordColumn类型
     */
    private List columns;

    /**
     * 获取Record的类型
     * @return Record的类型
     */
    public RecordType getRecordType() {
        return recordType;
    }

    public void setRecordType(RecordType recordType) {
        this.recordType = recordType;
    }

    /**
     * 获取对应行的主键
     * @return 对应行的主键
     */
    public PrimaryKey getPrimaryKey() {
        return primaryKey;
    }

    public void setPrimaryKey(PrimaryKey primaryKey) {
        this.primaryKey = primaryKey;
    }

    /**
     * 获取该行的时序信息
     * @return 该行的时序信息
     */
    public RecordSequenceInfo getSequenceInfo() {
        return sequenceInfo;
    }
    public void setSequenceInfo(RecordSequenceInfo sequenceInfo) {
        this.sequenceInfo = sequenceInfo;
    }

    /**
     * 获取该Record包含的属性列列表
     * @return 该Record包含的属性列列表
     */
    public List getColumns() {
        if (columns != null) {
            return columns;
        } else {
            return new ArrayList();
        }
    }

    public void setColumns(List columns) {
        this.columns = columns;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("[RecordType:]");
        sb.append(this.recordType);
        sb.append("\n[RecordSequenceInfo:]");
        sb.append(this.sequenceInfo);
        sb.append("\n[PrimaryKey:]");
        sb.append(this.primaryKey);
        sb.append("\n[Columns:]");
        for (RecordColumn column : this.getColumns()) {
            sb.append("(");
            sb.append(column);
            sb.append(")");
        }
        return sb.toString();
    }

}

本工程原先只用Jackson进行序列化和反序列化，但Jackson的ObjectMapper在对此类进行反序列化时，报了No suitable constructor的错误，经过调查发现Jackson进行反序列化需要默认的构造函数（如果有带参数的构造函数，还要用@JsonCreator修饰构造函数，用@JsonProperty修饰构造函数参数），而上述类没有，即使有我们也不能对阿里云等第三方库进行更改，遂放弃Jackson，转而考虑阿里自己的fastjson。fastjson的确能对该类进行反序列化，但是当我仔细分析反序列化后的对象时，发现有些深层的字段的值为null，又经过一番调查，了解到fastjson虽然对反序列化的类没有构造函数的要求，但对字段有要求，反序列化的private字段要有setter方法才能正常的反序列化（或者有一个带有所有字段参数的构造函数），若是private字段缺少setter方法，则该字段的值为默认值。最后考虑用Google的Gson，Gson没有上述这些问题，但是若反序列化类有Object类型的字段，而该字段的值为数值型，则Gson都会转为Double型，比如你有个字段为

private Map map;

json文件：

{
  "age": 24,
  "height": 1.81
}

当把上述json文件反序列化为map字段时，直觉上会认为“age”字段的值的类型应该为Integer或Long型，然而Gson这里有点反常，由于map的value为Object类型，并未明确指定具体的数值类型，它会将key为“age”的字段会变为Double类型（并不是我们直觉上所期望的Integer或Long型），给后续编程带来麻烦。关于Gson的这个“特性”，可以参考https://github.com/google/gson/issues/1084 上面的“debate”，比较有趣的“网友怼作者”。

我最终的解决方案是用Gson反序列化，再利用反射工具ReflectionTestUtils.setField来对某些数值进行Double到Long的转化。

Conclusion

• Jackson 功能强大，但对反序列化的类的要求较高（要有默认的constructor）。
• Fastjson 速度快，但是对反序列化的类也有一定要求，而且在反序列化复杂的json时bug较多（阿里云的很多sdk也由于这个原因并未使用fastjson）。
• Gson 比较全面，对反序列化的类的要求最低，但是对于Object类型的数值字段处理不够友好。
  以上实验所用版本：

  compile group: 'com.google.code.gson', name: 'gson', version: '2.8.5'
  compile group: 'com.alibaba', name: 'fastjson', version: '1.2.56'
  

因此，如果没有遇到序列化和反序列化第三方库的model的情况下（即代码无法更改的情况），首选Jackson，否则选Gson。