之前翻译了Gson User Guide,觉得很多用法还不是很清楚,特翻译Gson Tutorial Series这一系列不错的教程。这里是该系列的首篇。
Gson依赖
该指南是实践性的并会立刻实现一些序列化。因为大部分的读者来自Android开发者,因此这是专门为你们定制的,但是Gson可以用于任何的Java环境。在我们开始之前,我们得将Gson库引进项目。在我写该文档时,最新版本为2.8.2。如果你使用的是Gradle,请添加下行代码:
compile 'com.google.code.gson:gson:2.8.2'
如果你使用的是Maven,你可以添加下面的依赖:
com.google.code.gson
gson
2.8.2
compile
对于其他开发者,你可以在其官方Github仓库下载相应的jar包。
基本的Java-JSON序列化
让我们做一些序列化工作吧!Serialization在Gson中的意思是将一个Java对象映射为相应的JSON表达方式。在稍后的教程中,我们会采用稍微复杂一点的数据,但是现在,我们以一个相当简单的UserSimplement对象开始:
public class UserSimple {
String name;
String email;
int age;
boolean isDeveloper;
}
这个user对象有四个属性:
- user的name是一个字符串类型
- user的email也是一个字符串类型
- user的age是一个整型,意味着年龄存储的是年数(比如26岁,而不是准确的生日日期!)
- 最后的布尔类型isDeveloper表示是否是一个开发者
我们的Android或者Java程序需要将一个UserSimple对象转换为相应的JSON形式。
假设我们希望成员名称相同,我们希望该博客的作者Norman的JSON形式如下:
{
"name": "Norman",
"email": "[email protected]",
"age": 26,
"isDeveloper": true
}
让我们看一下如何使用Gson完成此一转换。首先,我们需要为Norman创建一个Java对象:
UserSimple userObject = new UserSimple(
"Norman",
"[email protected]",
26,
true
);
完成序列化,需要一个Gson对象。构造器提供了一种简单的方式:
Gson gson = new Gson();
接下来,我们需要调用toJson以及传入UserSimple对象:
String userJson = gson.toJson(userObject);
userJson包含如下值:
{
"age": 26,
"email": "[email protected]",
"isDeveloper": true,
"name": "Norman"
}
Gson改变了属性之间的顺序(以字母顺序排序),但是内容是相同的!注意Gson所希望的类型。String值被""包裹,而整型值不被包裹。我们不必为JSON的诸多对象或者复制单个成员而烦恼。Gson通过一个调用足以映射整个对象。这对于我们处理复杂的数据结构会是相当有帮助的。在我们继续深入之前,我们得转向另一个方向。Gson是否能够基于JSON创建一个Java对象?
基本的JSON-Java反序列化
首先,我们需要穿件一个字符串,该字符串包含上面提到的JSON:
String userJson = "{'age':26,'email':'[email protected]','isDeveloper':true,'name':'Norman'}";
我们在这里使用'而非"以避免使用大量的"转义。然而,无论哪种方式。下一步就如你可能猜想的,创建一个Gson实例:
Gson gson = new Gson();
最后我们需要使用fromJson()将JSON映射为一个Java对象:
UserSimple userObject = gson.fromJson(userJson, UserSimple.class);
注意我们必须传递的第二个参数为我们希望的Java对象。否则,Gson不知道它该映射到哪里。它并不是一个魔术师!
如果我们使用debugger并查看userObject的结果,我们发现Gson成功的映射了所有的属性: