Gson的使用（2）

1、 @SerializedName 注解的使用

@SerializedName 注解是属性重命名的方法，举例说明：

Android一般使用驼峰式命名，但如果此时和我们进行数据交互的后台是PHP工程师，那我们往往将会得到下划线分割的方式进行命名的数据，比如：

Android开发希望的json数据是：

[java]  view plain  copy

 

1. {"name":"小明","homeAddress":"中国xxxxxxxxxx","age":16,"sex":true}  

但PHP习惯返回的数据是：

[java]  view plain  copy

 

1. {"name":"小明","home_address":"中国xxxxxxxxxx","age":16,"sex":true}  

这时就需要用到@SerializedName 注解，方法如下：

在实体类中通过如下代码进行注解

[java]  view plain  copy

 

1. @SerializedName("home_address")  
2. public String homeAddress;  

此时就可以通过反射正确的解析json数据。

若出现命名混乱，后台又不愿意改，比如：

[java]  view plain  copy

 

1. {"name":"小明","home_address":"中国xxxxxxxxxx","age":16,"sex":true}  
2. {"name":"小明","homeaddress":"中国xxxxxxxxxx","age":16,"sex":true}  
3. {"name":"小明","home":"中国xxxxxxxxxx","age":16,"sex":true}  

可以通过如下方式进行调整：

[java]  view plain  copy

 

1. @SerializedName(value = "homeAddress", alternate = {"home", "home_address","homeaddress"})  
2. public String homeAddress;  

此时不管出现的是homeAdress、home、home_adress或者homeadress都可以正确的解析；

2、显示Null的值

正常情况下：

[java]  view plain  copy

 

1. User user=new User("小明",true,16,null);  
2. String userJson = gson.toJson(user);  
3. Log.i(TAG,userJson);//{"name":"小明","age":16,"sex":true}  

若此时想要显示

"homeAddress":null

需要进行如下配置：

[java]  view plain  copy

 

1. Gson gson = new GsonBuilder()  
2.         .serializeNulls()  
3.         .create();  

此时打印结果为：

[java]  view plain  copy

 

1. {"name":"小明","homeAddress":null,"age":16,"sex":true}  

3、其他关于序列化的控制（不仅仅只包含列举的，这些只是常用的）

[java]  view plain  copy

 

1. <pre name="code" class="java">Gson gson = new GsonBuilder()  
2. .disableInnerClassSerialization()  
3. .setDateFormat("yyyy-MM-dd")//序列化和反序化时将时间以此形式输出   
4. .disableHtmlEscaping()//html标签不转义   
5.  .create();  

4、注解@Expose的使用

             简单来说，@Expose控制对象中的参数是否需要序列化和反序列化，其中：

[java]  view plain  copy

 

1. @Expose(deserialize = true,serialize = true) //序列化和反序列化都都生效  
2. @Expose(deserialize = true,serialize = false) //反序列化时生效  
3. @Expose(deserialize = false,serialize = true) //序列化时生效  
4. @Expose(deserialize = false,serialize = false) // 和不写一样  

通过代码来解释用法：

[java]  view plain  copy

 

1. public class User {  
2. @Expose(deserialize = false,serialize = true)   
3. private String name;//序列化时生效  
4. private boolean sex; private int age;  
5. @Expose(deserialize = false,serialize = false)   
6. private String homeAddress;// 和不写一样，不管是序列化还是反序列化都和正常使用一样  
7. }  

此时，Gson必须通过如下的方式进行实例化：

[java]  view plain  copy

 

1. Gson gson = new GsonBuilder()  
2.         .excludeFieldsWithoutExposeAnnotation()  
3.         .create();  

5、@Since(int i)和@Until(int i)的用法

@Since(int i)和@Until(int i)是一种版本控制，当版本号大于Since的值时，会解析出该字段，否则不会解析出来，当版本号小于Until的时会解析出来该字段，否则不会。看代码：

[java]  view plain  copy

 

1. public class User {  
2.     @Since（3）  
3.     private String name;  
4.     private boolean sex;  
5.     private int age;  
6.     @Until（5）  
7. private String homeAddress;  
8. }  

解析代码：

[html]  view plain  copy

 

1. Gson gson = new GsonBuilder().setVersion(int version).create();  

结果分析：

若version<3 则解析结果为：{"homeAddress":“中国xxxxxxxx”,"age":16,"sex":true}

若version>=3并且version<5 则解析结果为：{"name":"小明","homeAddress":“中国xxxxxxxx”,"age":16,"sex":true}

若version>=5 则解析结果为：{"name":"小明","age":16,"sex":true}

其实范围可以概括为，Until之前Since之后；

6、通过访问修饰符控制序列化和反序列化

访问修饰符包括：public、private、protected、static 、final等，注意：static 会自动被排除。
通过代码解释：

[java]  view plain  copy

 

1. <pre name="code" class="java">public class User {  
2.     private String name;  
3.     public boolean sex;  
4.     static int age;  
5. final String homeAddress;  
6. }  

[java]  view plain  copy

 

1. Gson gson = new GsonBuilder()  
2.         .excludeFieldsWithModifiers(Modifier.FINAL,Modifier.PRIVATE)  
3.         .create();  
4. System.out.println(gson.toJson(user));  
5. // 结果：{"sex":true}  

7、TypeAdapter的使用

TypeAdapter 是Gson的一个抽象类，用于接管某种类型的序列化和反序列化过程。

[java]  view plain  copy

 

1. public abstract class TypeAdapter<T> {  
2.     public abstract void write(JsonWriter out, T value) throws IOException;  
3.     public abstract T read(JsonReader in) throws IOException;  
4. }  

使用示例基本类型：

[java]  view plain  copy

 

1. Gson gson = new GsonBuilder()  
2.         .registerTypeAdapter(Integer.class, new TypeAdapter<Integer>() {  
3.             @Override  
4.             public void write(JsonWriter out, Integer value) throws IOException {  
5.                 out.value(String.valueOf(value));   
6.             }  
7.             @Override  
8.             public Integer read(JsonReader in) throws IOException {  
9.                 try {  
10.                     return Integer.parseInt(in.nextString());  
11.                 } catch (NumberFormatException e) {  
12.                     return -1;  
13.                 }  
14.             }  
15.         })  
16.         .create();  

使用示例自定义类型：

[java]  view plain  copy

 

1. <pre name="code" class="java"><pre name="code" class="java">Gson gson = new GsonBuilder()  
2.         .registerTypeAdapter(User.class, new UserTypeAdapter())  
3.         .create();  
4. UserTypeAdapter的定义：  
5. public class UserTypeAdapter extends TypeAdapter<User> {  
6.   
7.     @Override  
8.     public void write(JsonWriter out, User value) throws IOException {  
9.         out.beginObject();  
10.         out.name("name").value(value.name);  
11.         out.name("age").value(value.age);  
12.         out.name("sex").value(value.sex);  
13. out.name("homeAdress").value(value.homeAdress);  
14. out.endObject();   
15. }   
16. @Override  
17.  public User read(JsonReader in) throws IOException {  
18.  User user = new User();   
19. in.beginObject();   
20. while (in.hasNext()) {   
21. switch (in.nextName()) {   
22. case "name": user.name = in.nextString(); break;   
23. case "age": user.age = in.nextInt(); break;  
24.  case "home": case "home_address": case "homeAddress": user.homeAddress = in.nextString(); break;   
25. } }   
26. in.endObject();   
27. return user; }  
28. }  

8、JsonSerializer与JsonDeserializer的使用

如果你已经学会了TypeAdapter的使用，那么你就已经回使用这两个方法，他们唯一的区别在于TypeAdapter同时接管序列化和反序列化而JsonSerializer只接管序列化JsonDeserializer只接管反序列化。

9、@JsonAdapter注解的使用

该注解必须配合TypeAdpater，JsonSerializer或JsonDeserializer中的一个使用，其中是不需要

Gson gson = new GsonBuilder()

        .registerTypeAdapter(User.class, new UserTypeAdapter())

        .create();

直接Gson gson = new Gson();既可以将类似UserTypeAdapter的序列化和反序列化规则用于注解的类，使用示例：

[java]  view plain  copy

 

1. @JsonAdapter(UserTypeAdapter.class)  
2. public class User {  
3. private String name;//序列化时生效  
4. private boolean sex; private int age;  
5. private String homeAddress;// 和不写一样，不管是序列化还是反序列化都和正常使用一样  
6. }