如何正确使用 Java 将对象写入现有 JSON 文件

梦丽君_5365

梦丽君_5365

2026-04-07

752人浏览

原创

本文详解 Java 中向已有 JSON 文件写入数据时 BufferedWriter 写入失败(内容为空)的常见原因及解决方案,重点说明 write(String) 与 write(String, int, int) 的行为差异、字符编码一致性、资源安全关闭等关键实践。

本文详解 java 中向已有 json 文件写入数据时 `bufferedwriter` 写入失败(内容为空)的常见原因及解决方案,重点说明 `write(string)` 与 `write(string, int, int)` 的行为差异、字符编码一致性、资源安全关闭等关键实践。

在 Java 中将对象序列化为 JSON 并写入文件时,看似简单的代码却常因细微疏漏导致文件内容为空(即“写入成功但文件无数据”)。你提供的两段代码——基于 BufferedWriter 和 Files.write()——均可能失效,根本原因并非逻辑错误,而是对 I/O 行为和编码细节的忽视。

? 根本问题分析

  1. BufferedWriter.write(String) 方法本身不会抛出异常,但若传入 null 字符串,会静默跳过写入
    你的日志中提到 “write buffer is null during the whole process”,极大概率是 gson.toJson(documentToSave) 返回了 null(例如 documentToSave 为 null,或 Gson 配置禁用了 null 字段但未设默认值)。此时 writer.write(null) 不报错,但也不写入任何字符。

  2. FileWriter 默认使用平台默认编码(如 Windows 上为 GBK),而 Gson 输出 UTF-8 字符串,混合使用易致乱码或截断
    即使内容非空,编码不一致也可能使文件在文本编辑器中显示为空白或乱码。

  3. 资源未正确关闭或异常吞没
    手动调用 flush() + close() 易遗漏;若中间发生异常(如磁盘满、权限不足),close() 可能未执行,缓冲区数据丢失。

✅ 推荐解决方案(安全、健壮、可调试)

String path = resourceHelper.getFilePath(DOCUMENT_PATH2);
Gson gson = new GsonBuilder().setPrettyPrinting().create();

// 1. 显式序列化并校验非空
String json = gson.toJson(documentToSave);
if (json == null) {
    throw new IllegalArgumentException("Failed to serialize document: input object is null or invalid");
}
System.out.println("Serialized JSON length: " + json.length()); // 调试用:确认有内容

// 2. 使用 UTF-8 编码的 FileWriter(Java 11+ 推荐 Files.write)
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path), StandardCharsets.UTF_8)) {
    writer.write(json);
    writer.flush(); // flush() 在 try-with-resources 中非必需,但显式调用更清晰
} catch (IOException e) {
    throw new RuntimeException("Failed to write JSON to file: " + path, e);
}

✅ 优势说明:

  • 使用 Files.newBufferedWriter(..., UTF_8) 显式指定编码,避免平台差异;
  • try-with-resources 自动确保 close() 被调用,即使发生异常;
  • 提前校验 json != null,快速定位序列化失败根源;
  • System.out.println 辅助调试长度,比仅打印字符串更可靠(避免控制字符干扰)。

⚠️ 注意事项与最佳实践

  • 永远不要依赖 FileWriter 默认编码:务必显式传入 StandardCharsets.UTF_8;
  • 避免手动 flush() + close() 组合:优先使用 try-with-resources;
  • Gson 序列化前检查输入对象:documentToSave 是否为 null?其字段是否被 @Expose 或 @SerializedName 正确标注?
  • 验证文件路径有效性:resourceHelper.getFilePath(...) 返回的路径是否存在父目录?若目录不存在,FileWriter 会抛出 FileNotFoundException(但你的场景未触发,说明路径合法);
  • 生产环境建议添加日志框架替代 System.out:如 SLF4J + Logback,便于分级与追踪。

? 快速验证技巧

运行以下最小复现代码,确认基础流程是否正常:

Path testPath = Paths.get("test-output.json");
Gson gson = new GsonBuilder().setPrettyPrinting().create();
String testJson = gson.toJson(Map.of("hello", "world"));
Files.writeString(testPath, testJson, StandardCharsets.UTF_8); // Java 11+
System.out.println("Written: " + Files.readString(testPath, StandardCharsets.UTF_8));

如该代码成功,说明环境无问题,问题必在原始 documentToSave 或路径逻辑中。

遵循以上方案,即可彻底解决 JSON 写入为空、无声失败的问题,让文件持久化真正可靠、可维护。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11397

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8502

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7312

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1224

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

988

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1456

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2989

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20251

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1315

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习