Gson——如何忽略用@Expose标记的字段

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Gson——如何忽略用@Expose标记的字段相关的知识,希望对你有一定的参考价值。

参考技术A 在我们之前的几篇Gson的博客,我们总是假设你要(反)序列化一个模型中的所有属性。那可能不符合所有情况。如果你想要自定义(反)序列化,请继续阅读!

当然,这不是我们Gson系列里唯一的一篇文章,如果你对其他的主题感兴趣,可以看一下我们的大纲:

读了上篇关于 空值处理的文章 ,你应该想到当你不想要在JSON中显示的时候,应该为这个Java字段设置 null 。尤其是当你不想要通过网络传递私有或敏感数据时,如何处理很关键。不过,不用担心,Gson提供了一个简单的注释 @Expose 来解决。

@Expose 是一个可选的,提供两个配置参数: serialize 和 deserialize 。默认情况下所有的都是设置为 true 。这样,如果你不用 @Expose 去增强字段,像我们第一篇博客里一样,所有的将会被包括在里面。如果你设置了 @Expose ,但也没有设置某个特定的值为 false ,它也仍然会被包括在里面。

让我们再回顾一下 UserSimple 类,并且添加一些 @Expose 注释:

上面的例子的在序列化过程中只有 name 和 isDeveloper 标签会在JSON中显示。其它的两个字段,即使它们设置了,也不会被转换。

另一方面,反序列化,Java对象也只有JSON中的 name 和 age 字段, email 和 isDeveloper 将会被忽略。

添加 @Expose 是一个非常简单的控制哪些要被(反)序列化的方式。我们建议如果需要所有的都被转化,就不用添加 @Expose 了。不然只会搞乱你的模型类。

相对于使用 @Expose ,另一个方案是使用 transient ,一个 transient 字段不会(反)被序列化。然而,你没有像 @Expose 一样的完全控制权。你不能只一个方向激活, transient 会为那个属性永久地关闭转换:

这篇文章中,你学会了在(反)序列化过程中如何配置 @Expose 去包括和去除模型属性。你可能在日常工作中需要用到这个,所以,确保正确理解它。

如果你需要反馈或有疑问,在评论中让我们知道或twitter @futurestud_io 。

Gson空值映射问题,当实体类字段不全Gson的映射

参考技术A 如果返回的Json数据中,某个实体类的字段不全,那么Gson能够为我们做相应的实体映射?

我们将一个User实体进行序列化得到 Json 数据

现在我们只需要知道序列化会忽略 null,如图所示

userid就已经消失了,因为此值为null

将以下JSON 反序列化:

此处已经删去 userid 、 password 、 gender 、 headPic

以上是关于Gson——如何忽略用@Expose标记的字段的主要内容,如果未能解决你的问题,请参考以下文章

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

通过Gson过滤多余的字段

Gson:@Expose 与 @SerializedName

使用 Gson 序列化具有瞬态字段的对象

你真的会用Gson吗?Gson使用指南

gson的 Expose注解和 SerializedName注解