如何使用@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": "norman@futurestud.io", "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 & Doubles17、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 - 如何解析多态对象

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容