Gson - 映射嵌套对象

作者: 無名小子的杂货铺 | 来源:发表于2016-12-05 15:55 被阅读1287次

Gson教程二（译）：嵌套对象的序列化和反序列化
Gson 系列文章
Gson - 映射嵌套对象
Gson——嵌套对象的映射
Android之Google Gson介绍
Gson
java对象间同名映射
使用Gson解析Json字符串含有动态key(Dynamic K
GSON搞定任何JSON数据
Gson - Arrays 和 Lists 对象映射

原文链接：Gson — Mapping of Nested Objects
原文出自：Norman Peitek
译者：無名無

在上一篇 Gson 入门文章中，我们讨论了 Gson 的基本功能 Gson - Java-JSON 序列化和反序列化入门。本文我们将介绍更多复杂的数据结构还有嵌套对象是如何映射的。

嵌套对象序列化

我们希望通过实例来演示功能，所以让我们扩展 UserSimple Model 类，下面是扩展之前 UserSimple 类：

public class UserSimple {
    String name;
    String email;
    boolean isDeveloper;
    int age;
}

现在我们将 UserAddress 类添加到 UserSimple 中：

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;
}

换句话说，UserNested 类中包含了 UserAddress 对象，表示了用户和地址的一对一的关系，也就是嵌套对象。

在 UserNested 类中，我们通过 UserAddress userAddress 字段来保留在当前类中的引用。

但是，在 JSON 中我们没有类或者引用，JSON 中惟一的判断标示是数据中不再使用 ID 绑定数据，Gson 中只能根据 "{}" 标志来创建一个新对象。

结果如下：

{
    "age": 26,
    "email": "norman@futurestud.io",
    "isDeveloper": true,
    "name": "Norman",

    "userAddress": {
        "city": "Magdeburg",
        "country": "Germany",
        "houseNumber": "42A",
        "street": "Main Street"
    }
}

与其他属性不同,像 age 等值都是有明确的取值，新的 userAddress 字段没有直接的值，相反，它又包含了一个新的子数据，被包含在一个 "{}" 中。类型和父节点中相同，根据 "{}" 来判断是否是一个新的对象。本类 UserNested 中 userAddress 是一个嵌套对象。

了解了基本的理论知识后，我们来尝试下使用 Gson 对 UserNested 对象进行序列化操作。和之前一样，需要调用 Gson 对象的 tojson() 方法，如下：

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);

输出：

{
    "age": 26,
    "email": "norman@futurestud.io",
    "isDeveloper": true,
    "name": "Norman",

    "userAddress": {
        "city": "Magdeburg",
        "country": "Germany",
        "houseNumber": "42A",
        "street": "Main Street"
    }
}

根据结果我们看出 Gson 帮我们生成了我们想要的数据结构，并且也给嵌套的 userAddress 对象也创建了JSON 数据。当然 Gson 也是支持多层对象嵌套。

接下来，我们来看一下如何将复杂的数据类型通过 Gson 反序列化 Java 对象。

反序列化嵌套对象

上一节中，我们根据 JSON 来得到了我们的 Model 类，在平时的开发中，很多中情况是 API 接口返回 JSON 数据，我们解析成相应的对象。

我们将以下的例子反序列化：

{
    "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
    }
}

为了反序列化 JSON 数据，我们先要创建相映匹配的 Java 类。

public class Restaurant {
    String name;

    Owner owner;
    Cook cook;
    Waiter waiter;
}

我们看到 JSON 数据中，cook 和 waiter 嵌套的数据类型是一样的，所以我们可以创建一个通用的类，然后创建不同的对象，如下：

public class Restaurant {
    String name;

    Owner owner;
    Staff cook;
    Staff waiter;
}

虽然可以这么些，但是我们还是建议给每个嵌入类创建一个单独的类，防止以后接口数据更改导致我们客户端又要修改代码，所以我们不使用上面的 Staff 通用类，而是分别单独创建类，如下：

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;
}

我们使用假数据来解析，不过我们希望您了解 JSON 创建 Json Model 的过程，需要一层一层的解析，直到最后。

准备工作已完成，我们可以直接使用 Gson 来解析了，例如：

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);

Debug 如下：