如何使用@SerializedName更改字段命名

原文鏈接:Gson Model Annotations — How to Change the Naming of Fields with @SerializedName原文出自:Norman Peitek譯者:無(wú)名無(wú)
在之前的 Gson 系列博客文章中,我們介紹過了第一個(gè)用來(lái)控制屬性序列化和反序列化的注解 @Expose ,在這篇文章中,我們將介紹下一個(gè)更改名稱映射的注解 @SerializedName,請(qǐng)繼續(xù)閱讀。
注解 @SerializedName
除了之前博客介紹過的 @Expose 注解,@SerializedName 是另一個(gè)非常實(shí)用的注解。@SerializedName 注解更改了自動(dòng)匹配 JSON 字段的方式,平時(shí)開發(fā)中,我們總是默認(rèn)保持 Java 類屬性字段名和 JSON 的字段是一一對(duì)應(yīng),可有使用并不是總是這樣的情況,也許你沒有訪問繼承 Java 類或者你必須遵守公司的命名規(guī)則,這就需要使 @SerializedName 注解來(lái)匹配 Gson 字段,是一種非常優(yōu)雅的方式。
來(lái)看一個(gè)例子:
public class UserSimple { String name; String email; boolean isDeveloper; int age;}

如果沒有使用 @Expose, UserSimple 類中的字段將都會(huì)被一一被映射。
但是,假設(shè)有一刻 API 發(fā)生改變導(dǎo)致返回的 JSON 數(shù)據(jù)格式發(fā)生更改,接口返回了 "fullName" 而不是"name"。
{ "age": 26, "email": "norman@futurestud.io", "fullName": "Norman", "isDeveloper": true}

不用擔(dān)心,我們不要改動(dòng)任何代碼,我們只需要給類中改變的字段添加注解即可。
public class UserSimple { @SerializedName("fullName") String name; String email; boolean isDeveloper; int age; }

使用 Gson 進(jìn)行注解,并在此運(yùn)行,這就是是使用注解自動(dòng)匹配的好處。
當(dāng)然,你可以使用注解 @SerializedName 方式來(lái)保證命名規(guī)范,同時(shí)又可以正常映射接口字段,如果你的接口字段和命名規(guī)則差別很大,使用@SerializedName 注解來(lái)解決還是有必要的。
目標(biāo)
學(xué)會(huì)使用注解 @SerializedName 來(lái)自定義影射規(guī)則。下一篇我們將討論關(guān)于屬性和映射命名問題。
練習(xí)代碼已上傳 Github https://github.com/whiskeyfei/Gson-Review 可自行查看。
Gson 系列文章翻譯回顧
1、Gson - Java-JSON 序列化和反序列化入門2、Gson - 映射嵌套對(duì)象3、Gson - Arrays 和 Lists 映射對(duì)象4、Gson - Map 結(jié)構(gòu)映射5、Gson - Set 集合映射6、Gson - 空值映射7、Gson Model Annotations - 如何使用 @SerializedName 更改字段命名8、Gson Model Annotations - @SerializedName 匹配多個(gè)反序列化名稱9、Gson Builder - 基礎(chǔ)和命名規(guī)則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 - 映射循環(huán)引用21、Gson Advanced - 泛型22、Gson Advanced - 簡(jiǎn)單自定義序列化 (Part 1)24、Gson Advanced - 自定義反序列化基礎(chǔ)25、Gson Advanced - 自定義對(duì)象實(shí)例創(chuàng)建26、Gson Advanced - 通過 @JsonAdapter 自定義(反)序列化過程32、Practical Gson - 如何解析多態(tài)對(duì)象

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,646評(píng)論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,595評(píng)論 3 418
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,560評(píng)論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,035評(píng)論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,814評(píng)論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,224評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,301評(píng)論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,444評(píng)論 0 288
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,988評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,804評(píng)論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,998評(píng)論 1 370
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,544評(píng)論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,237評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評(píng)論 1 287
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,706評(píng)論 3 393
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,993評(píng)論 2 374

推薦閱讀更多精彩內(nèi)容