Gson解析教程

Gson 是google解析Json的一个开源框架,同类的框架fastJson,JackJson等等

第一步:在AS下面创建java工程 并添加gson依赖

compile 'com.google.code.gson:gson:2.6.2'

Gson的实例化方式:

1:Gson gson=newGson();

2:通过GsonBuilder 可以配置多种选项

[java] view plain copy

1. gson = new GsonBuilder()  
2.                    .setLenient()// json宽松  
3.                    .enableComplexMapKeySerialization()//支持Map的key为复杂对象的形式  
4.                    .serializeNulls() //智能null  
5.                    .setPrettyPrinting()// 调教格式  
6.                    .disableHtmlEscaping() //默认是GSON把HTML 转义的  
7.                    .create();  

Gson的基本用法:

 JavaBean转换Json字符串

    gson提供 publicString toJson(Object src) 方法可以将对象转换成jsonStr

  

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. public class GsonTest1 {  
4.     public static class Student {  
5.         private String name;  
6.         private int age;  
7.   
8.         //省略setter getter equals  
9.     }  
10.   
11.     private static void log(String msg) {  
12.         System.out.println(msg);  
13.     }  
14.   
15.   
16.     public static void main(String[] args) throws Exception {  
17.         Gson gson = new Gson();  
18.         Student student = new Student();  
19.         student.setName("xuanyouwu");  
20.         student.setAge(26);  
21.         String jsonStr = gson.toJson(student);  
22.         log("---->javabean convert jsonStr:" + jsonStr);  
23.     }
    
24. }  

运行结果:

---->javabean convert jsonStr:{"name":"xuanyouwu","age":26}

    List Map转Json字符串

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import java.util.Arrays;  
4. import java.util.HashMap;  
5. import java.util.List;  
6. import java.util.Map;  
7. public class GsonTest1 {  
8.   
9.     private static void log(String msg) {  
10.         System.out.println(msg);  
11.     }  
12.   
13.   
14.     public static void main(String[] args) throws Exception {  
15.         Gson gson = new Gson();  
16.   
17.         List<String> list = Arrays.asList("1", "a", "3", "rt", "5");  
18.         log("---->list convert jsonStr:" + gson.toJson(list));  
19.   
20.         Map<String, Object> content = new HashMap<String, Object>();  
21.         content.put("name", "xuanyouwu");  
22.         content.put("age", "26");  
23.         log("---->map convert jsonStr:" + gson.toJson(content));  
24.     }  
25.   
26. }  

[java] view plain copy

1. 运行结果:  

[java] view plain copy

1. ---->list convert jsonStr:["1","a","3","rt","5"]  
2. ---->map convert jsonStr:{"name":"xuanyouwu","age":"26"}  

       Json字符串转JavaBean

[java] view plain copy

1. String studentJsonStr="{\"name\":\"xuanyouwu\",\"age\":26}";  
2.   
3. Student student1 = gson.fromJson(studentJsonStr, Student.class);  
4. log("------->json convert JavaBean:"+student1);  

      运行结果:

            ------->json convert JavaBean:Student{name='xuanyouwu', age=26}

   Json字符串转List

[java] view plain copy

1. String listJsonStr="[\"1\",\"a\",\"3\",\"rt\",\"5\"]";  

[java] view plain copy

1. Type type = new TypeToken<ArrayList<String>>() { }.getType();  
2. ArrayList<String> sList=gson.fromJson(listJsonStr, type);  
3. log("------->json convert List:"+sList);  

[java] view plain copy

1. 运行结果:  
2. json convert List:[1, a, 3, rt, 5] 
   

JSONNull

[java] view plain copy

1. JsonNull 其实就是null 字段  

[java] view plain copy

1. JsonNull jsonNull=new JsonNull();//构造方法过时，推荐INSTANCE  

[java] view plain copy

1. JsonNull jsonNull=JsonNull.INSTANCE;  
2.   log("-----"+jsonNull);  

[java] view plain copy

1. 运行结果:  

[java] view plain copy

1. -----null 
   

JSONPrimitive    

JsonPrimitive非常有意思,我们知道如果json转换成字符串 可能包含引号的转义，但是通过JsonPrimative我们可以获得为转义的字符串，看实例：

     

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.JsonNull;  
3. import com.google.gson.JsonPrimitive;  
4. public class GsonTest2 {  
5.     private static void log(String msg) {  
6.         System.out.println(msg);  
7.     }  
8.     public static void main(String[] args) throws Exception {  
9.         String studentJsonStr="{\"name\":\"xuanyouwu\",\"age\":26}";  
10.         log("------>studentJsonStr:"+studentJsonStr);  
11.         JsonPrimitive jsonPrimitive=new JsonPrimitive(studentJsonStr);  
12.         log("------>jsonPrimitive:"+jsonPrimitive);  
13.         log("------>jsonPrimitive:"+jsonPrimitive.toString());  
14.         log("------>jsonPrimitive:"+jsonPrimitive.getAsString());  
15.   
16.         JsonPrimitive jsonPrimitive2=new JsonPrimitive("this is String");  
17.         log("------>jsonPrimitive2:"+jsonPrimitive2);  
18.         log("------>jsonPrimitive2:"+jsonPrimitive2.toString());  
19.         log("------>jsonPrimitive2:"+jsonPrimitive2.getAsString());  
20.     }  
21. }  

     运行结果:

------>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类似

[java] view plain copy

1. JsonObject jsonObject=new JsonObject();  
2. jsonObject.addProperty("name","xuanyouwu");  
3. jsonObject.addProperty("age",26);  
4. log("------>create jsonObject:"+jsonObject);  

            运行结果:

                ------>create jsonObject:{"name":"xuanyouwu","age":26}

    创建JsonArray       

[java] view plain copy

1. JsonArray jsonElements=new JsonArray();  
2.    jsonElements.add("a");  
3.    jsonElements.add("b");  
4.    jsonElements.add("c");  
5.    jsonElements.add("d");  
6.    log("------>create jsonArray:"+jsonElements);  

          运行结果:

          ------>create jsonArray:["a","b","c","d"]

     JsonObject 嵌套数组或者说嵌套JsonArray

           通过JsonObject的add(key,JsonElement)可以为jsonObject 添加一个数组的字段

[java] view plain copy

1. JsonObject jsonObject2=new JsonObject();  
2. jsonObject2.addProperty("name","xuanyouwu");  
3. jsonObject2.addProperty("age",26);  
4. JsonArray jsonElements2=new JsonArray();  
5. jsonElements2.add("骑车");  
6. jsonElements2.add("打游戏");  
7. jsonElements2.add("看电视");  
8. jsonObject2.add("hobby",jsonElements2);  
9. log("------>create jsonObject inner JsonArray:"+jsonObject2);  

           运行结果:

            ------>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 比较优雅简介

          实例:

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.annotations.SerializedName;  
4. public class GsonTest3 {  
5.     private static void log(String msg) {  
6.         System.out.println(msg);  
7.     }  
8.   
9.     public static class User {  
10.         public String name;  
11.         public int age;  
12.         @SerializedName("new")  
13.         public int isnew;  
14.   
15.         @Override  
16.         public String toString() {  
17.             return "User{" +  
18.                     "name='" + name + '\'' +  
19.                     ", age=" + age +  
20.                     ", isnew=" + isnew +  
21.                     '}';  
22.         }  
23.     }  
24.   
25.     public static void main(String[] args) throws Exception {  
26.   
27.         String jsonFromServer = "{\n" +  
28.                 "    \"age\": 26,\n" +  
29.                 "    \"name\": \"zhangsan\",\n" +  
30.                 "    \"new\": 1\n" +  
31.                 "}";  
32.         Gson gson = new Gson();  
33.         User user = gson.fromJson(jsonFromServer, User.class);  
34.         log("------>user:" + user);  
35.     }  
36. }  

运行结果: ------>user:User{name='zhangsan', age=26, isnew=1}

[java] view plain copy

1. package com.xuan.gson;  
2.   
3. import com.google.gson.Gson;  
4. import com.google.gson.annotations.SerializedName;  
5. public class GsonTest3 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User2 {  
11.         public String name;  
12.         public int age;  
13.         @SerializedName("my_parent_name")  
14.         public String pn;  
15.   
16.         @Override  
17.         public String toString() {  
18.             return "User2{" +  
19.                     "name='" + name + '\'' +  
20.                     ", age=" + age +  
21.                     ", pn='" + pn + '\'' +  
22.                     '}';  
23.         }  
24.     }  
25.   
26.     public static void main(String[] args) throws Exception {  
27.         String jsonFromServer2="{\n" +  
28.                 "    \"age\": 26,\n" +  
29.                 "    \"my_parent_name\": \"zhangsanf\",\n" +  
30.                 "    \"name\": \"zhangsan\"\n" +  
31.                 "}";  
32.         Gson gson2 = new Gson();  
33.         User2 user2 = gson2.fromJson(jsonFromServer2, User2.class);  
34.         log("------>user2:" + user2);  
35.     }  
36. }  

运行结果: ------>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的备选字段 会后面的替换前面的

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.annotations.SerializedName;
   
4. public class GsonTest4 {  
5.     private static void log(String msg) {  
6.         System.out.println(msg);  
7.     }  
8.   
9.     public static class User {  
10.         public String name;  
11.         public int age;  
12.         @SerializedName(value = "desc",alternate = {"other","note"})  
13.         public String desc;  
14.   
15.         @Override  
16.         public String toString() {  
17.             return "User{" +  
18.                     "name='" + name + '\'' +  
19.                     ", age=" + age +  
20.                     ", desc='" + desc + '\'' +  
21.                     '}';  
22.         }  
23.     }  
24.   
25.     public static void main(String[] args) throws Exception {  
26.         String jsonFromServer = "{\n" +  
27.                 "    \"age\": 26,\n" +  
28.                 "    \"other\": \"成都人\",\n" +  
29.                 "    \"name\": \"zhangsan\"\n" +  
30.                 "}";  
31.         Gson gson = new Gson();  
32.         User user = gson.fromJson(jsonFromServer, User.class);  
33.         log("------>user:" + user);  
34.   
35.   
36.         String jsonFromServer2 = "{\n" +  
37.                 "    \"age\": 26,\n" +  
38.                 "    \"note\": \"成都人\",\n" +  
39.                 "    \"name\": \"zhangsan\"\n" +  
40.                 "}";  
41.         User user2 = gson.fromJson(jsonFromServer2, User.class);  
42.         log("------>user:" + user2);  
43.   
44.         //包括desc 与note note在desc之后  
45.         String jsonFromServer3="{\n" +  
46.                 "    \"age\": 26,\n" +  
47.                 "    \"desc\": \"desc成都人\",\n" +  
48.                 "    \"name\": \"zhangsan\",\n" +  
49.                 "    \"note\": \"note成都人\"\n" +  
50.                 "}";  
51.         User user3 = gson.fromJson(jsonFromServer3, User.class);  
52.         log("------>user:" + user3);  
53.   
54.         //包括desc 与note note在desc之前  
55.         String jsonFromServer4="{\n" +  
56.                 "    \"age\": 26,\n" +  
57.                 "    \"note\": \"note成都人\",\n" +  
58.                 "    \"name\": \"zhangsan\",\n" +  
59.                 "    \"desc\": \"desc成都人\"\n" +  
60.                 "}";  
61.         User user4 = gson.fromJson(jsonFromServer4, User.class);  
62.         log("------>user:" + user4);  
63.     }  
64. }  

  运行结果:

     ------>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过滤注解 

  源码:默认既可以序列化又可以反序列化

[java] view plain copy

1. @Retention(RetentionPolicy.RUNTIME)  
2. @Target(ElementType.FIELD)  
3. public @interface Expose {  
4.   public boolean serialize() default true;  
5.   public boolean deserialize() default true;  
6. }  

[java] view plain copy
   可以排除不需要序列化的字段,需要配合GsonBuilder使用 
           Gson gson = new GsonBuilder()  

1.   .excludeFieldsWithoutExposeAnnotation()  
2.    .create();  

  不添加@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)

[java] view plain copy

1. package com.xuan.gson;
   
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. public class GsonTest5 {  
5.     private static void log(String msg) {  
6.         System.out.println(msg);  
7.     }  
8.   
9.     public static class User {  
10.         public String name;  
11.   
12.         @Override  
13.         public String toString() {  
14.             return "User{" +  
15.                     "name='" + name + '\'' +  
16.                     '}';  
17.         }  
18.     }  
19.   
20.     public static void main(String[] args) throws Exception {  
21.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
22.         Gson gson = new GsonBuilder()  
23.                 .excludeFieldsWithoutExposeAnnotation()  
24.                 .create();  
25.         User user = gson.fromJson(jsonFromServer, User.class);  
26.         log("------>反序列化:" + user);  
27.   
28.         User user1 = new User();  
29.         user1.name = "zhangsan2";  
30.         String userStr = gson.toJson(user1);  
31.         log("------>序列化:" + userStr);  
32.     }  
33. }  

运行结果:

------>反序列化:User{name='null'}
------>序列化:{}

  添加@Expose注解 

[java] view plain copy

1. package com.xuan.gson; 
   
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.annotations.Expose;  
   
5. public class GsonTest5 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User {  
11.         @Expose //等同于 @Expose(deserialize = true,serialize = true)  
12.         public String name;  
13.   
14.         @Override  
15.         public String toString() {  
16.             return "User{" +  
17.                     "name='" + name + '\'' +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
24.         Gson gson = new GsonBuilder()  
25.                 .excludeFieldsWithoutExposeAnnotation()  
26.                 .create();  
27.         User user = gson.fromJson(jsonFromServer, User.class);  
28.         log("------>反序列化:" + user);  
29.   
30.         User user1 = new User();  
31.         user1.name = "zhangsan2";  
32.         String userStr = gson.toJson(user1);  
33.         log("------>序列化:" + userStr);  
34.     }  
35. }  

运行结果:

------>反序列化:User{name='zhangsan'}
------>序列化:{"name":"zhangsan2"}

@Expose注解 只序列化

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.annotations.Expose;  
5. public class GsonTest5 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User {  
11.         @Expose(deserialize = false,serialize = true)  
12.         public String name;  
13.   
14.         @Override  
15.         public String toString() {  
16.             return "User{" +  
17.                     "name='" + name + '\'' +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
24.         Gson gson = new GsonBuilder()  
25.                 .excludeFieldsWithoutExposeAnnotation()  
26.                 .create();  
27.         User user = gson.fromJson(jsonFromServer, User.class);  
28.         log("------>反序列化:" + user);  
29.   
30.         User user1 = new User();  
31.         user1.name = "zhangsan2";  
32.         String userStr = gson.toJson(user1);  
33.         log("------>序列化:" + userStr);  
34.     }  
35. }  

运行结果:

------>反序列化:User{name='null'}------>序列化:{"name":"zhangsan2"}

      @Expose 只反序列化

[java] view plain copy

1. package com.xuan.gson;   
   
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.annotations.Expose;  
5. public class GsonTest5 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User {  
11.         @Expose(deserialize = true, serialize = false)  
12.         public String name;  
13.   
14.         @Override  
15.         public String toString() {  
16.             return "User{" +  
17.                     "name='" + name + '\'' +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
24.         Gson gson = new GsonBuilder()  
25.                 .excludeFieldsWithoutExposeAnnotation()  
26.                 .create();  
27.         User user = gson.fromJson(jsonFromServer, User.class);  
28.         log("------>反序列化:" + user);  
29.   
30.         User user1 = new User();  
31.         user1.name = "zhangsan2";  
32.         String userStr = gson.toJson(user1);  
33.         log("------>序列化:" + userStr);  
34.     }  
35. }  

运行结果:

 ------>反序列化:User{name='zhangsan'}
------>序列化:{}

    @Since(float v)注解  版本控制 

      结合GsonBuilder.setVersion(n)使用 当n>=v时 才会序列化解析

 

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.annotations.Since;  
5. public class GsonTest6 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User {  
11.         @Since(2)  
12.         public String name;  
13.   
14.         @Override  
15.         public String toString() {  
16.             return "User{" +  
17.                     "name='" + name + '\'' +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
24.         Gson gson = new GsonBuilder()  
25.                 .setVersion(1)//版本为1  
26.                 .create();  
27.         User user1 = gson.fromJson(jsonFromServer, User.class);  
28.         log("------>反序列化v=1:" + user1);  
29.   
30.         User user1_1 = new User();  
31.         user1_1.name = "zhangsan2";  
32.         String userStr = gson.toJson(user1_1);  
33.         log("------>序列化v=1:" + userStr);  
34.   
35.   
36.         Gson gson2 = new GsonBuilder()  
37.                 .setVersion(2)//版本为2  
38.                 .create();  
39.         User user2 = gson2.fromJson(jsonFromServer, User.class);  
40.         log("------>反序列化v=2:" + user2);  
41.   
42.         User user2_1 = new User();  
43.         user2_1.name = "zhangsan2";  
44.         String userStr2_1 = gson2.toJson(user2_1);  
45.         log("------>序列化v=2:" + userStr2_1);  
46.   
47.         Gson gson3 = new GsonBuilder()  
48.                 .setVersion(3)//版本为3  
49.                 .create();  
50.         User user3 = gson3.fromJson(jsonFromServer, User.class);  
51.         log("------>反序列化v=3:" + user3);  
52.   
53.         User user3_1 = new User();  
54.         user3_1.name = "zhangsan2";  
55.         String userStr3_1 = gson3.toJson(user3_1);  
56.         log("------>序列化v=3:" + userStr3_1);  
57.     }  
58. }  

运行结果:

------>反序列化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 才解析

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.annotations.Until;  
5. public class GsonTest6 {  
6.     private static void log(String msg) {  
7.         System.out.println(msg);  
8.     }  
9.   
10.     public static class User {  
11.         @Until(2)  
12.         public String name;  
13.   
14.         @Override  
15.         public String toString() {  
16.             return "User{" +  
17.                     "name='" + name + '\'' +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         String jsonFromServer = "{\"name\": \"zhangsan\"}";  
24.         Gson gson = new GsonBuilder()  
25.                 .setVersion(1)//版本为1  
26.                 .create();  
27.         User user1 = gson.fromJson(jsonFromServer, User.class);  
28.         log("------>反序列化v=1:" + user1);  
29.   
30.         User user1_1 = new User();  
31.         user1_1.name = "zhangsan2";  
32.         String userStr = gson.toJson(user1_1);  
33.         log("------>序列化v=1:" + userStr);  
34.   
35.         Gson gson2 = new GsonBuilder()  
36.                 .setVersion(2)//版本为2  
37.                 .create();  
38.         User user2 = gson2.fromJson(jsonFromServer, User.class);  
39.         log("------>反序列化v=2:" + user2);  
40.   
41.         User user2_1 = new User();  
42.         user2_1.name = "zhangsan2";  
43.         String userStr2_1 = gson2.toJson(user2_1);  
44.         log("------>序列化v=2:" + userStr2_1);  
45.   
46.         Gson gson3 = new GsonBuilder()  
47.                 .setVersion(3)//版本为3  
48.                 .create();  
49.         User user3 = gson3.fromJson(jsonFromServer, User.class);  
50.         log("------>反序列化v=3:" + user3);  
51.   
52.         User user3_1 = new User();  
53.         user3_1.name = "zhangsan2";  
54.         String userStr3_1 = gson3.toJson(user3_1);  
55.         log("------>序列化v=3:" + userStr3_1);  
56.     }  
57. }  

运行结果:

------>反序列化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:

   

[java] view plain copy

1. public class PointAdapter extends TypeAdapter<Point> {  
2.  *     public Point read(JsonReader reader) throws IOException {  
3.  *       if (reader.peek() == JsonToken.NULL) {  
4.  *         reader.nextNull();  
5.  *         return null;  
6.  *       }  
7.  *       String xy = reader.nextString();  
8.  *       String[] parts = xy.split(",");  
9.  *       int x = Integer.parseInt(parts[0]);  
10.  *       int y = Integer.parseInt(parts[1]);  
11.  *       return new Point(x, y);  
12.  *     }  
13.  *     public void write(JsonWriter writer, Point value) throws IOException {  
14.  *       if (value == null) {  
15.  *         writer.nullValue();  
16.  *         return;  
17.  *       }  
18.  *       String xy = value.getX() + "," + value.getY();  
19.  *       writer.value(xy);  
20.  *     }  
21.  *   }}  

    使用

  

[java] view plain copy

1. GsonBuilder builder = new GsonBuilder();  
2.  *   builder.registerTypeAdapter(Point.class, new PointAdapter());  
3.  *   // if PointAdapter didn't check for nulls in its read/write methods, you should instead use  
4.  *   // builder.registerTypeAdapter(Point.class, new PointAdapter().nullSafe());  
5.  *   ...  
6.  *   Gson gson = builder.create();  

    在2.1版本之后更推荐直接插入泛型就使用

[java] view plain copy

1. //   String json = "{'origin':'0,0','points':['1,2','3,4']}";  
2. //   TypeAdapter<Graph> graphAdapter = gson.getAdapter(Graph.class);  
3. //   Graph graph = graphAdapter.fromJson(json);  
4. // }</pre>  
5. // And an example for serialization: <pre>   {@code  
6. //  
7. //   Graph graph = new Graph(...);  
8. //   TypeAdapter<Graph> graphAdapter = gson.getAdapter(Graph.class);  
9. //   String json = graphAdapter.toJson(graph);  
10. // }</pre>  

   实例:使用TypeAdapter 来序列化和反序列化

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.TypeAdapter;  
4. public class GsonTest7 {  
5.     private static void log(String msg) {  
6.         System.out.println(msg);  
7.     }  
8.   
9.     public static class User {  
10.         public String name;  
11.         public int age;  
12.   
13.         @Override  
14.         public String toString() {  
15.             return "User{" +  
16.                     "name='" + name + '\'' +  
17.                     ", age=" + age +  
18.                     '}';  
19.         }  
20.     }  
21.   
22.     public static void main(String[] args) throws Exception {  
23.         Gson gson = new Gson();  
24.         TypeAdapter<User> userTypeAdapter = gson.getAdapter(User.class);  
25.         User user = new User();  
26.         user.name = "xuanyouwu";  
27.         user.age = 26;  
28.         String userJsonStr = userTypeAdapter.toJson(user);  
29.         log("------>序列化:" + userJsonStr);  
30.   
31.         User user1 = userTypeAdapter.fromJson(userJsonStr);  
32.         log("------>反序列化:" + user1);  
33.   
34.     }  
35. }  

[java] view plain copy

1. 运行结果:  

[java] view plain copy

1. ------>序列化:{"name":"xuanyouwu","age":26}  
2. ------>反序列化:User{name='xuanyouwu', age=26}  

Gson的容错机制:

   为什么要容错了,在javaBean中声明了int类型的age 如果服务端 返回的是"" 空字符串怎么办呢？崩溃？

   如果json格式不规范如 {name=zhangsan,age:26,hobby=null}  发现不是普通的key value

  容错实现方式1：

  1:创建Gson的方式

[java] view plain copy

1. gson = new GsonBuilder()  
2.                   .setLenient()// json宽松  
3.                   .create();  

2:使用JsonReader

   JsonReader jsonReader = gson.newJsonReader(value.charStream());

[java] view plain copy

1. jsonReader.setLenient(true) 
   

    3:自定义TypeAdapter

    4:使用注解JsonAdapter,其实也是自定义Adapter

 

 1.2归为一类 由框架实现,基本json大格式规范,键值对不标准,多引号的问题等等,而不报错停止解析,但是功能相对较弱

 能解决bug 

[java] view plain copy

1. com.google.gson.JsonSyntaxException: com.google.gson.stream.MalformedJsonException: Use JsonReader.setLenient(true) to accept malformed JSON

3,4归为一类,都属于自定义adapter,但是3与gson绑定,4使用注解和字段绑定

 实例：

   

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.GsonBuilder;  
4. import com.google.gson.JsonParseException;  
5. import com.google.gson.TypeAdapter;  
6. import com.google.gson.stream.JsonReader;  
7. import com.google.gson.stream.JsonWriter;  
8. import java.io.IOException;
   
9. public class GsonTest8 {  
10.     private static void log(String msg) {  
11.         System.out.println(msg);  
12.     }  
13.   
14.     public static class User {  
15.         public String name;  
16.         public int age;  
17.   
18.         @Override  
19.         public String toString() {  
20.             return "User{" +  
21.                     "name='" + name + '\'' +  
22.                     ", age=" + age +  
23.                     '}';  
24.         }  
25.         ;  
26.     }  
27.   
28.     public static class UserTypeAdapter extends TypeAdapter<User> {  
29.   
30.         @Override  
31.         public void write(JsonWriter out, User value) throws IOException {  
32.             out.beginObject();  
33.             out.name("name").value(value.name);  
34.             out.name("age").value(value.age);  
35.             out.endObject();  
36.         }  
37.   
38.         @Override  
39.         public User read(JsonReader in) throws IOException {  
40.             User user = new User();  
41.             in.beginObject();  
42.             while (in.hasNext()) {  
43.                 switch (in.nextName()) {  
44.                     case "name":  
45.                         user.name = in.nextString();  
46.                         break;  
47.                     case "age":  
48.                         try {  
49.                             String str = in.nextString();  
50.                             user.age = Integer.valueOf(str);  
51.                         } catch (Exception e) {  
52.                         }  
53.                         break;  
54.                 }  
55.             }  
56.             in.endObject();  
57.             return user;  
58.         }  
59.     }  
60.   
61.     public static void main(String[] args) throws Exception {  
62.         Gson gson = new Gson();  
63.   
64.         String jsonStrFromServer = "{\n" +  
65.                 "    \"age\": \"\",\n" +  
66.                 "    \"name\": \"zhangsan\"\n" +  
67.                 "}";  
68.         log("------->jsonFromServer:"+jsonStrFromServer);  
69.         try {  
70.             User user = gson.fromJson(jsonStrFromServer, User.class);  
71.             log("------>默认Gson 解析:" + user);  
72.         } catch (JsonParseException e) {//java.lang.NumberFormatException: empty String  
73.             log("------>默认Gson 解析 异常:" + e);  
74.         }  
75.   
76.         Gson gson2 = new GsonBuilder()  
77.                 .registerTypeAdapter(User.class, new UserTypeAdapter()).create();  
78.         try {  
79.             User user2 = gson2.fromJson(jsonStrFromServer, User.class);  
80.             log("------>自定义adapter 解析:" + user2);  
81.         } catch (JsonParseException e) {//java.lang.NumberFormatException: empty String  
82.             log("------>自定义adapter 异常:" + e);  
83.         }  
84.   
85.         try {  
86.             UserTypeAdapter userTypeAdapter = new UserTypeAdapter();  
87.             User user3 = userTypeAdapter.fromJson(jsonStrFromServer);  
88.             log("------>自定义adapter 解析2:" + user3);  
89.         } catch (Exception e) {  
90.             log("------>自定义adapter 异常2:" + e);  
91.         }  
92.     }  
93. }  

运行结果:

------->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是空字符串 但是不影响整体的解析流程,这对客户端是十分友好的

  基于注解的方式,上面的方式倾向于整体,注解的方式倾向于字段

  

[java] view plain copy

1. package com.xuan.gson;  
2. import com.google.gson.Gson;  
3. import com.google.gson.JsonParseException;  
4. import com.google.gson.TypeAdapter;  
5. import com.google.gson.annotations.JsonAdapter;  
6. import com.google.gson.stream.JsonReader;  
7. import com.google.gson.stream.JsonWriter;  
8. import java.io.IOException;  
9. public class GsonTest9 {  
10.     private static void log(String msg) {  
11.         System.out.println(msg);  
12.     }  
13.   
14.     public static class User {  
15.         public String name;  
16.         @JsonAdapter(IntegerTypeAdapter.class)  
17.         public int age;  
18.   
19.         @Override  
20.         public String toString() {  
21.             return "User{" +  
22.                     "name='" + name + '\'' +  
23.                     ", age=" + age +  
24.                     '}';  
25.         }  
26.     }  
27.   
28.     public static class IntegerTypeAdapter extends TypeAdapter<Integer> {  
29.   
30.         @Override  
31.         public void write(JsonWriter out, Integer value) throws IOException {  
32.             out.value(value);  
33.         }  
34.   
35.         @Override  
36.         public Integer read(JsonReader in) throws IOException {  
37.             int i = 0;  
38.             try {  
39.                 String str = in.nextString();  
40.                 i = Integer.valueOf(str);  
41.             } catch (Exception e) {  
42.             }  
43.             return i;  
44.         }  
45.     }  
46.   
47.     public static class User2 {  
48.         public String name;  
49.         public int age;  
50.   
51.         @Override  
52.         public String toString() {  
53.             return "User{" +  
54.                     "name='" + name + '\'' +  
55.                     ", age=" + age +  
56.                     '}';  
57.         }  
58.     }  
59.     public static void main(String[] args) throws Exception {  
60.         Gson gson = new Gson();  
61.   
62.         String jsonStrFromServer = "{\n" +  
63.                 "    \"age\": \"\",\n" +  
64.                 "    \"name\": \"zhangsan\"\n" +  
65.                 "}";  
66.         log("------->jsonFromServer:" + jsonStrFromServer);  
67.         try {  
68.             User2 user2 = gson.fromJson(jsonStrFromServer, User2.class);  
69.             log("------>gson 解析:" + user2);  
70.         } catch (Exception e) {  
71.             log("------>gson 解析异常:" + e);  
72.         }  
73.         try {  
74.             User user = gson.fromJson(jsonStrFromServer, User.class);  
75.             log("------>JsonAdapter 注解 解析:" + user);  
76.         } catch (JsonParseException e) {//java.lang.NumberFormatException: empty String  
77.             log("------>JsonAdapter 注解 异常:" + e);  
78.         }  
79.     }  
80. }  

运行结果:

[java] view plain copy

1. ------->jsonFromServer:{  
2.     "age": "",  
3.     "name": "zhangsan"  
4. }  
5. ------>gson 解析异常:com.google.gson.JsonSyntaxException: java.lang.NumberFormatException: empty String  
6. ------>JsonAdapter 注解 解析:User{name='zhangsan', age=0}