使用Java預編譯語句將JSON對象插入PostgreSQL

1. 引言

在現代軟件開發中，由於 JSON 數據的輕量級和多功能性，處理 JSON 數據已經變得非常普遍。PostgreSQL 憑藉其強大的 JSON 支持，為存儲和查詢 JSON 數據提供了一個極佳的平台。Java 作為一種流行的編程語言，經常使用 JDBC 與數據庫進行交互。本文演示瞭如何使用 Java 的 PreparedStatement 將 JSON 對象插入到 PostgreSQL 數據庫中的方法。

2. 依賴項

在深入代碼之前，我們需要設置好我們的環境。除了安裝和運行 PostgreSQL 之外，還需要將 PostgreSQL JDBC 驅動程序和 org.json 庫包含在項目的依賴項中。

2.1. 安裝和運行 PostgreSQL

如果 PostgreSQL 未安裝，可以從官方 PostgreSQL 網站下載並安裝。考慮到 PostgreSQL 長期以來就支持 JSON，我們可以選擇從 PostgreSQL 9 開始的任何版本。對於本文，我們將使用最新且穩定的版本，即 PostgreSQL 16。我們需要確保 PostgreSQL 運行正常，並且可以使用必要的憑據訪問。

2.2. 添加 PostgreSQL JDBC 驅動程序

將 PostgreSQL JDBC 驅動程序添加到我們的項目依賴項中。對於 Maven 項目，需要在 <pom.xml> 文件中指定依賴項：

依賴項

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.7.3</version>
</dependency>

2.3. 包含 JSON 庫依賴

為了在我們的 Java 代碼中處理 JSON 數據，我們需要將 JSON 庫作為依賴項包含進來。 Java 中有許多流行的 JSON 庫可供選擇，例如 Jackson、Gson 和 org.json。對於本文，我們將使用 org.json 庫，它提供了一個簡單輕量級的 JSON 處理解決方案。要在我們的項目中使用 org.json 庫，可以在 Maven 項目的 pom.xml 文件中添加以下依賴：

<dependency>
    <groupId>org.json</groupId>
    <artifactId>json</artifactId>
    <version>20240303</version>
</dependency>

現在我們已經配置好必要的依賴項，接下來我們將進入下一部分內容，學習如何創建表格以及編寫用於插入 JSON 數據的 Java 代碼。

3. JSONB 與 JSON 類型

PostgreSQL 提供兩種主要類型用於存儲 JSON 數據：JSONB 和 JSON。儘管這兩種類型都用於存儲和操作 JSON 數據，但它們之間存在一些差異。

JSONB 類型提供高效的二進制存儲和索引功能，從而實現更快的查詢執行。它在插入時執行 JSON 數據的驗證和轉換，並保留 JSON 對象內部鍵的順序。 PostgreSQL 可以自動將其他數據類型的的值轉換為 JSON。

另一方面，JSON 類型將 JSON 數據存儲為純文本，不進行二進制表示或專門索引。它在插入時執行驗證，但缺乏 JSONB 的優化和鍵順序保留功能。使用 JSONB 類型時，需要顯式轉換或將值轉換為 JSON。

在本文中，我們將使用 JSONB 類型來存儲和查詢 PostgreSQL 中的 JSON 數據。

4. 創建包含 JSON 列的 PostgreSQL 表

首先，我們需要創建一個包含 JSON 列的 PostgreSQL 表。連接到我們之前設置好的 PostgreSQL 實例，並運行以下 SQL 命令：

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    info JSONB
);

這張表有三列：id、name 和 info。 info 列的數據類型為 JSONB，它以二進制格式存儲 JSON 數據，提供高效的存儲和查詢能力。

5. 使用 Java 代碼插入 JSON 數據

現在，讓我們轉向 Java 部分。我們將編寫一個 Java 程序，使用 PreparedStatement 將 JSON 數據插入到 users 表中。

5.1. 建立數據庫連接

首先，我們需要建立一個 JDBC 連接到 PostgreSQL 數據庫。以下是一個獲取數據庫連接的方法：

public class InsertJsonData {
    private static final String URL = "jdbc:postgresql://localhost:5432/database_name";
    private static final String USER = "username";
    private static final String PASSWORD = "password";

    public Connection getConnection() throws SQLException {
        return DriverManager.getConnection(URL, USER, PASSWORD);
    }
}

請注意，database_name、username和password需要替換為實際的PostgreSQL數據庫名稱、用户名和密碼。

5.2. 插入 JSON 數據

接下來，我們需要編寫一個方法將 JSON 對象插入到 users 表中：

public class InsertJsonData {
    public static void insertUser(String name, JSONObject info) {
        String sql = "INSERT INTO users (name, info) VALUES (?, ?::jsonb)";

        Connection conn = DatabaseConnection.getConnection();
        PreparedStatement pstmt = conn.prepareStatement(sql);

        pstmt.setString(1, name);
        pstmt.setString(2, info.toString());
        pstmt.executeUpdate();

        System.out.println("Data inserted successfully.");
    }

    public static void main(String[] args) {
        JSONObject jsonInfo = new JSONObject();
        jsonInfo.put("email", "[email protected]");
        jsonInfo.put("age", 30);
        jsonInfo.put("active", true);

        insertUser("John Doe", jsonInfo);
    }
}

5.3. 代碼分解

讓我們分解代碼並探索其組成部分：

數據庫連接：getConnection() 方法建立與 PostgreSQL 數據庫的連接。
SQL 查詢：INSERT INTO users (name, info) VALUES (?, ?::jsonb) 查詢將記錄插入到 users 表中。?::jsonb 語法是 PostgreSQL 專有語法，用於類型轉換。雙冒號操作符 :: 是 PostgreSQL 中 CAST 關鍵字的同義詞，表示類型轉換操作。通過使用 ?::jsonb，我們指示 PostgreSQL 將第二個參數（即 JSON 字符串）轉換為 jsonb 數據類型，然後再將其插入到 info 列中。這允許在 PostgreSQL 中正確處理和存儲 JSON 數據。
預準備語句：PreparedStatement 設置參數並執行 SQL 查詢。pstmt.setString(1, name) 設置 name，pstmt.setString(2, info.toString()) 設置 JSON 數據。
JSON 處理：JSONObject 類來自 org.json 庫，用於創建和處理 JSON 數據。

6. 結論

使用 Java 的 <em >PreparedStatement</em> 將 JSON 對象插入 PostgreSQL 既簡單又高效。這種方法利用了 PostgreSQL 的強大 JSON 功能以及 Java 的健壯 JDBC API。按照本文中概述的步驟，我們可以無縫地將 JSON 數據存儲在我們的 PostgreSQL 數據庫中，並充分利用其豐富的查詢功能。

在某些情況下，如果更喜歡使用 Java 持久性 API (JPA) 進行數據庫操作，則可以考慮使用 Spring Boot 和 JPA 將 PostgreSQL JSONB 數據存儲起來。這種方法提供了一種方便的方式來將 JSON 數據插入 PostgreSQL 數據庫。

知識庫 / Persistence RSS 訂閱