Gson Model Annotations － 如何使用@SerializedName更改字段命名

原文链接：Gson Model Annotations — How to Change the Naming of Fields with @SerializedName
原文出自：Norman Peitek
译者：無名

在之前的 Gson 系列博客文章中，我们介绍过了第一个用来控制属性序列化和反序列化的注解 @Expose ，在这篇文章中，我们将介绍下一个更改名称映射的注解 @SerializedName，请继续阅读。

注解 @SerializedName

除了之前博客介绍过的 @Expose 注解，@SerializedName 是另一个非常实用的注解。@SerializedName 注解更改了自动匹配 JSON 字段的方式，平时开发中，我们总是默认保持 Java 类属性字段名和 JSON 的字段是一一对应，可有使用并不是总是这样的情况，也许你没有访问继承 Java 类或者你必须遵守公司的命名规则，这就需要使 @SerializedName 注解来匹配 Gson 字段，是一种非常优雅的方式。

来看一个例子：

public class UserSimple {
    String name; 
    String email;
    boolean isDeveloper;
    int age;
}

如果没有使用 @Expose， UserSimple 类中的字段将都会被一一被映射。

但是，假设有一刻 API 发生改变导致返回的 JSON 数据格式发生更改，接口返回了 "fullName" 而不是"name"。

{ 
    "age": 26,
    "email":  "[email protected]", 
    "fullName": "Norman", 
    "isDeveloper": true
}

不用担心，我们不要改动任何代码，我们只需要给类中改变的字段添加注解即可。

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

使用 Gson 进行注解，并在此运行，这就是是使用注解自动匹配的好处。

当然，你可以使用注解 @SerializedName 方式来保证命名规范，同时又可以正常映射接口字段，如果你的接口字段和命名规则差别很大，使用@SerializedName 注解来解决还是有必要的。

目标

学会使用注解 @SerializedName 来自定义影射规则。下一篇我们将讨论关于属性和映射命名问题。

练习代码已上传 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 - 如何解析多态对象

更多内容可关注公众号查看