Gson——数组和列表对象的映射

原文链接:Gson — Mapping of Nested Objects

作者:Norman Peitek

翻译:签到钱就到

在Gson博客文章中,我们研究了基本的功能。这篇文章,我们要关注一些更实际的数据,并且研究嵌套对象。你会学会如何简单地处理那些包含复杂数据的对象。

这只是我们Gson系列中的一篇。如果你对其他主题感兴趣,可以看一下下面的大纲:

Gson系列概览

  1. 用java-JSON实现序列化合反序列化
  2. 嵌套对象的映射
  3. 数组和列表对象的映射
  4. Mapping of Maps
  5. Mapping of Sets
  6. Mapping of Null Values
  7. Gson Model Annotations — How to Ignore Fields with @Expose
  8. Gson Model Annotations — How to Change the Naming of Fields with @SerializedName
  9. Gson Builder — Basics & Naming Policies
  10. Gson Builder — Force Serialization of null Values
  11. Gson Builder — Exclusion Strategies
  12. Gson Builder — Relax Gson with Lenient
  13. Gson Builder — Special Values of Floats & Doubles
  14. Gson Builder — Model Versioning
  15. Gson Builder — Formatting of Dates & Custom Date/Time Mapping
  16. Gson Builder — Pretty Printing
  17. 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"
    }
}

不同于其他属性(ageemail,...),新的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正确地创建了嵌套userAddressJSON对象。当然,我们可以为用户的薪水方法或工作地址增加更多的嵌套对象。甚至嵌套对象里也能有嵌套对象!

在下一节中,我们会研究另一个方向。如何反序列化复杂的嵌套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,我们看到了有一样结构的cookwatier嵌套对象。你可以仍然创建一个不同的类,像上面做的一样,或者为他们俩只创建一个普通的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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容