如何實現 Gson 序列化/反序列化過程中 過濾指定字段

最近在項目中使用到Retrofit來做網絡請求,Retrofit框架中有個非常好用的參數@body,該參數在做post請求的時候,能夠將封裝了請求參數的JavaBean對象 直接序列化然后發送到服務器,如圖一:


圖一

想一想,當你需要使用post請求向服務器提交一大堆數據(如圖二)的時候,你內心是不是崩潰的!

圖二 .需要提交的數據參數

然而,當你配合Retrofit的@Body 你的接口請求可以寫成這樣(如圖三)!簡直就是藝術!有木有!有木有!


圖三.

可是,這并不完美!如果你使用這種方式做Post請求,你可能會像我一樣,讓后端的童鞋感到莫名其妙,請求參數明明只有a,b,c;你傳過去的請求參數里面為什么除了a,b,c,還有一大丟亂七八糟的 e,f,g? 原因很簡單:因為我們封裝了參數的JavaBean 里面,往往會有一些我們不需要傳遞給服務器的參數數據 ,但確是需要存在的數據 ?比如圖三中用Order對象 在創建訂單的時候,他的id對于此次請求是多余的參數,但是在另外的一個獲取Order列表的請求中,這個id就能派上用場了;

所以問題來了(回歸正題^_^),我們能不能在向服務器提交請求的時候,將JavaBean在序列化的過程中剔除多余參數,然后又不影響請求的數據反序列化為JavaBean,好像很拗口,具體來說就是,比如這個Order對象在提交給服務器的時候,其序列化的過程中能不能過濾掉id參數,然后又不影響在獲取Order列表的時候 ?Json數據反序列化為Order對象的時候對id成員變量的賦值。

當然可以!使用@Expose 注解便可以實現(如圖四):

圖四

@Expose 有兩個參數 serialize 和 deserialize,即序列化與反序列化,當不指定的時候 默認都為true ; 而且該注解只在Gson通過

Gson gson=new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();方式創建的時候有效,也就是在通過Gson gson=new Gson()方式創建的時候,@Expose注解是無效的。也就是有沒有都一樣,切記!

圖四中 在Gson使用GsonBuilder創建下,Post請求中,id,code以及a字段會在序列化過程中過濾掉,也就是通過Retrofit向服務器提交Order對象的時候,服務器端只能接受到remark和list對應的數據 ,除此之外的字段因為在序列化的過程中被忽略而沒有提交給服務器。你可能注意到了list字段的@Expose注解 其deserialize=false, 這是因為我list字段在序列化的過程中是服務器需要的數據,但是在反序列化的過程中不希望他被賦值 所以在此進行了過濾。

也許有童鞋會問。還有其它方式沒有,答案是有的,Gson 序列化/反序列化過程中過濾指定字段的方式大概有四種,此處只是說到了其中的一種而已 ,其它的三種:排除transient字段排除Modifier為指定類型的字段使用ExclusionStrategy定制字段排除策略

排除transient字段:給字段添加transient字段 然后在 序列化/反序列化過程中該字段都會被過濾 不能單獨對某一過程設置;

排除Modifier為指定類型的字段:通過Gson gson =newGsonBuilder().excludeFieldsWithModifiers(Modifier.PROTECTED) 方式獲取Gson并設置過濾域的修飾詞 ?此處為過濾protected修飾的字段 也是同時作用于序列化/反序列化 不能單獨對某一過程設置(待考證)

使用ExclusionStrategy定制字段排除策略:也是通過newGsonBuilder()來設置,自定義程度很高(等效于同時設置GsonBuilder的addSerializationExclusionStrategyaddDeserializationExclusionStrategy方法),詳情百度即可,在此就不作詳述了

OK,就講這么多吧;純手寫,如果對大家有用,別忘了星星我哦,嘿嘿. ?

PS.不足之處,還望指正,畢竟技術有限,期待大神們的指導 謝謝

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

推薦閱讀更多精彩內容