在Java中使用Gson向JSON文件追加新对象而非覆盖的教程-java教程-PHP中文网

在Java中使用Gson向JSON文件追加新对象而非覆盖的教程

聖光之護

发布： 2025-11-21 14:37:01

原创

927人浏览过

在java中使用gson向json文件追加新对象而非覆盖的教程

本教程旨在解决Java中向JSON文件追加新对象时，文件内容被覆盖的问题。我们将详细介绍如何利用GSON库实现“读取-解析-修改-写入”的流程，确保在不丢失现有数据的前提下，将新的JSON对象安全地添加到文件中，并提供将单个根对象转换为JSON数组以支持追加操作的策略。

引言：理解JSON文件追加的挑战

在Java应用程序中处理JSON数据时，一个常见的需求是将新的JSON对象添加到现有的JSON文件中，而不是完全覆盖其内容。例如，在一个员工管理系统中，每次添加新员工时，我们希望将新员工的JSON数据追加到 EmployeeData.json 文件中，而不是每次都创建一个只包含最新员工信息的新文件。

原始代码中，通常会直接将新的JSON字符串写入文件：

// 简化示例，与问题中的GSONFileWriter类似
public void writeJsonToFile(String jsonContent, String filePath) {
    try (PrintWriter writer = new PrintWriter(filePath, StandardCharsets.UTF_8)) {
        writer.write(jsonContent); // 此操作会覆盖文件原有内容
    } catch (IOException e) {
        e.printStackTrace();
    }
}

登录后复制

这种方法的问题在于，PrintWriter 或 FileWriter 在默认情况下会覆盖目标文件的所有内容。为了实现追加操作，我们需要采取一种“读取-解析-修改-写入”的策略。

立即学习“Java免费学习笔记（深入）”；

核心策略：读取、解析、修改与写入

要向JSON文件追加数据，我们需要遵循以下步骤：

读取现有JSON文件内容： 将整个JSON文件作为字符串读取到内存中。
解析JSON字符串： 使用GSON库将读取到的JSON字符串解析成可操作的JSON结构（如 JsonElement, JsonObject 或 JsonArray）。
修改JSON结构： 将新的JSON对象添加到现有的JSON结构中。这一步至关重要，特别是当文件最初只包含一个JSON对象时，为了支持追加，需要将其转换为一个JSON数组。
写入修改后的JSON结构： 将更新后的JSON结构序列化回JSON字符串，并将其写回文件。

详细步骤与示例代码

我们将创建一个实用方法 appendObjectToJsonFile，它负责处理上述所有逻辑。

落笔AI

AI写作，AI写网文、AI写长篇小说、短篇小说

查看详情

1. 准备工作：引入GSON库和定义数据模型

首先，确保你的项目中已引入GSON库。如果你使用Maven，可以在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10.1</version> <!-- 使用最新版本 -->
</dependency>

登录后复制

接下来，定义一个用于存储员工信息的数据模型（POJO）：

import java.util.UUID;

// Employee.java
class Employee {
    String id;
    String name;
    int age;
    double salary;

    public Employee(String name, int age, double salary) {
        this.id = UUID.randomUUID().toString(); // 自动生成ID
        this.name = name;
        this.age = age;
        this.salary = salary;
    }

    // 默认构造函数或从JSON反序列化时可能需要
    public Employee() {}

    // Getter和Setter（可选，但通常推荐）
    public String getId() { return id; }
    public void setId(String id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public int getAge() { return age; }
    public void setAge(int age) { this.age = age; }
    public double getSalary() { return salary; }
    public void setSalary(double salary) { this.salary = salary; }

    @Override
    public String toString() {
        return "Employee{" +
               "id='" + id + '\'' +
               ", name='" + name + '\'' +
               ", age=" + age +
               ", salary=" + salary +
               '}';
    }
}

登录后复制

2. 实现 appendObjectToJsonFile 方法

这个方法将处理文件读取、JSON解析、结构修改和最终写入。

import com.google.gson.*;
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;

public class JsonFileAppender {

    // 使用GsonBuilder创建带美化打印的Gson实例，方便阅读
    private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create();

    /**
     * 向指定的JSON文件追加一个新的对象。
     * 如果文件不存在、为空或内容为单个JSON对象，则将其转换为JSON数组并追加。
     * 如果文件已是JSON数组，则直接追加新对象。
     *
     * @param filePath 要追加的JSON文件路径
     * @param newObject 要追加的新Java对象
     * @throws IOException 如果发生文件读写错误
     * @throws JsonSyntaxException 如果文件内容不是有效的JSON
     */
    public static void appendObjectToJsonFile(String filePath, Object newObject) throws IOException {
        File jsonFile = new File(filePath);
        JsonArray jsonArray; // 最终要写入的JSON数组

        // 检查文件是否存在或是否为空
        if (!jsonFile.exists() || jsonFile.length() == 0) {
            // 文件不存在或为空，初始化一个新的JSON数组
            jsonArray = new JsonArray();
        } else {
            // 文件存在且有内容，读取并解析
            String fileContent = new String(Files.readAllBytes(Paths.get(filePath)), StandardCharsets.UTF_8);
            try {
                JsonElement rootElement = JsonParser.parseString(fileContent);

                if (rootElement.isJsonArray()) {
                    // 如果根元素已经是JSON数组，直接获取
                    jsonArray = rootElement.getAsJsonArray();
                } else if (rootElement.isJsonObject()) {
                    // 如果根元素是单个JSON对象，将其包装到一个新的JSON数组中
                    jsonArray = new JsonArray();
                    jsonArray.add(rootElement.getAsJsonObject());
                    System.out.println("检测到文件为单个JSON对象，已将其转换为JSON数组以支持追加。");
                } else {
                    // 处理其他非数组非对象的JSON类型（如原始值、null）
                    // 在这种情况下，我们选择创建一个新的数组并覆盖旧内容，或者抛出异常
                    System.err.println("警告: 现有JSON文件根元素既非数组也非对象。将创建新的JSON数组并覆盖。");
                    jsonArray = new JsonArray();
                }
            } catch (JsonSyntaxException e) {
                // 文件内容不是有效的JSON，视为需要重新开始，创建一个新的JSON数组
                System.err.println("警告: 现有文件内容不是有效的JSON。将创建新的JSON数组并覆盖。错误信息: " + e.getMessage());
                jsonArray = new JsonArray();
            }
        }

        // 将新的Java对象转换为JsonElement并添加到JSON数组中
        jsonArray.add(GSON.toJsonTree(newObject));

        // 将更新后的JSON数组写回文件
        try (Writer writer = new FileWriter(filePath, StandardCharsets.UTF_8)) {
            GSON.toJson(jsonArray, writer);
        }
        System.out.println("对象已成功追加到文件: " + filePath);
    }

    // 主方法用于演示
    public static void main(String[] args) {
        String fileName = "EmployeeData.json";

        // 清理旧文件，确保每次运行都是新开始（可选）
        new File(fileName).delete();
        System.out.println("已删除旧文件：" + fileName + " (如果存在)。");

        // 第一次追加：文件不存在，将创建包含一个对象的数组
        System.out.println("\n--- 第一次追加 ---");
        try {
            Employee emp1 = new Employee("Alice", 30, 60000.0);
            appendObjectToJsonFile(fileName, emp1);
            System.out.println("文件内容:\n" + new String(Files.readAllBytes(Paths.get(fileName)), StandardCharsets.UTF_8));
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 第二次追加：文件已是数组，直接追加
        System.out.println("\n--- 第二次追加 ---");
        try {
            Employee emp2 = new Employee("Bob", 25, 55000.0);
            appendObjectToJsonFile(fileName, emp2);
            System.out.println("文件内容:\n" + new String(Files.readAllBytes(Paths.get(fileName)), StandardCharsets.UTF_8));
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 第三次追加：文件仍是数组，继续追加
        System.out.println("\n--- 第三次追加 ---");
        try {
            Employee emp3 = new Employee("Charlie", 35, 70000.0);
            appendObjectToJsonFile(fileName, emp3);
            System.out.println("文件内容:\n" + new String(Files.readAllBytes(Paths.get(fileName)), StandardCharsets.UTF_8));
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 演示如何读取所有员工
        System.out.println("\n--- 从文件中读取所有员工 ---");
        try {
            String fileContent = new String(Files.readAllBytes(Paths.get(fileName)), StandardCharsets.UTF_8);
            JsonElement rootElement = JsonParser.parseString(fileContent);
            if (rootElement.isJsonArray()) {
                JsonArray employeesArray = rootElement.getAsJsonArray();
                for (JsonElement element : employeesArray) {
                    Employee employee = GSON.fromJson(element, Employee.class);
                    System.out.println("读取到员工: " + employee);
                }
            } else {
                System.out.println("文件根元素不是JSON数组，无法按列表读取。");
            }
        } catch (IOException | JsonSyntaxException e) {
            e.printStackTrace();
        }
    }
}

登录后复制

代码执行结果示例

首次运行 main 方法后，EmployeeData.json 文件内容将类似如下：

[
  {
    "id": "d40507a7-a802-4494-9a0c-5a97a0a4d0bf",
    "name": "Alice",
    "age": 30,
    "salary": 60000.0
  },
  {
    "id": "e6f7g8h9-i0j1-k2l3-m4n5-o6p7q8r9s0t1",
    "name": "Bob",
    "age": 25,
    "salary": 55000.0
  },
  {
    "id": "f1g2h3i4-j5k6-l7m8-n9o0-p1q2r3s4t5u6",
    "name": "Charlie",
    "age": 35,
    "salary": 70000.0
  }
]

登录后复制

可以看到，每次追加操作都成功地将新员工对象添加到了JSON数组中，而不是覆盖整个文件。

以上就是在Java中使用Gson向JSON文件追加新对象而非覆盖的教程的详细内容，更多请关注php中文网其它相关文章！