Gson 中的一个坑

Gson 是谷歌出品的 json 库,功能强大,也很安全,很少出现安全漏洞,使用的很广泛。Gson 对类型要求的很严格,所以才比较少出现安全漏洞。

但 Gson 使用起来也比较繁琐,没有 fastjson 之类的类库使用起来那么简单,本文介绍一些使用 Gson 在处理字符串类型时需要注意的事项。

本文基于 Gson 2.8.6

先来看段代码:

1
2
3
4
5
6
7
8
9
10
Gson gson = new Gson();
HashMap<String, String> data = new HashMap<>();
data.put("ray", "jun");

String jsonString = gson.toJson(data);
JsonObject jsonObject = gson.fromJson(jsonString, JsonObject.class);

String str = String.valueOf(jsonObject.get("ray"));

assertTrue((str).equals("jun")); // false

上面的代码输出的结果是 false

再看下面的这段代码:

1
2
3
4
5
6
7
8
9
10
11
Gson gson = new Gson();
HashMap<String, Integer> data = new HashMap<>();
data.put("ray", 18);

String jsonString = gson.toJson(data);

JsonObject jsonObject = gson.fromJson(jsonString, JsonObject.class);

Integer integer = Integer.valueOf(String.valueOf(jsonObject.get("ray")));

assertTrue(integer == 18); // true

上面的代码输出的结果是 true。这两段代码基本一样,在结果上却不同,下面来看看问题出在哪里。

下面把第一段代码中两个值都打印出来:

1
2
3
4
String str = String.valueOf(jsonObject.get("ray"));

System.out.println("jun");
System.out.println(str);

1
2
jun
"jun"

第二个值明显和预期的不一样,问题就出在这里。

JsonObject 的 get 方法返回的是一个 JsonElement 的类型,JsonObject 也实现了这个类型,是 Gson 中所有类型的父类。

在上面的代码中,如果直接对 JsonElement 类型使用 String.valueOf,就会调用 JsonElement 方法的 toString 方法,大概代码如下:

1
2
3
4
5
StringWriter stringWriter = new StringWriter();
JsonWriter jsonWriter = new JsonWriter(stringWriter);
jsonWriter.setLenient(true);
Streams.write(this, jsonWriter);
return stringWriter.toString();

相当于会把当前的元素放入 StringWriter 中,然后再调用 StringWriter 的 toString 方法,获得结果。

到这里都没有问题,问题的关键在于对于字符串类型的值,在 JsonElement 中存储时,会在外面再加上一层引号。

所以字符串 "jun" 会被存储为 ""jun"",所以如果直接使用 toString 方法获得值时,字符串会多一层引号。

对于其他非字符串类型的值,在调用 valueOf 时,反而可以获取到正确的值。

但上面的用法其实都是错误的,如果需要获取特定的值,还是应该使用 Gson 提供的 getAsxx 系列方法。

文 / Rayjun

© 2020 Rayjun    PowerBy Hexo    京ICP备16051220号-1