Gson教程九(译):强制序列化null值

该文章翻译自Gson Tutorial Series系列教程。该篇主要阐述了强制序列化null值。

在上一篇博客中,我们已经向你展示了GsonBuilder的基础。GsonBuilder可以用于自定义Gson的行为,从而影响序列化和反序列化的方方面面。在这篇博客中,你将学会如何使用强制Gson序列化空值。

空值的序列化

还记得之前发布的关于空值映射的博客吗?它通过很多例子向我们展示了,当值为空时Gson是如何行为的。如果你还没有阅读,你或许可以移步到那篇博客获取有价值的信息。如果你很心急,我们直接告诉你要点:当属性的值设为空时将不会被序列化。

忽略空值这一行为对于减少JSON字符串的体积来说通常是个好主意。然而,并不总是如此。有些API会强制要求该域存在或者null值对于某一属性来说有特定的含义(换句话说,某值的默认值不是为空;我们需要明确的设置它为空)。

Gson为改变这一默认的行为提供了选择。我们可以使用GsonBuilder来为序列化提供null值。如果你还不熟悉GsonBuilder,请阅读上一篇博客。

我们复用之前博客中的UserSimple模型。

public class UserSimple {  
    String name;
    String email;
    boolean isDeveloper;
    int age;
}

现在,我们为其创建一个email为空的用户实例。

Gson gson = new Gson();  
UserSimple user = new UserSimple("Norman", null, 26, true);  
String usersJson = gson.toJson(user); 

默认设置下,email属性将不会在JSON结果中出现:

{
  "age": 26,
  "isDeveloper": true,
  "name": "Norman"
}

如果你要求email域作为JSON的一部分,你需要调用GsonBuilder.serializeNulls()方法。如果你这样做了,Gson将会序列化所有属性,即使属性设置为空:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.serializeNulls();  
Gson gson = gsonBuilder.create();

UserSimple user = new UserSimple("Norman", null, 26, true);  
String usersJson = gson.toJson(user);  

usersJson现在包括email域了:

{
  "age": 26,
  "email": null,
  "isDeveloper": true,
  "name": "Norman"
}

前瞻

在这篇博客中你已经学会了如何强制Gson序列化值为空的属性。

在下一篇博客中,我们将向你展示如何自定义选择哪些域可以序列化和反序列化。

推荐阅读更多精彩内容