天天看點

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 - 如何解析多态對象