跳過到頁腳內容
  1. IronPDF for Java
  2. IronPDF for Java 部落格
  3. Java 說明
  4. Gson Java
JAVA 幫助

Gson for Java：將對象轉換為 JSON

Darrius Serrant
Darrius Serrant
更新:

在 Java 程式設計領域，資料序列化和反序列化是應用程式之間傳輸資料不可或缺的過程。 Gson 是 Google 開發的一個函式庫，它是一款功能強大的工具，可以將 Java 物件轉換為 JSON 表示形式，反之亦然。

本文旨在提供一份全面的 Java 版 Gson 指南，探討其特性、實作和最佳實務。

Gson是什麼？

Gson 是 Google 開發的 Java 函式庫，可用於將 Java 物件轉換為其 JSON 表示形式。 它還可以將整個 JSON 檔案或字串轉換為等效的 Java 物件。 Google Gson 提供簡單易用的 API，讓開發人員輕鬆處理 JSON 資料。

Gson Java（開發者使用指南）：圖 1

Gson的主要特點

1.簡單的 API： Gson 提供了一個簡單的 API，用於將 Java 對象轉換為 JSON 以及將 JSON 轉換為 Java 對象，使其易於整合到 Java 應用程式中。 2.靈活的序列化： Gson 提供序列化自訂選項，允許開發人員排除特定欄位或自訂輸出格式。 3.反序列化支援： Gson 可以將 JSON 字串反序列化為 Java 對象，簡化解析 JSON 資料的過程。 4.類型安全： Gson 確保序列化和反序列化過程中的類型安全，從而降低運行時錯誤的風險。 5.與 Java 集合集成： Gson 與 Java 集合無縫集成，能夠序列化和反序列化複雜的資料結構。

Gson入門指南

要在 Java 專案中使用 Google Gson 庫，首先需要將 Gson 庫新增至專案的依賴項。 如果您使用的是 Maven，則可以將下列依賴項新增至您的pom.xml檔案：

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.11.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.11.0</version>
</dependency>
XML

新增相依性後，即可在 Java 程式碼中使用 Gson。

基本用法

以下是一個使用 Gson 進行序列化和反序列化的基本範例：

import com.google.gson.Gson;

public class GsonExample {
    public static void main(String[] args) {
        // Initialize Gson object for JSON operations
        Gson gson = new Gson();

        // Create a new MyObject instance and serialize it to JSON
        String json = gson.toJson(new MyObject());
        System.out.println("Serialized JSON: " + json);

        // Deserialize the JSON back into a MyObject instance
        MyObject obj = gson.fromJson(json, MyObject.class);
        System.out.println("Deserialized Object: Name - " + obj.name + ", Version - " + obj.version);
    }

    // Define a simple Java class to be serialized/deserialized
    static class MyObject {
        private String name = "Gson"; // Default object name
        private int version = 2; // Default object version
    }
}
import com.google.gson.Gson;

public class GsonExample {
    public static void main(String[] args) {
        // Initialize Gson object for JSON operations
        Gson gson = new Gson();

        // Create a new MyObject instance and serialize it to JSON
        String json = gson.toJson(new MyObject());
        System.out.println("Serialized JSON: " + json);

        // Deserialize the JSON back into a MyObject instance
        MyObject obj = gson.fromJson(json, MyObject.class);
        System.out.println("Deserialized Object: Name - " + obj.name + ", Version - " + obj.version);
    }

    // Define a simple Java class to be serialized/deserialized
    static class MyObject {
        private String name = "Gson"; // Default object name
        private int version = 2; // Default object version
    }
}
JAVA

在這個例子中，我們建立了一個Gson對象，並使用它來將MyObject實例序列化為 JSON 字串（ toJson方法）。 然後，我們將 JSON 字串反序列化，並將其轉換回MyObject實例（ fromJson方法）。

進階用法

Gson 提供進階功能，可自訂序列化和反序列化，將任意 Java 物件轉換為其 JSON 表示形式。 這些功能包括

*自訂序列化和反序列化：* Gson 可讓您為特定類型或欄位定義自訂序列化器和反序列化器。 排除字段：**您可以使用@Expose註解字段，以控制是否應將它們包含在 JSON 輸出中。 *處理空值： Gson 提供了在序列化和反序列化期間處理空值的選項。

程式碼範例

下面這個範例示範了 Gson 的高階用法。 在下面的範例中，我們將利用 Java 類別來示範 Gson 的功能，將 Java 物件轉換為其 JSON 表示形式，並將 JSON 資料解析回等效的 Java 物件。

import com.google.gson.Gson;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

public class AdvancedGsonExample {
    public static void main(String[] args) {
        // Define a custom Java class
        class CustomObject {
            @SerializedName("full_name")
            private String name;
            private int age;
            // The 'ignoredAge' field is excluded from JSON serialization
            @Expose(serialize = false)
            private int ignoredAge;

            public CustomObject(String name, int age) {
                this.name = name;
                this.age = age;
                this.ignoredAge = age; // Excluded from JSON output
            }
        }

        // Create an instance of the custom Java class
        CustomObject customObject = new CustomObject("John Doe", 30);

        // Serialize the Java object to its JSON representation
        Gson gson = new Gson();
        String json = gson.toJson(customObject);
        System.out.println("JSON Representation:");
        System.out.println(json);

        // Parse the JSON back to an equivalent Java object
        CustomObject parsedObject = gson.fromJson(json, CustomObject.class);
        System.out.println("\nEquivalent Java Object:");
        System.out.println("Name: " + parsedObject.name);
        System.out.println("Age: " + parsedObject.age);
        // Ignored age field won't be included in JSON output
        System.out.println("Ignored Age: " + parsedObject.ignoredAge);
    }
}
import com.google.gson.Gson;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

public class AdvancedGsonExample {
    public static void main(String[] args) {
        // Define a custom Java class
        class CustomObject {
            @SerializedName("full_name")
            private String name;
            private int age;
            // The 'ignoredAge' field is excluded from JSON serialization
            @Expose(serialize = false)
            private int ignoredAge;

            public CustomObject(String name, int age) {
                this.name = name;
                this.age = age;
                this.ignoredAge = age; // Excluded from JSON output
            }
        }

        // Create an instance of the custom Java class
        CustomObject customObject = new CustomObject("John Doe", 30);

        // Serialize the Java object to its JSON representation
        Gson gson = new Gson();
        String json = gson.toJson(customObject);
        System.out.println("JSON Representation:");
        System.out.println(json);

        // Parse the JSON back to an equivalent Java object
        CustomObject parsedObject = gson.fromJson(json, CustomObject.class);
        System.out.println("\nEquivalent Java Object:");
        System.out.println("Name: " + parsedObject.name);
        System.out.println("Age: " + parsedObject.age);
        // Ignored age field won't be included in JSON output
        System.out.println("Ignored Age: " + parsedObject.ignoredAge);
    }
}
JAVA

最佳實務

在 Java 專案中使用 Gson 時，請考慮以下最佳實務：

1.使用 Gson Builder：不要直接建立Gson實例，而是使用 Gson 的建構器模式 ( GsonBuilder ) 來自訂 Gson 的行為。 2.處理異常：始終處理序列化或反序列化過程中可能發生的異常，以確保強大的錯誤處理能力。 3.版本相容性：升級 Gson 依賴項時，請注意 Gson 版本相容性，以避免破壞性變更。

利用 Gson 輸出，使用 Java 中的 IronPDF 產生 PDF 文件

在 Java 生態系統中，Gson 可以幫助將 Java 物件轉換為 JSON 文件，反之亦然。 透過將 Gson 與 IronPDF 集成，我們可以利用 JSON 資料動態產生 PDF 文件。 Gson 允許我們將 Java 物件序列化為 JSON 字串，然後可以使用這些字串作為 IronPDF 產生 PDF 的輸入資料。

推出適用於 Java 的 IronPDF

IronPDF 由 Iron Software 開發，是一個功能豐富的庫，用於在 Java 中建立、編輯和操作 PDF 文件。 它提供了一套全面的 API，用於渲染 HTML、將 URL 轉換為 PDF 以及從 HTML 內容生成 PDF。

Gson Java（開發者使用指南）：圖 2

開始

要開始使用 Gson 和 IronPDF，只需將它們各自的依賴項新增至您的 Java 專案即可。 在pom.xml檔中加入以下依賴項：

<dependencies>
    <!-- Gson -->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.11.0</version>
    </dependency>
    <!-- IronPDF for Java -->
    <dependency>
        <groupId>com.ironsoftware</groupId>
        <artifactId>ironpdf</artifactId>
        <version>2024.3.1</version>
    </dependency>
    <!-- SLF4J Logger for IronPDF -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-simple</artifactId>
        <version>2.0.3</version>
    </dependency>
</dependencies>
<dependencies>
    <!-- Gson -->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.11.0</version>
    </dependency>
    <!-- IronPDF for Java -->
    <dependency>
        <groupId>com.ironsoftware</groupId>
        <artifactId>ironpdf</artifactId>
        <version>2024.3.1</version>
    </dependency>
    <!-- SLF4J Logger for IronPDF -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-simple</artifactId>
        <version>2.0.3</version>
    </dependency>
</dependencies>
XML

整合步驟

以下是將 Java 物件轉換為 JSON 對象，然後再將 JSON 物件轉換為 PDF 的兩步驟流程的原始程式碼：

1.使用 Gson 序列化資料：首先使用 Gson 將 Java 物件序列化為 JSON 格式。 此JSON資料將作為PDF文件的內容。 確保 Gson 輸出結果與您希望包含在 PDF 中的結構和內容一致。

```java
Gson gson = new Gson(); // Gson instance
MyDataObject data = ...; // Your data object
String jsonData = gson.toJson(data);
```

2.使用 IronPDF 產生 PDF：準備好 Gson 輸出後，利用 IronPDF 產生 PDF 文件。 您可以從 IronPDF 提供的各種方法中進行選擇，例如渲染 HTML、轉換 URL 或直接輸入 HTML 內容。

```java
// Using Gson output as HTML content
PdfDocument pdfFromJson = PdfDocument.renderHtmlAsPdf(jsonData);
pdfFromJson.saveAs(Paths.get("output.pdf"));
```

或者，您可以使用 Gson 輸出動態填入 HTML 模板，然後使用 IronPDF 將其渲染為 PDF。

範例集成

舉個例子，我們有一個簡單的 Java 對象，表示員工數據，我們使用 Gson 進行序列化。 然後我們使用 Gson 輸出動態填入 HTML 模板，隨後使用 IronPDF 將其渲染為 PDF。

// Serialize employee data using Gson
Gson gson = new Gson();
// Create an EmployeeData class with name, position, and salary
EmployeeData employee = new EmployeeData("John Doe", "Software Engineer", 50000);
String jsonData = gson.toJson(employee);

// Populate HTML template with Gson output
String htmlContent = "<html><body><h1>Employee JSON Data</h1><pre>" + jsonData + "</pre></body></html>";

// Generate PDF using IronPDF
PdfDocument pdfFromHtml = PdfDocument.renderHtmlAsPdf(htmlContent);
pdfFromHtml.saveAs(Paths.get("employee_details.pdf"));
// Serialize employee data using Gson
Gson gson = new Gson();
// Create an EmployeeData class with name, position, and salary
EmployeeData employee = new EmployeeData("John Doe", "Software Engineer", 50000);
String jsonData = gson.toJson(employee);

// Populate HTML template with Gson output
String htmlContent = "<html><body><h1>Employee JSON Data</h1><pre>" + jsonData + "</pre></body></html>";

// Generate PDF using IronPDF
PdfDocument pdfFromHtml = PdfDocument.renderHtmlAsPdf(htmlContent);
pdfFromHtml.saveAs(Paths.get("employee_details.pdf"));
JAVA

輸出

Gson Java（開發者使用指南）：圖 3

探索 IronPDF 的文件和程式碼範例頁面，這些頁面是開發人員的寶貴資源，提供了大量可直接使用的程式碼片段和全面的文檔，以加快與 PDF 相關的開發任務。

結論

Gson 是一個功能強大且用途廣泛的 Java JSON 序列化和反序列化函式庫。 它簡潔的 API、靈活性和高級功能使其成為 Java 開發人員的熱門選擇。 透過了解 Gson 的特性、實作方式和最佳實踐，您可以利用其功能在 Java 專案中有效地處理 JSON 資料。

在 Java 中將 Gson 與 IronPDF 集成，為從 JSON 資料動態生成 PDF 文件開闢了無數可能性。 透過利用 Gson 強大的序列化功能和 IronPDF 強大的 PDF 生成功能，開發人員可以建立無縫的工作流程，以產生符合其應用程式要求的 PDF。

使用 IronPDF 的免費試用版，體驗強大的 PDF 生成功能。 將 Gson 輸出無縫整合到專為您的 Java 應用程式客製化的動態 PDF 中。 立即下載，體驗 IronPDF 的便利高效能！

Darrius Serrant
Darrius Serrant
  立即與工程團隊聊天
全棧軟件工程師 (WebOps)

Darrius Serrant 擁有邁阿密大學計算機科學學士學位，目前任職於 Iron Software 的全栈 WebOps 市場營銷工程師。從小就迷上編碼，他認為計算既神秘又可接近，是創意和解決問題的完美媒介。

在 Iron Software，Darrius 喜歡創造新事物，並簡化複雜概念以便於理解。作為我們的駐場開發者之一，他也自願教學生，分享他的專業知識給下一代。

對 Darrius 來說，工作令人滿意因為它被重視且有實際影響。

相關文章

30 天試用 → 完整產品。無限制。無卡。 開始免費試用