Gson——如何忽略用@Expose標(biāo)記的字段

原文鏈接:Gson Model Annotations — How to Ignore Fields with @Expose

作者:Norman Peitek

翻譯:簽到錢就到

在我們之前的幾篇Gson的博客,我們總是假設(shè)你要(反)序列化一個模型中的所有屬性。那可能不符合所有情況。如果你想要自定義(反)序列化柱搜,請繼續(xù)閱讀佣渴!

當(dāng)然,這不是我們Gson系列里唯一的一篇文章桂肌,如果你對其他的主題感興趣数焊,可以看一下我們的大綱:

Gson系列概覽

  1. 用java-JSON實(shí)現(xiàn)序列化合反序列化
  2. 嵌套對象的映射
  3. 數(shù)組和列表對象的映射
  4. Map的映射
  5. Set的映射
  6. 空值的映射
  7. Gson 模型注釋 — 如何忽略用@Expose標(biāo)記的字段
  8. Gson Model Annotations — How to Change the Naming of Fields with @SerializedName
  9. Gson Builder — Basics & Naming Policies
  10. Gson Builder — Force Serialization of null Values
  11. Gson Builder — Exclusion Strategies
  12. Gson Builder — Relax Gson with Lenient
  13. Gson Builder — Special Values of Floats & Doubles
  14. Gson Builder — Model Versioning
  15. Gson Builder — Formatting of Dates & Custom Date/Time Mapping
  16. Gson Builder — Pretty Printing
  17. Gson Builder — HTML Escaping

模型注釋@Expose

讀了上篇關(guān)于空值處理的文章,你應(yīng)該想到當(dāng)你不想要在JSON中顯示的時候,應(yīng)該為這個Java字段設(shè)置null崎场。尤其是當(dāng)你不想要通過網(wǎng)絡(luò)傳遞私有或敏感數(shù)據(jù)時佩耳,如何處理很關(guān)鍵。不過谭跨,不用擔(dān)心干厚,Gson提供了一個簡單的注釋@Expose來解決。

@Expose是一個可選的螃宙,提供兩個配置參數(shù):serializedeserialize蛮瞄。默認(rèn)情況下所有的都是設(shè)置為true。這樣谆扎,如果你不用@Expose去增強(qiáng)字段挂捅,像我們第一篇博客里一樣,所有的將會被包括在里面燕酷。如果你設(shè)置了@Expose籍凝,但也沒有設(shè)置某個特定的值為false,它也仍然會被包括在里面苗缩。

讓我們再回顧一下UserSimple類饵蒂,并且添加一些@Expose注釋:

public class UserSimple {  
    @Expose()
    String name; // equals serialize & deserialize

    @Expose(serialize = false, deserialize = false)
    String email; // equals neither serialize nor deserialize

    @Expose(serialize = false)
    int age; // equals only deserialize

    @Expose(deserialize = false)
    boolean isDeveloper; // equals only serialize
}

上面的例子的在序列化過程中只有nameisDeveloper標(biāo)簽會在JSON中顯示。其它的兩個字段酱讶,即使它們設(shè)置了退盯,也不會被轉(zhuǎn)換。

另一方面泻肯,反序列化渊迁,Java對象也只有JSON中的nameage字段,emailisDeveloper將會被忽略灶挟。

添加@Expose是一個非常簡單的控制哪些要被(反)序列化的方式琉朽。我們建議如果需要所有的都被轉(zhuǎn)化,就不用添加@Expose了稚铣。不然只會搞亂你的模型類箱叁。

transient

相對于使用@Expose墅垮,另一個方案是使用transient,一個transient字段不會(反)被序列化耕漱。然而算色,你沒有像@Expose一樣的完全控制權(quán)。你不能只一個方向激活螟够,transient會為那個屬性永久地關(guān)閉轉(zhuǎn)換:

public class UserSimple {  
    String name;
    String email;
    int age;
    boolean transient isDeveloper; // will not be serialized or deserialized
}

展望

這篇文章中灾梦,你學(xué)會了在(反)序列化過程中如何配置@Expose去包括和去除模型屬性。你可能在日常工作中需要用到這個妓笙,所以若河,確保正確理解它。

如果你需要反饋或有疑問,在評論中讓我們知道或twitter @futurestud_io给郊。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末牡肉,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子淆九,更是在濱河造成了極大的恐慌统锤,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,430評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件炭庙,死亡現(xiàn)場離奇詭異饲窿,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)焕蹄,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,406評論 3 398
  • 文/潘曉璐 我一進(jìn)店門逾雄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人腻脏,你說我怎么就攤上這事鸦泳。” “怎么了永品?”我有些...
    開封第一講書人閱讀 167,834評論 0 360
  • 文/不壞的土叔 我叫張陵做鹰,是天一觀的道長。 經(jīng)常有香客問我鼎姐,道長钾麸,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,543評論 1 296
  • 正文 為了忘掉前任炕桨,我火速辦了婚禮饭尝,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘献宫。我一直安慰自己钥平,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,547評論 6 397
  • 文/花漫 我一把揭開白布姊途。 她就那樣靜靜地躺著涉瘾,像睡著了一般奈惑。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上睡汹,一...
    開封第一講書人閱讀 52,196評論 1 308
  • 那天,我揣著相機(jī)與錄音寂殉,去河邊找鬼囚巴。 笑死,一個胖子當(dāng)著我的面吹牛友扰,可吹牛的內(nèi)容都是我干的彤叉。 我是一名探鬼主播,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼村怪,長吁一口氣:“原來是場噩夢啊……” “哼秽浇!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起甚负,我...
    開封第一講書人閱讀 39,671評論 0 276
  • 序言:老撾萬榮一對情侶失蹤柬焕,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后梭域,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體斑举,經(jīng)...
    沈念sama閱讀 46,221評論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,303評論 3 340
  • 正文 我和宋清朗相戀三年病涨,在試婚紗的時候發(fā)現(xiàn)自己被綠了富玷。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,444評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡既穆,死狀恐怖赎懦,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情幻工,我是刑警寧澤励两,帶...
    沈念sama閱讀 36,134評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站会钝,受9級特大地震影響伐蒋,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜迁酸,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,810評論 3 333
  • 文/蒙蒙 一先鱼、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧奸鬓,春花似錦焙畔、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,285評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽儿惫。三九已至,卻和暖如春伸但,著一層夾襖步出監(jiān)牢的瞬間肾请,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,399評論 1 272
  • 我被黑心中介騙來泰國打工更胖, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留铛铁,地道東北人。 一個月前我還...
    沈念sama閱讀 48,837評論 3 376
  • 正文 我出身青樓却妨,卻偏偏與公主長得像饵逐,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子彪标,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,455評論 2 359

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