Gson全解析

JSON (官网) 是一种文本形式的数据交换格式，它比XML更轻量、比二进制容易阅读和编写，调式也更加方便。其重要性不言而喻。解析和生成的方式很多，Java中最常用的类库有：JSON-Java、Gson、Jackson、FastJson等，本次我向大家介绍的是Gson。

本篇文章内容

• Gson的基本用法
• 属性重命名@SerializedName注解的使用
• Gson中使用泛型

一、Gson的基本用法

Gson提供了fromJson()和toJson()两个直接用于解析和生成的方法，前者用于实现反序列化，后者用来实现序列化。同时每个方法都提供了重载方法，常用的有5个。

基本数据类型的解析

Gson gson = new Gson();
int i = gson.fromJson("100",int.class);
double d = gson.fromJson("\"99.99\"",double.class);
bolean b = gson.fromJson("true",boolean.class);
String str = gson.fromJson("String",String.class);

基本数据类型的生成

Gson gson = new Gson();
String jsonNumber = gson.toJson(100);       // 100
String jsonBoolean = gson.toJson(false);    // false
String jsonString = gson.toJson("String"); //"String"

POJO类的生成与解析

public class User {
    //省略其它
    public String name;
    public int age;
    public String emailAddress;
}

生成Json

Gson gson = new Gson();
User = new User("yesyourhighness",27);
String jsonObject = gson.toJson(user); //{"name":"yesyourhighness","age""24}

解析Json

Gson gson = new Gson();
String jsonString = "{\''name\":\"yesyourhighness\",\"age\":27}";
User user = gson.fromJson(jsonString,User.class);

二、属性重命名@SerializedName注解的使用

从上面POJO的生成与解析可以看出json的字段和值是的名称和类型是一一对应的，但有时候也会出现一些不和谐的情况，如：
期望的json格式
{"name":"yesyourhighness","age":27,"emailAddress":"guyuexd@126.com"}
实际格式
{"name":"yesyourhighness","age":27,"email_address":"guyuexd@126.com"}
这对于使用PHP作为后台开发语言时很常见的情况，php和js在命名时一般采用下划线风格，而Java中一般采用的驼峰法，让后台的哥们改吧 前端和后台都不爽，但要自己使用下划线风格时我会感到不适应，怎么办?
那么对于json中email_address这个属性对应POJO的属性则变成：

@SerializedName("email_address")
public String emailAddress;

这样的话，很好的保留了前端、后台、Android/java各自的命名习惯。

如果接中设计不严谨或者其它地方可以重用该类，其它字段都一样，就emailAddress 字段不一样，比如有下面三种情况那怎么?
{"name":"yesyourhighness","age":27,"emailAddress":"ikidou@example.com"}
{"name":"yesyourhighness","age":27,"email_address":"ikidou@example.com"}
{"name":"yesyourhighness","age":27,"email":"ikidou@example.com"}

为POJO字段提供备选属性名
SerializedName注解提供了两个属性，上面用到了其中一个，别外还有一个属性alternate，接收一个String数组。

@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;

当上面的三个属性(email_address、email、emailAddress)都中出现任意一个时均可以得到正确的结果。

三、Gson中使用泛型

上面了解的JSON中的Number、boolean、Object和String，现在说一下Array。
例：JSON字符串数组

["Android","Java","PHP"]

当我们要通过Gson解析这个json时，一般有两种方式：使用数组，使用List。而List对于增删都是比较方便的，所以实际使用是还是List比较多。

数组比较简单

Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);

但对于List将上面的代码中的 String[].class 直接改为 List<String>.class 是行不通的。对于Java来说List<String> 和List<User>这俩个的字节码文件只一个那就是List.class，这是Java泛型使用时要注意的问题 泛型擦除。

为了解决的上面的问题，Gson为我们提供了TypeToken来实现对泛型的支持，所以当我们希望使用将以上的数据解析为List<String>时需要这样写。

Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {}.getType());

泛型解析对接口POJO的设计影响
泛型的引入可以减少无关的代码，如我现在所在公司接口返回的数据分为两类：

{"code":"0","message":"success","data":{}}

或者

{"code":"0","message":"success","data":[]}

我们真正需要的data所包含的数据，而code只使用一次，message则几乎不用。通过泛型的话我们可以将code和message字段抽取到一个Result的类中，这样我们只需要编写data字段所对应的POJO即可，更专注于我们的业务逻辑。如：

public class Result<T> {
    public int code;
    public String message;
    public T data;
}

那么对于data字段是User时则可以写为 Result<User> ,当是个列表的时候为 Result<List<User>>，其它同理。