Gson的简单实用

来源:互联网 发布:微信分销php开发手册 编辑:程序博客网 时间:2024/06/05 19:34

Gson 是 Google 提供的用来在 Java 对象和 JSON 数据之间进行映射的 Java 类库。可以将一个 JSON 字符串转成一个 Java 对象,或者反过来。
JSON (官网) 是一种文本形式的数据交换格式,它比XML更轻量、比二进制容易阅读和编写,调式也更加方便。

jar和源码下载地址: http://code.google.com/p/google-gson/downloads/list

一、Gson的基本用法

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

基本数据类型的生成

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

基本数据类型的解析

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

POJO类的生成与解析

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

生成JSON:

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

解析JSON:

Gson gson = new Gson();String jsonString = "{\"name\":\"怪盗kidou\",\"age\":24}";User user = gson.fromJson(jsonString, User.class);

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

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

期望的json格式

{"name":"怪盗kidou","age":24,"emailAddress":"ikidou@example.com"}

实际json格式

{"name":"怪盗kidou","age":24,"email_address":"ikidou@example.com"}

可以通过注解的方式解决上面的字段名字对不上的问题
那么对于json中email_address这个属性对应POJO的属性则变成:

@SerializedName("email_address")public String emailAddress;

如果接中设计不严谨或者其它地方可以重用该类,其它字段都一样,就emailAddress 字段不一样,比如有下面三种情况那怎么?重新写一个?

{"name":"怪盗kidou","age":24,"emailAddress":"ikidou@example.com"}
{"name":"怪盗kidou","age":24,"email_address":"ikidou@example.com"}
{"name":"怪盗kidou","age":24,"email":"ikidou@example.com"}

可以通过下面的方式解决上面的问题

@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.class 是行不通的。对于Java来说List 和List 这俩个的字节码文件只一个那就是List.class,这是Java泛型使用时要注意的问题 泛型擦除。

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

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则几乎不用。如果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;}

希望可以帮助需要的同学
参考文章:
http://www.jianshu.com/p/e740196225a4
http://blog.csdn.net/lk_blog/article/details/7685169

原创粉丝点击