该文章翻译自Gson Tutorial Series系列教程。该篇主要阐述了当JSON为按标准书写时,Gson会以什么方式应对。
注:文中的“仁慈的”一词翻译自英文Lenient,其大意是具有一定的容错机制,因为不好翻译,所以暂且如此
JSON内容的格式必须完全遵守一些标准规则。该标准是在RFC4627规范描述的。它所依赖的基础是键和值的分离,数组是如何结构化的等等。在这篇博客中,我们将会探索Gson和JSON规范之间的关系。
默认是仁慈的?
首先,当Gson序列化一个Java对象到JSON时,该JSON会100%遵循标准。因此,我们感兴趣的部分是反序列化时Gson会如何行为!
在内部,Gson使用一个JsonReader类。该类可以选择是否具有一定的仁慈性。默认情况是不具有的,这意味着只能接收遵循标准的JSON输入。如果JSON违反了任意一条标准规则,JsonReader以及随之的Gson将会抛出异常。然而,JsonReader也可以设置为具有仁慈性。然后,也仅有如此,它会吞下容忍这些错误,尽自己最大的努力去解析这一有格式问题的JSON。
让我们引用一些没有遵循JSON标准要素的文档
Streams that start with the non-execute prefix, ")]}'\n".
Streams that include multiple top-level values. With strict parsing, each stream must contain exactly one top-level value.
Top-level values of any type. With strict parsing, the top-level value must be an object or an array.
Numbers may be NaNs or infinities.
End of line comments starting with // or # and ending with a newline character.
C-style comments starting with /* and ending with */. Such comments may not be nested.
Names that are unquoted or 'single quoted'.
Strings that are unquoted or 'single quoted'.
Array elements separated by ; instead of ,.
Unnecessary array separators. These are interpreted as if null was the omitted value.
Names and values separated by = or => instead of :.
Name/value pairs separated by ; instead of ,.
所有这些会如何影响你的Gson呢?理论上,Gson(不像JsonReader)默认情况下是仁慈的。所以通常情况下你不需要启动它,即使你的JSON是错误的。不幸的是,Gson在面对这些问题时的行为表现的有点疑惑。继续向前,我们将会更新你的认识。
你一定记得Gson可以选择在反序列化JSON的过程中拥有更大的容忍度。如果你需要设置这一点,使用GsonBuilder:
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setLenient();
Gson gson = gsonBuilder.create();
使你的Gson实例具有仁慈性可以解决一些具有结构错误的问题。然而,其仁慈性也仅仅能够如此。如果JSON违背了超过上面我们所实例的所有错误,Gson会抛出MalformedJsonException异常。如果是这样,那么你需要检查你的JSON看看它的结构是否合法。大部分情况下,这是你问题的根源。
我们推荐你使用像JSONLint这样的工具检查你的JSON是否合法。
前瞻
在这篇博客中,你已经懂得了,反序列化过程中,“仁慈的”在上下文中是什么意思。你也意识到了Gson的行为在这样的问题面前不是100%清楚的。理论上,Gson应该默认设置为仁慈的。如果你要求为仁慈的,我们推荐你通过GsonBuilder来设置仁慈行,这是因为在未来的更新中将会改变默认行为。
在下篇博客中,我们将探究Gson如何序列化浮点型!