使用 Gson 序列化时无故多了一层 nameValuePairs 结构

一、咋了？

今天调接口的时候，抓包发现我们传入接口的数据结构中出现一个奇怪的层级，即图中的 nameValuePairs

image.png

这个结构是不符合预期的，预期中的结构应该是这样，没有中间 nameValuePairs 这一层：

{
    "event_data":{
        "version":"0.0.0",
        "status":200
    }
}

那这个 nameValuePairs 是咋来的呢？

二、咋回事？

经过调试，发现问题出现在 new Gson().toJson() 这个方法上。这个问题要从系统自带的 JSONObject 说起。
我们传给接口的结构中，构建了一个 bean 类，其中有一个参数是 JSONObject 类型，点进去就会发现里面有一个 Map 名字叫 nameValuePairs，如下图：

image.png

JSONObject 中构建了 nameValuePairs 这个 Map，对 json 对象的操作最终都是通过这个 Map 完成的。那么很容易理解，其实 JSONObject 是对 nameValuePairs 又封装了一层，在 Gson 视角中，json 对象本身层级确实比 nameValuePairs 高一层。
当我们调用 Gson.toJson() 去解析时， JSONObject 中 nameValuePairs 这个 Map 整个作为一个 json 结构中的一个 value，而 nameValuePairs 这个名字本身就充当了 key。事实上，Gson 在嵌套 json 对象的解析上一直存在一些问题。

三、咋解决？

在使用 gson 解析的前提下，目前想到可行的办法有两个：
1、使用 Map 替代 JSONObject，用下面代码实验一下

        try {
            JSONObject jsonObject = new JSONObject("{\n" +
                    "\t\"jsonkey1\":\"jsonvalue1\",\n" +
                    "\t\"jsonkey2\":\"jsonvalue2\"\n" +
                    "}");
            Map map = new HashMap();
            map.put("mapkey1", "mapvalue1");
            map.put("mapkey2", "mapvalue2");
            JSONObject jsonObject1 = new JSONObject();
            jsonObject1.put("sub", jsonObject);
            LogUtils.d("jsontest : " + jsonObject 
                    + "\n jsonObject1 : " + jsonObject1 
                    + "\n jsonTo : " + new Gson().toJson(jsonObject) 
                    + "\n mapTo : " + new Gson().toJson(map));
        } catch (JSONException e) {
            throw new RuntimeException(e);
        }

日志打印结果如下：

jsontest : {"jsonkey1":"jsonvalue1","jsonkey2":"jsonvalue2"} 
jsonObject1 : {"sub":{"jsonkey1":"jsonvalue1","jsonkey2":"jsonvalue2"}}   
jsonTo :{"nameValuePairs":{"jsonkey1":"jsonvalue1","jsonkey2":"jsonvalue2"}}
mapTo : {"mapkey2":"mapvalue2","mapkey1":"mapvalue1"}

可以看到，new Gson().toJson() 传参为 JSONObject 类型时，多加上了 nameValuePairs 这一层；传参为 Map 类型时，才是符合预期的结构。同时通过 jsonObject1 的结果可以看到单纯的两层 json 嵌套也是没问题的

image.png

再通过代码验证一下：

JsonObject json = new JsonObject();
json.addProperty("jsonkey1", "jsonvalue1");
json.addProperty("jsonkey2", "jsonvalue2");
LogUtils.d("json : " + json
          + "\n jsonTo : " + new Gson().toJson(json));

Gson 中的 JsonObject 是无参构造，没有 put() 方法，只有 addProperty()

日志如下：

json : {"jsonkey1":"jsonvalue1","jsonkey2":"jsonvalue2"}
jsonTo : {"jsonkey1":"jsonvalue1","jsonkey2":"jsonvalue2"}

输出结果也没有问题。