美文网首页Android知识Android开发
如何实现 Gson 序列化/反序列化过程中 过滤指定字段

如何实现 Gson 序列化/反序列化过程中 过滤指定字段

作者: 5Mall | 来源:发表于2016-12-15 14:41 被阅读4212次

    最近在项目中使用到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.不足之处,还望指正,毕竟技术有限,期待大神们的指导 谢谢

    相关文章

      网友评论

        本文标题:如何实现 Gson 序列化/反序列化过程中 过滤指定字段

        本文链接:https://www.haomeiwen.com/subject/katgmttx.html