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

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

作者:Norman Peitek

翻译:签到钱就到

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

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

Gson系列概览

  1. 用java-JSON实现序列化合反序列化
  2. 嵌套对象的映射
  3. 数组和列表对象的映射
  4. Map的映射
  5. Set的映射
  6. 空值的映射
  7. Gson 模型注释 — 如何忽略用@Expose标记的字段
  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

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

@Expose是一个可选的,提供两个配置参数:serializedeserialize。默认情况下所有的都是设置为true。这样,如果你不用@Expose去增强字段,像我们第一篇博客里一样,所有的将会被包括在里面。如果你设置了@Expose,但也没有设置某个特定的值为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标签会在JSON中显示。其它的两个字段,即使它们设置了,也不会被转换。

另一方面,反序列化,Java对象也只有JSON中的nameage字段,emailisDeveloper将会被忽略。

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

transient

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

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

展望

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

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

你可能感兴趣的:(Gson——如何忽略用@Expose标记的字段)