Spring独立应用写入application.properties时的转义与空行保留问题

我之前也碰到过这个问题，Java原生的Properties类确实有这些痛点——它加载时会忽略原文件的空行和注释，存储时还会自动转义特殊字符，完全没考虑人工编辑的需求。咱们一步步来解决这两个问题：

问题根源 #

1. 空行丢失：Properties类在加载文件时，只会解析键值对，空行、注释（除了存储时指定的头部注释）都会被丢弃，存储时自然也不会还原这些内容。
2. 自动转义：Properties.store()（包括DefaultPropertiesPersister的实现）会自动转义特殊字符（比如#、!、=、:以及反斜杠\），这是为了符合properties文件的语法规范，但会导致人工编辑时可读性极差，甚至像路径C:\Temp\Backup被转义成C\:TempBackup这种错误。

解决方案 #

原生Properties类没法满足需求，咱们有两种靠谱的解决方式：

方案一：使用Apache Commons Configuration库（推荐） #

这个库专门解决原生Properties的痛点，支持保留原文件的空行、注释，还能控制是否转义特殊字符。

首先添加Maven依赖：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-configuration2</artifactId>
    <version>2.8.0</version>
</dependency>

然后修改你的方法：

import org.apache.commons.configuration2.PropertiesConfiguration;
import org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder;
import org.apache.commons.configuration2.builder.fluent.Parameters;
import org.apache.commons.configuration2.ex.ConfigurationException;

public static void addUpdateAppSettings(String key, String value) {
    Parameters params = new Parameters();
    // 构建配置构建器，指定配置文件
    FileBasedConfigurationBuilder<PropertiesConfiguration> builder =
        new FileBasedConfigurationBuilder<>(PropertiesConfiguration.class)
            .configure(params.properties()
                .setFileName("application.properties")
                // 设置更新注释
                .setHeaderComment("Updated by application")
                // 关闭Unicode转义，避免自动转义特殊字符
                .setEscapeUnicode(false)
                // 保留原文件的注释和空行
                .setKeepPreservedMode(true));

    try {
        PropertiesConfiguration config = builder.getConfiguration();
        // 设置或更新键值对
        config.setProperty(key, value);
        // 保存配置
        builder.save();
    } catch (ConfigurationException e) {
        System.err.println("Error writing app settings: " + e.getMessage());
    }
}

这个方案的优势：

• 自动保留原文件的空行、注释和格式
• 可以灵活控制是否转义特殊字符，完全适配人工编辑需求
• 处理了各种边缘情况（比如键值对的多种分隔符、注释识别），比自己写逻辑更稳定

方案二：手动实现读写逻辑（无依赖） #

如果不想引入第三方库，可以自己手动读取每一行，保留空行和注释，然后替换或追加键值对：

import java.io.*;
import java.util.ArrayList;
import java.util.List;

public static void addUpdateAppSettings(String key, String value) {
    File configFile = new File("application.properties");
    List<String> allLines = new ArrayList<>();
    boolean keyExists = false;

    // 读取所有行，保留空行、注释和原有格式
    try (BufferedReader reader = new BufferedReader(new FileReader(configFile))) {
        String line;
        while ((line = reader.readLine()) != null) {
            // 跳过注释行，只处理键值对行
            if (!line.trim().startsWith("#") && !line.trim().startsWith("!")) {
                int separatorPos = line.indexOf('=');
                if (separatorPos != -1) {
                    String existingKey = line.substring(0, separatorPos).trim();
                    if (existingKey.equals(key)) {
                        // 替换该行的值
                        allLines.add(key + "=" + value);
                        keyExists = true;
                        continue;
                    }
                }
            }
            // 保留原行（空行、注释、其他键值对）
            allLines.add(line);
        }
    } catch (IOException e) {
        System.err.println("Error reading configuration file: " + e.getMessage());
        return;
    }

    // 如果key不存在，追加到文件末尾
    if (!keyExists) {
        allLines.add(key + "=" + value);
    }

    // 写入所有行
    try (BufferedWriter writer = new BufferedWriter(new FileWriter(configFile))) {
        for (String line : allLines) {
            writer.write(line);
            writer.newLine();
        }
    } catch (IOException e) {
        System.err.println("Error writing configuration file: " + e.getMessage());
    }
}

注意：这个方案需要自己处理一些边缘情况，比如值中包含=或#的情况（如果需要支持，得手动判断并处理，但人工编辑场景下一般可以接受）。

总结 #

原生Properties类的设计目标是程序读写，不是人工友好的配置管理。如果追求稳定性和功能完整性，优先用Apache Commons Configuration；如果不想加依赖，手动实现读写逻辑也能解决问题。

内容的提问来源于stack exchange，提问作者Black