你真的会用Gson吗?Gson使用指南(一)
2017-04-11 20:37
507 查看
导言
JSON (官网) 是一种文本形式的数据交换格式,它比XML更轻量、比二进制容易阅读和编写,调式也更加方便。其重要性不言而喻。解析和生成的方式很多,Java中最常用的类库有:JSON-Java、Gson、Jackson、FastJson等。文章的主要内容
GSON的基本用法
Gson提供了
fromJson()和
toJson()两个直接用于解析和生成的方法,前者实现反序列化,后者实现了序列化。同时每个方法都提供了重载方法.
POJO类的生成和解析
POJO类的定义public class User { private int age; private String name; private String emailAddress; //省略getter,setter }
生成JSON
Gson gson = new Gson(); User person = new User("Jack",24); String json = gson.toJson(person);
解析JSON
Gson gson = new Gson(); String json = "{\"age\":24,\"name\":\"Jack\"}"; User user = gson.fromJson(json, User.class);
属性重命名 @SerializedName 注解的使用
从上面POJO的生成与解析可以看出json的字段和值是的名称和类型是一一对应的,但有时候也会出现一些不和谐的情况,如:期望的json格式
{"name":"Jack","age":24,"emailAddress":"ikidou@example.com"}
实际
{"name":"Jack","age":24,"email_address":"ikidou@example.com"}
这对于使用PHP作为后台开发语言时很常见的情况,php和js在命名时一般采用下划线风格,而Java中一般采用的驼峰法,让后台的哥们改吧 前端和后台都不爽,但要自己使用下划线风格时我会感到不适应,怎么办?难到没有两全齐美的方法么?
我们知道
Gson在序列化和反序列化时需要使用反射,说到反射就不得不想到注解,一般各类库都将注解放到
annotations包下,打开源码在
com.google.gson包下果然有一个
annotations,里面有一个
SerializedName的注解类,这应该就是我们要找的。
那么对于json中email_address这个属性对应POJO的属性则变成:
@SerializedName("email_address") public String emailAddress;
这样的话,很好的保留了前端、后台、Android/java各自的命名习惯。
你以为这样就完了么?
如果接中设计不严谨或者其它地方可以重用该类,其它字段都一样,就
emailAddress字段不一样,比如有下面三种情况那怎么?重新写一个?
{"name":"Jack","age":24,"emailAddress":"ikidou@example.com"}
{"name":"Jack","age":24,"email_address":"ikidou@example.com"}
{"name":"Jack","age":24,"email_address":"ikidou@example.com"}
为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\":\"Jack\",\"age\":24,\"emailAddress\":\"ikidou_1@example.com\",\"email\":\"ikidou_2@example.com\",\"email_address\":\"ikidou_3@example.com\"}"; User user = gson.fromJson(json, User.class); System.out.println(user.getEmailAddress()); // ikidou_3@example.com
GSON对于数组的解析
例如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); for (String string : strings) { System.out.println(string); }
使用List解析
但对于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());
注:
TypeToken的构造方法是
protected修饰的,所以上面才会写成
new TypeToken<List<String>>() {}.getType()而不是
new TypeToken<List<String>>().getType().
Gson中使用泛型
关于引入泛型的介绍
通过引入泛型可以减少无关的代码,如我现在所在公司接口返回的数据分为两类:{"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; }
那么对于data字段是User时则可以写为 Result ,当是个列表的时候为 Result
引入泛型的实现
没有引入泛型之前时写法,public class UserResult { public int code; public String message; public User data; } //========= public class UserListResult { public int code; public String message; public List<User> data; } //========= String json = "{..........}"; Gson gson = new Gson(); UserResult userResult = gson.fromJson(json,UserResult.class); User user = userResult.data; UserListResult userListResult = gson.fromJson(json,UserListResult.class); List<User> users = userListResult.data;
上面有两个类UserResult和UserListResult,有两个字段重复,一两个接口就算了,如果有上百个怎么办?不得累死?所以引入泛型。
//不再重复定义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;
看出区别了么?引入了泛型之后虽然要多写一句话用于获取泛型信息,但是返回值类型很直观,也少定义了很多无关类。
原参考博客地址
http://www.jianshu.com/p/e740196225a4
相关文章推荐
- Gson解析使用指南
- 你真的会用Gson吗?Gson使用指南(二)
- Gson使用指南(一)
- 你真的会用Gson吗?Gson使用指南(三)
- 你真的会用Gson吗?Gson使用指南(二)
- Google的JSON包GSON使用指南
- Gson使用指南(3)
- 你真的会用Gson吗?Gson使用指南(三)
- 你真的会用Gson吗?Gson使用指南(二)
- Gson使用指南(2)
- 你真的会用Gson吗?Gson使用指南(三)
- Gson使用指南
- Gson使用指南
- 你真的会用Gson吗?Gson使用指南(四)
- 你真的会用Gson吗?Gson使用指南(二)
- 你真的会用Gson吗?Gson使用指南(一)
- Gson使用指南
- 你真的会用Gson吗?Gson使用指南(四)
- 你真的会用Gson吗?Gson使用指南(一)
- Gson使用指南(1)