Gson Model Annotations － @Serial

原文链接：Gson Model Annotations — Multiple Deserialization Names with @SerializedName
原文出自：Norman Peitek
译者：無名無

在之前的 Gson 系列博客文章中，我们介绍过了如何改变 Java Model 变量的序列化命名。如果你的服务器接口返回了不同的字段名，你可以使用 @SerializedName 注解来解决这个问题。

在这篇文章中，我们将介绍如何将多个字段名称映射到一个字段属性上。如果你的应用有多个接口数据，那么使用 @SerializedName 注解就可以解决，你仍然可以使用原来的model类，而不必增加新的model类。

@SerializedName 延伸

在第一个 @SerializedName 注解文章中，基本用法如下：

public class UserSimple {     
    @SerializedName("fullName")   
    String name;   
    String email;   
    boolean isDeveloper;    
    int age;
}

给 Model 变量添加注解，并可以序列化和反序列化。

但是，还不能满足我们的需求，SerializedName 接受两个参数，value、alternate，第一个value是默认参数，如果你只填了一个参数，那这个值将会赋值给 value，第二个 alternate 就为空，同样都填上也是ok的。

public class UserSimpleSerializedName {      
      @SerializedName(value = "fullName", alternate = "username")    
      private String name;  
      private String email;
      private boolean isDeveloper;   
      private int age;
}  

SerializedName 改变了默认序列化和默认反序列化的字段取值，所以，如果你使用 Gson 将 Java model 类生称 JSON 串，结果就是 value 的名称就是字段的名称。

alternate 属性是用在反序列化上的，也就是说从 JSON 到 Java 类的过程。Gson 会帮我们匹配 JSON 中的命名，并尝试找到一个字段映射。对于上面例子model类中，Gson 会将字段 fullname 或者 username 映射到字符串 name上。无论哪一个都会映射。

如果在 model 中给变量使用了 @SerializedName 的两个属性，那么最终会返回相同的 Java 对象，例如：

{    
  'fullName': 'Norman',   
 'email': 'norman@futurestud.io'
}

{    
    'username': 'Norman',   
    'email': 'norman@futurestud.io'
}

再来看一个例子：

   {
       'username': 'Norman',   
       'fullName': 'Marcus',   
       'email': 'norman@futurestud.io'
  }

如果多个字段匹配一个变量字段，谁在后面Gson就会将值赋给谁，结果最终是 name:Marcus。

目标

在这篇文章中，你将掌握 @SerializedName 注解的两个属性用法，需要注意是，只有在反序列化时两个属性才会起作用，正常的序列化还是 Java Model 的字段名。

你可以通过评论或twitter @futurestud_io 反馈你的问题。

练习代码已上传 Github https://github.com/whiskeyfei/Gson-Review 可自行查看。

Gson 系列文章翻译回顾

1、Gson - Java-JSON 序列化和反序列化入门
2、Gson - 映射嵌套对象
3、Gson - Arrays 和 Lists 映射对象
4、Gson - Map 结构映射
5、Gson - Set 集合映射
6、Gson - 空值映射
7、Gson Model Annotations - 如何使用 @SerializedName 更改字段的命名
8、Gson Model Annotations - @SerializedName 匹配多个反序列化名称
9、Gson Builder - 基础和命名规则
10、Gson Builder - 序列化空值
11、Gson Builder - 忽略策略
12、Gson Builder - Gson Lenient 属性
13、Gson Builder - 特殊类型 Floats & Doubles
17、Gson Builder - 如何使用 @Expose 忽略字段
19、Gson Advanced - 映射枚举类型
20、Gson Advanced - 映射循环引用
21、Gson Advanced - 泛型
22、Gson Advanced - 简单自定义序列化 (Part 1)
24、Gson Advanced - 自定义反序列化基础
25、Gson Advanced - 自定义对象实例创建
26、Gson Advanced - 通过 @JsonAdapter 自定义(反)序列化过程
32、Practical Gson - 如何解析多态对象

学习讨论

刚刚建了一个 Android 开源库分享学习群，有兴趣的小伙伴可以加入一起学习。

群二维码