原文链接:Gson — Mapping of Nested Objects
翻译:签到钱就到
在Gson博客文章中,我们研究了基本的功能。这篇文章,我们要关注一些更实际的数据,并且研究嵌套对象。你会学会如何简单地处理那些包含复杂数据的对象。
这只是我们Gson系列中的一篇。如果你对其他主题感兴趣,可以看一下下面的大纲:
Gson系列概览
- 用java-JSON实现序列化合反序列化
- 嵌套对象的映射
- 数组和列表对象的映射
- Mapping of Maps
- Mapping of Sets
- Mapping of Null Values
- Gson Model Annotations — How to Ignore Fields with @Expose
- Gson Model Annotations — How to Change the Naming of Fields with @SerializedName
- Gson Builder — Basics & Naming Policies
- Gson Builder — Force Serialization of null Values
- Gson Builder — Exclusion Strategies
- Gson Builder — Relax Gson with Lenient
- Gson Builder — Special Values of Floats & Doubles
- Gson Builder — Model Versioning
- Gson Builder — Formatting of Dates & Custom Date/Time Mapping
- Gson Builder — Pretty Printing
- Gson Builder — HTML Escaping
嵌套对象的序列化
我们喜欢用实际的例子来演示功能,所以,让我们扩展UserSimple模型。在之前的文章中,user模型只有一些标准的java类型:
public class UserSimple {
String name;
String email;
boolean isDeveloper;
int age;
}
现在我们的user也有了一个家庭地址,这个家庭地址也有自己的模型类UserAddress
:
public class UserNested {
String name;
String email;
boolean isDeveloper;
int age;
// new, see below!
UserAddress userAddress;
}
public class UserAddress {
String street;
String houseNumber;
String city;
String country;
}
换句话说,user现在是用一个UserNested
模型表示,其中有一个额外的一对一的地址对象。地址是在UserAddress
模型中表示的。
在java中,这两个模型能够通过类清晰地区分,并且我们通过UserAddress userAddress
字段保持引用。然而,在JSON里,没有类或引用。只有嵌套(nest)用户地址到用户对象中。通常,在JSON里我们只要用{}
在字段名字后创建一个新的对象:
{
"age": 26,
"email": "norman@futurestud.io",
"isDeveloper": true,
"name": "Norman",
"userAddress": {
"city": "Magdeburg",
"country": "Germany",
"houseNumber": "42A",
"street": "Main Street"
}
}
不同于其他属性(age
,email
,...),新的userAddress
没有直接的值。而是有一些包含在{}
内的子值。很重要的一点,需要你理解字段名字后面有括号的就是表明这是一个嵌套对象。
太多的理论。是时候见识一下Gson从UserNested
对象中创建了什么。你可能认识这个模式,Gson不需要任何配置。它会自动根据传进的类推断出数据结构:
UserAddress userAddress = new UserAddress(
"Main Street",
"42A",
"Magdeburg",
"Germany"
);
UserNested userObject = new UserNested(
"Norman",
"norman@futurestud.io",
26,
true,
userAddress
);
Gson gson = new Gson();
String userWithAddressJson = gson.toJson(userObject);
字符串userWithAddressJson
的值是令人关注:
{
"age": 26,
"email": "norman@futurestud.io",
"isDeveloper": true,
"name": "Norman",
"userAddress": {
"city": "Magdeburg",
"country": "Germany",
"houseNumber": "42A",
"street": "Main Street"
}
}
是的,Gson又一次按照字母顺序存储了字段,但结果正是我们期望的。Gson正确地创建了嵌套userAddress
JSON对象。当然,我们可以为用户的薪水方法或工作地址增加更多的嵌套对象。甚至嵌套对象里也能有嵌套对象!
在下一节中,我们会研究另一个方向。如何反序列化复杂的嵌套JSON到Java对象呢?
嵌套对象的反序列化
上一节中,我们假设模型已经有了,并且我们只要创建一个匹配的JSON。特别是对于在真实世界里的开发者,经常是相反的。API接口正在返回一些JSON数据,我们需要为那些数据创建模型类。
如果你已经读了第一篇文章的一些内容,你已经感觉到如何创建一个模型类。我们不想让你不耐烦,所以我们将从user的例子转移到一个精致的小餐馆。
{
"name": "Future Studio Steak House",
"owner": {
"name": "Christian",
"address": {
"city": "Magdeburg",
"country": "Germany",
"houseNumber": "42A",
"street": "Main Street"
}
},
"cook": {
"age": 18,
"name": "Marcus",
"salary": 1500
},
"waiter": {
"age": 18,
"name": "Norman",
"salary": 1000
}
}
这来自于我们的API接口,并且我们要利用Gson去自动创建匹配的Java对象。首先,你需要模型化基础类,所有顶级字段都在里面:
public class Restaurant {
String name;
Owner owner;
Cook cook;
Waiter waiter;
}
看一下我们是如何为name
创建一个String字符串,以及另外三个扩展的Java类?有些人已经有了不同的结果。创建一个Java对象并不需要太明确。例如,基于JSON,我们看到了有一样结构的cook
和watier
嵌套对象。你可以仍然创建一个不同的类,像上面做的一样,或者为他们俩只创建一个普通的Staff
类。
public class Restaurant {
String name;
Owner owner;
Staff cook;
Staff waiter;
}
其实,两个方法任意一个都可行。如果你还不确定用哪个,我们通常会创建一个额外的类避免未来可能发生的冲突。例如,如果cook模型改变了,但是waiter模型保持不变,你可能需要改变一堆代码。这样,我们暂时抛弃Staff
的解决方案。当然,我们仍要为第二层次的对象创建Java模型类:
public class Owner {
String name;
UserAddress address;
}
public class Cook {
String name;
int age;
int salary;
}
public class Waiter {
String name;
int age;
int salary;
}
好的,我们作了一点弊,第一部分重复使用了UserAddress
。但只是因为完美匹配 ;-)
尽管如此,我们希望你理解从一个JSON字符串创建Java模型类的过程。你需要从高层到最深层次遍历,直到你的嵌套JSON只剩下常规类型。
主要工作已经完成,我们可以把一切交给Gson。当然,如果正确我们所做的工作,它会优雅地处理一切,并创建只有几行的Java对象:
String restaurantJson = "{ 'name':'Future Studio Steak House', 'owner':{ 'name':'Christian', 'address':{ 'city':'Magdeburg', 'country':'Germany', 'houseNumber':'42', 'street':'Main Street'}},'cook':{ 'age':18, 'name': 'Marcus', 'salary': 1500 }, 'waiter':{ 'age':18, 'name': 'Norman', 'salary': 1000}}";
Gson gson = new Gson();
Restaurant restaurantObject = gson.fromJson(restaurantJson, Restaurant.class);
restaurantObject
对象自动地包含了JSON里的所有的信息 :
提示:从JSON创建Java模型类是一项单调乏味的工作。在你掌握了概念后,你可能想要使用工具自动化处理。我们相当喜欢用jsonschema2pojo.org。
译者注:你也可以使用GsonFormat(内有详细教程)。
安装方法
方法1:
1.Android studio File->Settings..->Plugins-->Browse repositores..搜索GsonFormat 2.安装插件,重启android studio
方法2:
1.下载 GsonFormat.jar , 2.Android studio File->Settings..->Plugins -->install plugin from disk.. 导入下载的 GsonFormat.jar , 3.重启 android studio .
使用方法:
1.在需要生成模板的java文件中,Android Studio顶部菜单项 Code->Generate->GsonFormat。
2.在弹出的对话框中,输入从网站获取的JSON数据例子。
3.GsonFormater会自动根据JSON数据生成一个设置界面,有需要调整的可以调整一下,然后点击ok就会自动生成拉。
展望
在这篇博客中,我们已经学会了如何用Gson处理嵌套对象。对于Gson序列化复杂的数据类型已经不是问题。甚至反序列化也不是啥大问题,但是你必须首先做一些创建合适模型类的工作。
如果你要反馈或提问,可以在评论里让我们知道,或者twitter@futurestud_io