如何在 Java 中利用 Properties.store() 为配置文件添加自定义的生成时间戳注释头

小枫同学_9050

小枫同学_9050

2026-05-03

284人浏览

原创

推荐方案是手动写入自定义头后调用 properties.store(writer, null):先用 OutputStreamWriter 指定 UTF-8 编码,写入多行 # 开头的注释(如“生成于:2025-04-01 10:23:45”),再调用 store(writer, null) 跳过默认时间戳,最后 flush 并 close。

java 的 properties.store() 默认会在生成的配置文件顶部写入类似 #mon apr 01 10:23:45 cst 2025 的时间注释,但这个时间是方法内部自动写入的,无法直接自定义格式或内容。若想添加带自定义格式(如“生成于:2025-04-01 10:23:45”)或额外信息(如“由 admin 工具生成”)的注释头,不能仅靠 store(),需绕过其默认行为,手动控制输出。

方案一:用 storeToXML() + 自定义头(不推荐用于 .properties)

storeToXML() 支持传入注释字符串,但它生成的是 XML 格式,不是标准的 .properties 文件,不适用于需要纯 key=value 文本的场景,故此处略过。

方案二:用 store(OutputStream, String) 并预写自定义头(推荐)

Properties.store(OutputStream out, String comments) 会把 comments 参数作为首行注释(自动加 # 并换行),但仅限一行,且仍会追加默认时间戳。要完全替换默认头,必须避免调用该方法,改用 store(Writer, String) 或更底层方式。

正确做法是:不用 store(),而用 store(Writer, null) 配合手动写入自定义头:

  • 创建 FileWriter 或 OutputStreamWriter(注意指定编码,如 UTF-8)
  • 先手动写入你想要的注释头(可多行,每行以 # 开头)
  • 再调用 properties.store(writer, null),传 null 可跳过它自带的注释和时间行
  • 确保最后调用 writer.flush() 和 close()

示例代码:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
Properties props = new Properties();
props.setProperty("db.url", "jdbc:h2:mem:test");
props.setProperty("db.user", "sa");
<p>try (Writer writer = new OutputStreamWriter(
new FileOutputStream("config.properties"), StandardCharsets.UTF_8)) {</p><pre class="brush:java;toolbar:false;">// 手动写入自定义头(支持多行)
String timestamp = LocalDateTime.now()
        .format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
writer.write("# 配置文件自动生成\n");
writer.write("# 生成于:" + timestamp + "\n");
writer.write("# 版本:v1.2.0\n");
writer.write("#\n"); // 空行分隔

// 调用 store,第二个参数为 null,跳过默认注释
props.store(writer, null);

}

方案三:重写 store() 行为(高级,适用于封装工具类)

如果项目中频繁使用,可封装一个 CustomProperties 工具方法,内部继承 Properties 或独立实现写入逻辑,核心仍是手动控制 Writer 输出。关键点包括:

  • 将 Properties 中的键值对转为 String 列表,按规范转义(如空格、等号、井号需 \ 转义)
  • 使用 StringEscapeUtils.escapeJava()(Apache Commons)或手写简单转义逻辑
  • 按字母序或原始插入序排序后逐行写入,保证可读性
  • 把自定义头作为前置内容统一写入

这种方式灵活度最高,但开发成本略高,一般小项目用方案二足够。

注意事项与避坑点

直接操作 Writer 时容易忽略以下细节:

  • 编码必须显式指定:否则 Windows 上可能用 GBK 写入中文注释,导致 Linux 下乱码
  • 注释行末不能有空格:某些老旧解析器(如 Shell 脚本读取)会因末尾空格误判为无效行
  • store(writer, null) 仍会写入空行:它在注释后总加一个空行,所以你的自定义头末尾最好也留一空行,保持视觉一致
  • 不要用 FileWriter("xxx") 默认构造:它不指定编码,JDK 依赖平台默认编码,极不安全

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

相关专题

更多
java
java

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

2023.06.15

12257

6

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

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

2023.07.05

9342

9

java自学难吗
java自学难吗

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

2023.07.31

7972

8

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

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

2023.08.01

1284

3

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

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

2023.08.02

1028

3

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

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

2023.08.02

1536

5

java有什么用
java有什么用

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

2023.08.02

3209

5

java在线网站
java在线网站

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

2023.08.03

20451

3

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

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

2023.08.03

1395

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习