天天看点

Gson - Java-JSON 序列化和反序列化入门

原文链接:Gson - Getting Started with Java-JSON Serialization & Deserialization

原文出自:Norman Peitek

译者:無名無

今天开始学习 Google 的 Gson 库,Gson 是一个非常强大的库,可以将 JSON 格式的数据转化成 Java 对象,也支持将 Java 对象转成 JSON 数据格式。

Gson 依赖

本文将会快速开始使用 Gson 进行序列化操作。由于很多读者都是 Android 开发人员,我们会提供 Java 环境中的 Gson。在开始之前,我们需要引入 Gson 库到自己的项目中,最新的版本是 2.8.0.

使用 Gradle

compile 'com.google.code.gson:gson:2.8.0'
           

使用 Maven

<dependencies>
    <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
      <version>2.8.0</version>
       <scope>compile</scope>
    </dependency>
</dependencies>
           

使用 JAR

下载导入即可,地址: the official GitHub repository

Java-JSON 序列化基础

先来看一些序列化例子,Gson 中的序列化意味着将 Java 对象映射成JSON 数据格式,在接下来的教程中,我们会逐步介绍一些更复杂的情况,首先来看一些简单的例子:

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

UserSimple 对象有四个变量:

  • 字符串类型的 name
  • 字符串类型的 email
  • 整型的 age(例如:26)
  • 布尔类型的 isDeveloper(true or false)

Android 或 Java 应用程序需要将 UserSimple 对象转换为JSON 表示,我们期望是这样的格式:

{
    "name": "Norman",
    "email": "[email protected]",
    "age": 26,
    "isDeveloper": true
}
           

来看下我们是如何用 Gson 转化的,首先要创建一个对象:

UserSimple userObject = new UserSimple(
    "Norman",
    "[email protected]",
    26,
    true
);
           

需要用到 Gson 对象,使用以下构造函数来生成 Gson 对象:

Gson gson = new Gson();
           

使用 Gson 的 torsion() 方法并传入 UserSimple 对象作为参数:

String userJson = gson.toJson(userObject); 
           

输出JSON格式数据

{
    "age": 26,
    "email": "[email protected]",
    "isDeveloper": true,
    "name": "Norman"
}
           

可以看到,Gson 改变了变量的顺序(按字母顺序),但是内容没变。Gson 中字符串被包装成”“,整型没有被包装,我们没有必要弄乱 JSON 对象或者复制单个成员,对于单个对象映射使用 Gson 已经足够了。也能满足一些复杂的数据结构。在深入了解之前,我们先看一下另一个案例,我们是否可以将 JSON 格式映射成 Java 对象?

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

注意第二个参数的传递,否则,Gson 不知道将 JSON 转换成什么类型。

Debug:

Gson - Java-JSON 序列化和反序列化入门

下一步 & 目标

本文介绍了 Gson 的基本用法,展示了序列化和反序列化的基本用法和示例,以下是一些可能的问题:

  • Java model 类是否需要一个构造函数/ getter / setter?
  • Java model 字段是否可以私有的?
  • 如何处理null值?
  • 如果 Java 类和 JSON 数据数量不一致,该怎么办?
  • 如何序列化和反序列化数组和List
  • 如何序列化和反序列化嵌套的对象
  • Gson 在执行.fromJson() 时是否为类属性保留了一个定义的默认值,如果 JSON 中没有该字段的值,将怎么处理?

不用担心,接下来我们会解决这些问题,你可以通过评论或 twitter @futurestud_io 反馈你的问题。

练习代码已上传 Github https://github.com/whiskeyfei/Gson-Review 可自行查看。

Gson 系列文章翻译回顾

1、Gson - Java-JSON 序列化和反序列化入门

2、Gson - 映射嵌套对象

3、Gson - Arrays 和 Lists 映射对象

4、Gson - Map 结构映射

5、Gson - Set 集合映射

6、Gson - 空值映射

7、Gson Model Annotations - 如何使用 @SerializedName 更改字段的命名

8、Gson Model Annotations - @SerializedName 匹配多个反序列化名称

9、Gson Builder - 基础和命名规则

10、Gson Builder - 序列化空值

11、Gson Builder - 忽略策略

12、Gson Builder - Gson Lenient 属性

13、Gson Builder - 特殊类型 Floats & Doubles

17、Gson Builder - 如何使用 @Expose 忽略字段

19、Gson Advanced - 映射枚举类型

20、Gson Advanced - 映射循环引用

21、Gson Advanced - 泛型

22、Gson Advanced - 简单自定义序列化 (Part 1)

24、Gson Advanced - 自定义反序列化基础

25、Gson Advanced - 自定义对象实例创建

26、Gson Advanced - 通过 @JsonAdapter 自定义(反)序列化过程

32、Practical Gson - 如何解析多态对象