如何实现 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阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容