赞
踩
Gson 是google解析Json的一个开源框架,同类的框架fastJson,JackJson等等
本人fastJson用了两年,也是从去年才开始接触Gson,希望下面的总结会对博友有用,至于Gson与FastJson的对比,其实半斤八两的问题,不再赘述
第一步:在AS下面创建Java工程 并添加gson依赖
compile 'com.google.code.gson:gson:2.6.2'
Gson的实例化方式:
1:Gson gson=newGson();
2:通过GsonBuilder 可以配置多种选项
JavaBean转换Json字符串
gson提供 publicString toJson(Object src) 方法可以将对象转换成jsonStr
运行结果:
---->javabean convert jsonStr:{"name":"xuanyouwu","age":26}
List Map转Json字符串
Json字符串转JavaBean
------->json convert JavaBean:Student{name='xuanyouwu', age=26}
Json字符串转List
JsonPrimitive非常有意思,我们知道如果json转换成字符串 可能包含引号的转义,但是通过JsonPrimative我们可以获得为转义的字符串,看实例:
运行结果:
------>studentJsonStr:{"name":"xuanyouwu","age":26}
------>jsonPrimitive:"{\"name\":\"xuanyouwu\",\"age\":26}"
------>jsonPrimitive:"{\"name\":\"xuanyouwu\",\"age\":26}"
------>jsonPrimitive:{"name":"xuanyouwu","age":26}
------>jsonPrimitive2:"this is String"
------>jsonPrimitive2:"this is String"
------>jsonPrimitive2:this is String
创建JsonObject
通过addPropert(key,value)可以向jsonObject中添加字段 跟hashMap类似
------>create jsonObject:{"name":"xuanyouwu","age":26}
创建JsonArray
------>create jsonArray:["a","b","c","d"]
JsonObject 嵌套数组或者说嵌套JsonArray
通过JsonObject的add(key,JsonElement)可以为jsonObject 添加一个数组的字段
------>create jsonObject inner JsonArray:{"name":"xuanyouwu","age":26,"hobby":["骑车","打游戏","看电视"]}
Gson注解
在Gson中有五类注解
重命名注解:SerializedName
作用:转换关键字key,json转换成JavaBean时,json字段的key 默认必须和我们声明类的字段名称一样,当服务器端返回了关键字怎么办,比如key 为new switch这样,我们 在声明类的时候不能写这样的字段,可能你想服务器端改动,他可能要改数据库,但是我告诉你,做服务端的大部分不愿意改动他的json,是很自私的!这时候重命名注解都排上用场了 第二种场景:服务器端返回的json 的key 简直太丑,或者太长,你想简化,my_parent_name,可以简化成mpn 比较优雅简介
实例:
运行结果: ------>user:User{name='zhangsan', age=26, isnew=1}
运行结果: ------>user2:User2{name='zhangsan', age=26, pn='zhangsanf'}
作用2:结合alternate 提供多种备用字段key来解析,@SerializedName(value ="desc",alternate = {"other","note"}) 如果json中有other就会解析成desc 如果有note也会解析成desc,注意1:value中的值不能出现在alternate中,注意2:alternate的备选字段 会后面的替换前面的
实例:
------>user:User{name='zhangsan', age=26, desc='成都人'}
------>user:User{name='zhangsan', age=26, desc='成都人'}
------>user:User{name='zhangsan', age=26, desc='note成都人'}
------>user:User{name='zhangsan', age=26, desc='desc成都人'}
Gson @Expose过滤注解
源码:默认既可以序列化又可以反序列化
不添加@Expose注解的字段将不会解析:
分为以下几种情况:
1:不添加@Expose注解等同于@Expose(deserialize = false,serialize = false) 不做任何解析
2:@Expose(deserialize = true,serialize = false) 只解析用用,也就是反序列化可以,序列化不可以
3:@Expose(deserialize = false,serialize = true) 序列化可以,反序列化不行
4:@Expose(deserialize = true,serialize = true) 既可以序列化,也可以反序列化
实例:将分别演示这四种情况
不添加@Expose注解:等同于@Expose(deserialize = false,serialize = false)
- package com.xuan.gson;
- import com.google.gson.Gson;
- import com.google.gson.GsonBuilder;
- /**
- * @author xuanyouwu
- * @email xuanyouwu@163.com
- * @time 2016-05-18 11:20
- */
- public class GsonTest5 {
- private static void log(String msg) {
- System.out.println(msg);
- }
- public static class User {
- public String name;
- @Override
- public String toString() {
- return "User{" +
- "name='" + name + '\'' +
- '}';
- }
- }
- public static void main(String[] args) throws Exception {
- String jsonFromServer = "{\"name\": \"zhangsan\"}";
- Gson gson = new GsonBuilder()
- .excludeFieldsWithoutExposeAnnotation()
- .create();
- User user = gson.fromJson(jsonFromServer, User.class);
- log("------>反序列化:" + user);
- User user1 = new User();
- user1.name = "zhangsan2";
- String userStr = gson.toJson(user1);
- log("------>序列化:" + userStr);
- }
- }
运行结果:
------>反序列化:User{name='null'} ------>序列化:{}
添加@Expose注解
- package com.xuan.gson;
- import com.google.gson.Gson;
- import com.google.gson.GsonBuilder;
- import com.google.gson.annotations.Expose;
- /**
- * @author xuanyouwu
- * @email xuanyouwu@163.com
- * @time 2016-05-18 11:20
- */
- public class GsonTest5 {
- private static void log(String msg) {
- System.out.println(msg);
- }
- public static class User {
- @Expose //等同于 @Expose(deserialize = true,serialize = true)
- public String name;
- @Override
- public String toString() {
- return "User{" +
- "name='" + name + '\'' +
- '}';
- }
- }
- public static void main(String[] args) throws Exception {
- String jsonFromServer = "{\"name\": \"zhangsan\"}";
- Gson gson = new GsonBuilder()
- .excludeFieldsWithoutExposeAnnotation()
- .create();
- User user = gson.fromJson(jsonFromServer, User.class);
- log("------>反序列化:" + user);
- User user1 = new User();
- user1.name = "zhangsan2";
- String userStr = gson.toJson(user1);
- log("------>序列化:" + userStr);
- }
- }
运行结果:
------>反序列化:User{name='zhangsan'}
------>序列化:{"name":"zhangsan2"}
@Expose注解 只序列化
------>反序列化:User{name='null'}------>序列化:{"name":"zhangsan2"}
@Expose 只反序列化
运行结果:
------>反序列化:User{name='zhangsan'}
------>序列化:{}
@Since(float v)注解 版本控制
结合GsonBuilder.setVersion(n)使用 当n>=v时 才会序列化解析
运行结果:
------>反序列化v=1:User{name='null'}
------>序列化v=1:{}
------>反序列化v=2:User{name='zhangsan'}
------>序列化v=2:{"name":"zhangsan2"}
------>反序列化v=3:User{name='zhangsan'}
------>序列化v=3:{"name":"zhangsan2"}
@Util(float v)注解 版本控制
当gson的setVersion(n) n<v 才解析
------>反序列化v=1:User{name='zhangsan'}
------>序列化v=1:{"name":"zhangsan2"}
------>反序列化v=2:User{name='null'}
------>序列化v=2:{}
------>反序列化v=3:User{name='null'}
------>序列化v=3:{}
Gson 高级用法
相信看过retrofit2.0 源码的同学都知道,其中有一个GsonConverterFactory 里面的用法十分精炼老成,这里来一段源码
据说使用TypeAdapter 效率更高,本人还未对比测试,暂时放后吧,TypeAdapter是什么玩意呢?
在源码中备注了一句 Converts Java objects to and from JSON 就是对象json之间的互相转换 接替了T 泛型类的序列化和反序列化的逻辑
从源码中我们看到区分了2.1版本之前后之后的用法,2.1版本之前可以自定义adapter:
使用
在2.1版本之后更推荐直接插入泛型就使用
- // String json = "{'origin':'0,0','points':['1,2','3,4']}";
- // TypeAdapter<Graph> graphAdapter = gson.getAdapter(Graph.class);
- // Graph graph = graphAdapter.fromJson(json);
- // }</pre>
- // And an example for serialization: <pre> {@code
- //
- // Graph graph = new Graph(...);
- // TypeAdapter<Graph> graphAdapter = gson.getAdapter(Graph.class);
- // String json = graphAdapter.toJson(graph);
- // }</pre>
实例:使用TypeAdapter 来序列化和反序列化
- package com.xuan.gson;
- import com.google.gson.Gson;
- import com.google.gson.TypeAdapter;
- /**
- * @author xuanyouwu
- * @email xuanyouwu@163.com
- * @time 2016-05-18 11:20
- */
- public class GsonTest7 {
- private static void log(String msg) {
- System.out.println(msg);
- }
- public static class User {
- public String name;
- public int age;
- @Override
- public String toString() {
- return "User{" +
- "name='" + name + '\'' +
- ", age=" + age +
- '}';
- }
- }
- public static void main(String[] args) throws Exception {
- Gson gson = new Gson();
- TypeAdapter<User> userTypeAdapter = gson.getAdapter(User.class);
- User user = new User();
- user.name = "xuanyouwu";
- user.age = 26;
- String userJsonStr = userTypeAdapter.toJson(user);
- log("------>序列化:" + userJsonStr);
- User user1 = userTypeAdapter.fromJson(userJsonStr);
- log("------>反序列化:" + user1);
- }
- }
- 运行结果:
- ------>序列化:{"name":"xuanyouwu","age":26}
- ------>反序列化:User{name='xuanyouwu', age=26}
Gson的容错机制:
为什么要容错了,在javaBean中声明了int类型的age 如果服务端 返回的是"" 空字符串怎么办呢?崩溃?
如果json格式不规范如 {name=zhangsan,age:26,hobby=null} 发现不是普通的key value
容错实现方式1:
1:创建Gson的方式2:使用JsonReader
- gson = new GsonBuilder()
- .setLenient()// json宽松
- .create();
JsonReader jsonReader = gson.newJsonReader(value.charStream());
- jsonReader.<span style="font-family: 宋体; font-size: 9pt;">setLenient(true)</span>
3:自定义TypeAdapter
4:使用注解JsonAdapter,其实也是自定义Adapter
1.2归为一类 由框架实现,基本json大格式规范,键值对不标准,多引号的问题等等,而不报错停止解析,但是功能相对较弱
能解决bug
3,4归为一类,都属于自定义adapter,但是3与gson绑定,4使用注解和字段绑定
实例:
运行结果:
------->jsonFromServer:{
"age": "",
"name": "zhangsan"
}
------>默认Gson 解析 异常:com.google.gson.JsonSyntaxException: java.lang.NumberFormatException: empty String
------>自定义adapter 解析:User{name='zhangsan', age=0}
------>自定义adapter 解析2:User{name='zhangsan', age=0}
可以看到 age是空字符串 但是不影响整体的解析流程,这对客户端是十分友好的
基于注解的方式,上面的方式倾向于整体,注解的方式倾向于字段
运行结果:
------->jsonFromServer:{
"age": "",
"name": "zhangsan"
}
------> JsonDeserializer<Integer> 解析:User{name='zhangsan', age=0}
------> 默认gson 解析异常:com.google.gson.JsonSyntaxException: java.lang.NumberFormatException: empty String
这样定义全局的反序列化工具就能避免解析异常
GSON : http://repo1.maven.org/maven2/com/google/code/gson/gson/2.8.0/
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。