Gson——简单使用

参考：http://www.jianshu.com/p/e740196225a4

一、将JavaBean转换成JsonObject

创建JavaBean

public class User {
	private String name;
	private String pwd;
	
	
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getPwd() {
		return pwd;
	}
	public void setPwd(String pwd) {
		this.pwd = pwd;
	}
}

转换：

public static void main(String[]args){
		//创建JavaBean对象
		User user = new User();
		user.setName("chen");
		user.setPwd("123");
		//创建gson
		Gson gson = new Gson();
		String data = gson.toJson(user);//利用toJson方法将JavaBean转换成Json
		System.out.println(data);//转换的值:{"name":"chen","pwd":"123"}
	}

如果javaBean中内嵌一个javaBean的json是什么：

假设工厂里面生产一批货物的javaBean:

public class Factory {
	private String name;
	private int number;
	private Goods good;
}

class Goods {
	private String name;
	private String color;
	private int weight;
}

那么输出的值是什么：

	public static void main(String[]args){
		//创建JavaBean对象
		Factory factory = new Factory();
		factory.setName("CandleFactory");
		factory.setNumber(1);
		Goods good = new Goods();
		good.setName("Orangle Candle");
		good.setColor("orange");
		good.setWeight(10);
		factory.setGood(good);
		
		//创建gson
		Gson gson = new Gson();
		String data = gson.toJson(factory);//利用toJson方法将JavaBean转换成Json
		System.out.println(data);//结果：{"name":"CandleFactory","number":1,"good":{"name":"Orangle Candle","color":"orange","weight":10}}
	}

二、将JsonObject转换成JavaBean

	public static void main(String[]args){
		String javaBean = "{\"name\":\"chen\",\"pwd\":\"123\"}";
		Gson gson = new Gson();
		//重点
		User user = gson.fromJson(javaBean, User.class);//调用fromJson()将Json转换成JavaBean
		System.out.println(user);//结果:User [name=chen, pwd=123]
	}

三、通过数组将多个javaBean转换成JsonArray

	public static void main(String[]args){
		User user1 = new User();
		user1.setName("A");
		user1.setPwd("123");
		User user2 = new User();
		user2.setName("B");
		user2.setPwd("456");
		User user3 = new User();
		user3.setName("C");
		user3.setPwd("789");
		
		Gson gson = new Gson();
		//重点
		String jsonArray = gson.toJson(new User[]{user1,user2,user3});//利用数组
		System.out.println(jsonArray);//结果：[{"name":"A","pwd":"123"},{"name":"B","pwd":"456"},{"name":"C","pwd":"789"}]
	}

四、通过数组将JsonArray转换成多个JavaBean

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		String jsonArray = "[{\"name\":\"A\",\"pwd\":\"123\"},{\"name\":\"B\",\"pwd\":\"456\"},{\"name\":\"C\",\"pwd\":\"789\"}]";
		Gson gson = new Gson();
		//重点
		User[] users = gson.fromJson(jsonArray,User[].class);//注意是：User[].class
		for(User user : users){
			System.out.println(user);
		}
		/* 结果：
		 * User [name=A, pwd=123]
		 * User [name=B, pwd=456]
		 * User [name=C, pwd=789]
		 */
	}

我们一般时候都是使用List这样的容器来存放JavaBean数据的，所以我们怎么将容器中的数据变成Json

五、将List中的JavaBean转换成Json（Map也是这样子的）

	public static void main(String[]args){
		//创建
		List<User> userItems = new ArrayList<>();
		for(int i=0; i<3; ++i){
			User user = new User();
			user.setName("Test:"+i);
			user.setPwd("asd:"+i+1);
			userItems.add(user);
		}
		//跟普通javaBean输出json方式一样
		Gson gson = new Gson();
		String jsonArray = gson.toJson(userItems);
		
		System.out.println(jsonArray);//结果：[{"name":"Test:0","pwd":"asd:01"},{"name":"Test:1","pwd":"asd:11"},{"name":"Test:2","pwd":"asd:21"}]
	}

六、将jsonArray数组转换成List

public static void main(String[]args){
		String jsonArray = "[{\"name\":\"Test:0\",\"pwd\":\"asd:01\"},{\"name\":\"Test:1\",\"pwd\":\"asd:11\"},{\"name\":\"Test:2\",\"pwd\":\"asd:21\"}]";
		Gson gson = new Gson();
		//知识点①
		Type type = new TypeToken<List<User>>(){}.getType();
		List<User> userItems = gson.fromJson(jsonArray, type);
		
		for(User user:userItems){
			System.out.println(user);
		}
		/*
		 * 结果：
		 * User [name=Test:0, pwd=asd:01]
		 * User [name=Test:1, pwd=asd:11]
		 * User [name=Test:2, pwd=asd:21]
		 */
	}

知识点①：

因为泛型具有擦除的特性，所以Google专门使用TypeToken这个类，来封装擦除。

又因为TypeToken是被protected修饰的类，所以需要使用

new TypeToken<List<User>>(){}.getType();

而不是

new TypeToken<List<User>>().getType();//少了个{}

最后，通过type获取List<User>

七：通过流来序列化(toJson)和反序列(fromJson)

序列化：

JsonWrite与OutputStream都是继承了Appendable所以，意思就是所有的输出流都可以作为参数。

public static void main(String[]args){
		Gson gson = new Gson();
		//自动方式
		User user = new User();
		user.setName("chen");
		user.setPwd("123");
		gson.toJson(user,System.out);//输出到控制台
		
		//利用流序列化的方法  手动序列化json
		JsonWriter writer = new JsonWriter(new OutputStreamWriter(System.out));
		try {
			writer.beginObject()
			.name("name").value("chen")
			.name("pwd").value("123")
			.endObject();
			writer.flush();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}

反序列化：

	public static void main(String[]args){
		String jsonObject = "{\"name\":\"chen\",\"pwd\":\"123\"}";
		StringReader strReader = new StringReader(jsonObject);//可以将String转换成StringReader流
		
		User user = new User();
		
		JsonReader reader = new JsonReader(strReader);
		try {
			reader.beginObject();
			//类似Iterator
			while (reader.hasNext()) {
			    String s = reader.nextName();
			    switch (s) {
			        case "name":
			            user.setName(reader.nextString());
			            break;
			        case "pwd":
			        	user.setPwd(reader.nextString());
			        	break;
			    }
			}
			reader.endObject();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		System.out.println(user);
	}

八、使用GsonBuilder

为什么要有GsonBuilder？

Gson实现了大部分的功能，但还有小部分需要定制的功能，就需要使用GsonBuilder来创建。那么GsonBuilder有哪些功能呢？

创建GsonBuilder

Gson gson = new GsonBuilder().create();

功能①：利用serializeNulls()，显示null值

不使用GsonBuilder的时候，使用toJson是不显示成员变量的null值的。

public static void main(String[]args){
		User user = new User();
		user.setName("chen");
		
		Gson gson1 = new Gson();
		String jsonObject1 = gson1.toJson(user);
		System.out.println(jsonObject1);//{"name":"chen"}
		
		Gson gson2 = new GsonBuilder()
					.serializeNulls().create();//创建时调用serializeNulls()
		String jsonObject2 = gson2.toJson(user);
		System.out.println(jsonObject2);//{"name":"chen","pwd":null}
	}

功能②：setPrettyPrinting()格式化输出

对比不使用该方法和使用该方法，输出形式的区别

	public static void main(String[]args){
		User user = new User();
		user.setName("chen");
		user.setPwd("123");
		
		Gson gson1 = new Gson();
		String jsonObject1 = gson1.toJson(user);
		System.out.println(jsonObject1);
		/*
		 * 不使用时候的输出形式：
		 * {"name":"chen","pwd":"123"}
		 */
		
		Gson gson2 = new GsonBuilder()
					.setPrettyPrinting().create();//创建时调用serializeNulls()
		String jsonObject2 = gson2.toJson(user);
		System.out.println(jsonObject2);
		/*
		 * 使用后的输出形式：
		 * {
		 *   "name": "chen"
		 *   "pwd": "123"
		 * }
		 */
	}

其他功能总汇：

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