原文鏈接:Gson — Mapping of Nested Objects
翻譯:簽到錢就到
在Gson博客文章中返奉,我們研究了基本的功能偏友。這篇文章,我們要關(guān)注一些更實(shí)際的數(shù)據(jù)行楞,并且研究嵌套對(duì)象藕甩。你會(huì)學(xué)會(huì)如何簡(jiǎn)單地處理那些包含復(fù)雜數(shù)據(jù)的對(duì)象。
這只是我們Gson系列中的一篇曹傀。如果你對(duì)其他主題感興趣辐脖,可以看一下下面的大綱:
Gson系列概覽
- 用java-JSON實(shí)現(xiàn)序列化合反序列化
- 嵌套對(duì)象的映射
- Mapping of Arrays and Lists of Objects
- 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
嵌套對(duì)象的序列化
我們喜歡用實(shí)際的例子來(lái)演示功能,所以皆愉,讓我們擴(kuò)展UserSimple模型嗜价。在之前的文章中,user模型只有一些標(biāo)準(zhǔn)的java類型:
public class UserSimple {
String name;
String email;
boolean isDeveloper;
int age;
}
現(xiàn)在我們的user也有了一個(gè)家庭地址幕庐,這個(gè)家庭地址也有自己的模型類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;
}
換句話說(shuō)久锥,user現(xiàn)在是用一個(gè)UserNested
模型表示,其中有一個(gè)額外的一對(duì)一的地址對(duì)象。地址是在UserAddress
模型中表示的异剥。
在java中瑟由,這兩個(gè)模型能夠通過(guò)類清晰地區(qū)分,并且我們通過(guò)UserAddress userAddress
字段保持引用冤寿。然而歹苦,在JSON里,沒(méi)有類或引用督怜。只有嵌套(nest)用戶地址到用戶對(duì)象中殴瘦。基本地号杠,在JSON里我們只要用{}
在字段名字后創(chuàng)建一個(gè)新的對(duì)象:
{
"age": 26,
"email": "norman@futurestud.io",
"isDeveloper": true,
"name": "Norman",
"userAddress": {
"city": "Magdeburg",
"country": "Germany",
"houseNumber": "42A",
"street": "Main Street"
}
}
不同于其他屬性(age
蚪腋,email
,...),新的userAddress
沒(méi)有直接的值究流。而是有一些包含在{}
內(nèi)的子值辣吃。很重要的一點(diǎn),需要你理解字段名字后面有括號(hào)的就是表明這是一個(gè)嵌套對(duì)象芬探。
太多的理論神得。是時(shí)候見識(shí)一下Gson從UserNested
對(duì)象中創(chuàng)建了什么。你可能認(rèn)識(shí)這個(gè)模式偷仿,Gson不需要任何配置哩簿。它會(huì)自動(dòng)根據(jù)傳進(jìn)的類推斷出數(shù)據(jù)結(jié)構(gòu):
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);
你應(yīng)該會(huì)很好奇,字符串userWithAddressJson
的值是什么樣子的:
{
"age": 26,
"email": "norman@futurestud.io",
"isDeveloper": true,
"name": "Norman",
"userAddress": {
"city": "Magdeburg",
"country": "Germany",
"houseNumber": "42A",
"street": "Main Street"
}
}
細(xì)心的你很容易發(fā)現(xiàn)酝静,雖然Gson又一次按照字母順序存儲(chǔ)了字段节榜,但結(jié)果正是我們期望的。Gson正確地創(chuàng)建了嵌套userAddress
JSON對(duì)象别智。當(dāng)然宗苍,我們可以為用戶的薪水方法或工作地址增加更多的嵌套對(duì)象。甚至嵌套對(duì)象里也能有嵌套對(duì)象!
在下一節(jié)中讳窟,我們會(huì)研究另一個(gè)方向让歼。如何反序列化復(fù)雜的嵌套JSON到Java對(duì)象呢?
嵌套對(duì)象的反序列化
上一節(jié)中丽啡,我們假設(shè)模型已經(jīng)有了谋右,并且我們只要?jiǎng)?chuàng)建一個(gè)匹配的JSON。特別是對(duì)于在真實(shí)世界里的開發(fā)者补箍,經(jīng)常是相反的改执。API接口正在返回一些JSON數(shù)據(jù),我們需要為那些數(shù)據(jù)創(chuàng)建模型類坑雅。
如果你已經(jīng)讀了第一篇文章的一些內(nèi)容辈挂,你已經(jīng)感覺(jué)到如何創(chuàng)建一個(gè)模型類。防止你覺(jué)得無(wú)聊霞丧,所以我們將從user的例子轉(zhuǎn)移到一個(gè)精致的小餐館呢岗。
{
"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
}
}
這來(lái)自于我們的API接口,并且我們要利用Gson去自動(dòng)創(chuàng)建匹配的Java對(duì)象蛹尝。首先,你需要模型化基礎(chǔ)類,所有頂級(jí)字段都在里面:
public class Restaurant {
String name;
Owner owner;
Cook cook;
Waiter waiter;
}
看一下我們是如何為name
創(chuàng)建一個(gè)String字符串悉尾,以及另外三個(gè)擴(kuò)展的Java類突那?有些人自已實(shí)現(xiàn)了代碼,可能與下面的結(jié)果不同构眯。事實(shí)上愕难,創(chuàng)建一個(gè)Java對(duì)象并不需要太明確。例如惫霸,基于JSON猫缭,我們看到了有一樣結(jié)構(gòu)的cook
和watier
嵌套對(duì)象。你可以仍然創(chuàng)建一個(gè)不同的類壹店,像上面做的一樣猜丹,或者為他們倆只創(chuàng)建一個(gè)普通的Staff
類。
public class Restaurant {
String name;
Owner owner;
Staff cook;
Staff waiter;
}
其實(shí)硅卢,兩個(gè)方法任意一個(gè)都可行射窒。如果你還不確定用哪個(gè),我們通常會(huì)創(chuàng)建一個(gè)額外的類避免未來(lái)可能發(fā)生的沖突将塑。例如脉顿,如果cook模型改變了,但是waiter模型保持不變点寥,你可能需要改變一堆代碼艾疟。這樣,我們暫時(shí)拋棄Staff
的解決方案。當(dāng)然蔽莱,我們?nèi)砸獮榈诙哟蔚膶?duì)象創(chuàng)建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;
}
好的误褪,因?yàn)檫@個(gè)UserAddress
類到哪都能適用,我們作了一點(diǎn)弊碾褂,第一部分重復(fù)使用了UserAddress
兽间。 ;-)
總之,我們希望你理解從一個(gè)JSON字符串創(chuàng)建Java模型類的過(guò)程正塌。你需要從高層到最深層次遍歷,直到你的嵌套JSON只剩下常規(guī)類型嘀略。
既然主要工作已經(jīng)完成了,我們可以把一切交給Gson。當(dāng)然,如果我們之前所做的工作都是正確的,它會(huì)優(yōu)雅地處理一切乓诽,并創(chuàng)建只有幾行的Java對(duì)象:
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
對(duì)象自動(dòng)地包含了JSON里的所有的信息 :
![](https://futurestud.io/blog/content/images/2016/04/gson-nested.png)
提示:從JSON創(chuàng)建Java模型類是一項(xiàng)單調(diào)乏味的工作帜羊。在你掌握了概念后,你可能想要使用工具自動(dòng)化處理鸠天。我們相當(dāng)喜歡用jsonschema2pojo.org讼育。
展望
在這篇博客中,我們已經(jīng)學(xué)會(huì)了如何用Gson處理嵌套對(duì)象稠集。對(duì)于Gson序列化復(fù)雜的數(shù)據(jù)類型已經(jīng)不是問(wèn)題奶段。甚至反序列化也不是啥大問(wèn)題,但是你必須首先做一些創(chuàng)建合適模型類的工作剥纷。
如果你要反饋或提問(wèn)痹籍,可以在評(píng)論里讓我們知道,或者twitter@futurestud_io