Google的GSON处理JSON解析



Google的GSON处理JSON解析

其它文章：JS和JAVA使用JSON方法解析 http://blog.csdn.net/pplcheer/article/details/53098771

GSON是Google开发的Java API，用于转换Java对象和Json对象。本文讨论并提供了使用API的简单代码示例。

更多关于GSON的API可以访问：http://sites.google.com/site/gson/.

一、下载与安装

在使用GSON API工作之前，你需要下载库(jar文件)，并将其包含到类路径中。

库，连同源代码和Java文档，都可以从http://code.google.com/p/google-gson/downloads/list下载。下载完毕后，添加gson-<version>.jar到类路径。

对于那些偏好使用Maven管理依赖(JAR文件)的读者，添加如下依赖到pom.xml。

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
	<dependency>
	    <groupId>com.google.code.gson</groupId>
	    <artifactId>gson</artifactId>
	    <version>2.6.2</version>
	</dependency>

如果这个库用于web应用，请确保在WEB-INF/lib文件夹中保持一份拷贝。或者，GSON库可以放到应用服务器提供给web应用。

二、Gson的基本用法

Gson提供了fromJson() 和toJson() 两个直接用于解析和生成的方法，前者实现反序列化，后者实现了序列化。

同时每个方法都提供了重载方法，我常用的总共有5个。

代码片段：

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

		Gson gson = new Gson();
		
		//基本数据类型的解析
		int i = gson.fromJson("100", int.class);              //100
		double d1 = gson.fromJson("\"99.99\"", double.class);  //99.99
		double d2 = gson.fromJson("99.99", double.class);  //99.99
		boolean b = gson.fromJson("true", boolean.class);     // true
		String str = gson.fromJson("String", String.class);   // String
		System.out.println("基本数据类型的解析");
		System.out.println(" int i-> "+i+" double d-> "+d1+" boolean b-> "+b+
				" String str->"+str);

		//基本数据类型的生成		
		String jsonNumber1 = gson.toJson(100);       // 100
		String jsonNumber2 = gson.toJson("100");     //"100"
		String jsonBoolean = gson.toJson(false);    // false
		String jsonString = gson.toJson("String"); //"String"
		System.out.println("基本数据类型的生成");
		System.out.println(" jsonNumber1 -> "+jsonNumber1+" jsonNumber2 -> "+
		jsonNumber2+" jsonBoolean-> "+jsonBoolean+" jsonString-> "+jsonString);

		//POJO类的生成与解析
		
		//生成JSON：
		User user = new User("ppl",24);		
		// {"name":"ppl","age":24}
		String jsonObject1 = gson.toJson(user); 
		User user2 = new User("ppl",24,"[email protected]");		
		// {"name":"ppl","age":24,"emailAddress":"[email protected]"}
		String jsonObject2 = gson.toJson(user2); 

		System.out.println("POJO类的生成与解析-->生成JSON：");
		System.out.println("user jsonObject -> "+jsonObject1);
		System.out.println("user2 jsonObject2 -> "+jsonObject2);
		
		//解析JSON：
		String jsonString3 = "{\"name\":\"ppl\",\"age\":24}";
		//User [name=ppl, age=24, emailAddress=null]
		User user4 = gson.fromJson(jsonString3, User.class);
		System.out.println("POJO类的生成与解析-->解析JSON：");
		System.out.println("user4  -> "+user4);

Gson在默认情况下是不动导出值null的键的

可以看出，email字段是没有在json中出现的，当我们在调试是、需要导出完整的json串时或API接中要求没有值必须用Null时，就会比较有用。

使用方法：

Gson gson = new GsonBuilder()
        .serializeNulls()
        .create();
User user = new User("ppl", 24);
System.out.println(gson.toJson(user)); //{"name":"ppl","age":24,"email":null}

Gson gson = new GsonBuilder()
        //序列化null
        .serializeNulls()
        // 设置日期时间格式，另有2个重载方法
        // 在序列化和反序化时均生效
        .setDateFormat("yyyy-MM-dd")
        // 禁此序列化内部类
        .disableInnerClassSerialization()
        //生成不可执行的Json（多了 )]}' 这4个字符）
        .generateNonExecutableJson()
        //禁止转义html标签
        .disableHtmlEscaping()
        //格式化输出
        .setPrettyPrinting()
        .create();

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

从上面POJO的生成与解析可以看出json的字段和值是的名称和类型是一一对应的，但也有一定容错机制(如第一个例子第3行将字符串的99.99转成double型，你可别告诉我都是字符串啊)，
但有时候也会出现一些不和谐的情况，如：
期望的json格式

{"name":"ppl","age":24,"emailAddress":<a target=_blank href="mailto:[email protected]">[email protected]</a>}

实际

{"name":"ppl","age":24,"email_address":"[email protected]"}

这对于使用PHP作为后台开发语言时很常见的情况，php和js在命名时一般采用下划线风格，而Java中一般采用的驼峰法，让后台的哥们改吧 前端和后台都不爽，但要自己使用下划线风格时我会感到不适应，怎么办?难到没有两全齐美的方法么?

我们知道Gson在序列化和反序列化时需要使用反射，说到反射就不得不想到注解,一般各类库都将注解放到annotations包下，打开源码在com.google.gson包下果然有一个annotations，里面有一个SerializedName的注解类，这应该就是我们要找的。

那么对于json中email_address这个属性对应POJO的属性则变成：

@SerializedName("email_address")
public String emailAddress;

		//POJO类的生成与解析		
		//生成JSON：
		User user = new User("ppl",24);		
		// {"name":"ppl","age":24}
		String jsonObject1 = gson.toJson(user); 
		User user2 = new User("ppl",24,"[email protected]");		
		// {"name":"ppl","age":24,"email_address":"[email protected]"}
		String jsonObject2 = gson.toJson(user2);

这样的话，很好的保留了前端、后台、Android/java各自的命名习惯。
如果接中设计不严谨或者其它地方可以重用该类，其它字段都一样，就emailAddress 字段不一样，比如有下面三种情况那怎么?重新写一个?

{"name":"ppl","age":24,"emailAddress":"[email protected]"}

{"name":"ppl","age":24,"email_address":"[email protected]"}

{"name":"ppl","age":24,"email":"[email protected]"}

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

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

当上面的三个属性(email_address、email、emailAddress)都出现其中任意一个时均可以得到正确的结果。
注：当多种情况同时出时，以最后一个出现的值为准。

Gson gson = new Gson();
String json = "{\"name\":\"ppl\",\"age\":24,\"emailAddress\":\"[email protected]\",\"email\":\"[email protected]\",\"email_address\":\"[email protected]\"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // [email protected]

四、Gson中使用泛型

上面了解的JSON中的Number、boolean、Object和String，现在说一下Array。

例：JSON字符串数组

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

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

数组比较简单

//Gson中使用泛型
		String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
		
		//[Android, Java, PHP]
		String[] strings = gson.fromJson(jsonArray, String[].class);
		System.out.println("Gson中使用泛型");
		System.out.println(strings.toString()); 

但对于List将上面的代码中的 String[].class 直接改为 List<String>.class 是行不通的。对于Java来说List<String> 和List<User> 这俩个的字节码文件只一个那就是List.class，这是Java泛型使用时要注意的问题 泛型擦除。
为了解决的上面的问题，Gson为我们提供了TypeToken来实现对泛型的支持，所以当我们希望使用将以上的数据解析为List<String>时需要这样写。

//泛型擦除
		String jsonArray2 = "[\"Android\",\"Java\",\"PHP\"]";
		//[Android, Java, PHP]
		List<String> stringList = gson.fromJson(jsonArray2, new TypeToken<List<String>>() {}.getType());
		System.out.println("Gson中使用泛型擦除");

注：TypeToken的构造方法是protected修饰的,所以上面才会写成new TypeToken<List<String>>() {}.getType() 而不是 new TypeToken<List<String>>().getType()

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

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

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

{}是对象，Object；[]是数组，注意区分。

我们真正需要的data所包含的数据，而code只使用一次，message则几乎不用。如果Gson不支持泛型或不知道Gson支持泛型的同学一定会这么定义POJO。

public class UserResponse {
    public int code;
    public String message;
    public User data;
}

当其它接口的时候又重新定义一个XXResponse将data的类型改成XX，很明显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>>，其它同理。

//不再重复定义Result类
Type userType = new TypeToken<Result<User>>(){}.getType();
Result<User> userResult = gson.fromJson(json,userType);
User user = userResult.data;

Type userListType = new TypeToken<Result<List<User>>>(){}.getType();
Result<List<User>> userListResult = gson.fromJson(json,userListType);
List<User> users = userListResult.data;