Java中JSON字符串如何正确添加转义字符？

Question

在Java中处理JSON字符串时，如何正确添加转义字符是一个常见痛点。例如，当手动拼接JSON字符串时，若字段值包含双引号（"）、反斜杠（\）、换行符（\n）等特殊字符，未正确转义会导致JSON格式错误或解析失败。开发者常误以为只需简单使用反斜杠转义，却忽略了Java字符串本身也需处理转义，导致双重转义问题。如：`String json = "{\"name\": \"O\"Reilly\"}";` 因未转义单引号和双引号而引发语法错误。正确做法是使用标准JSON库（如Jackson、Gson）自动处理转义，或手动时遵循JSON规范对 `"`、`\`、`/`、`\b`、`\f`、`\n`、`\r`、`\t` 进行转义，同时注意Java字符串中的反斜杠需写成`\\`。

Answer 1

1. 问题背景：Java中JSON字符串转义的常见误区

在Java开发中，处理JSON数据是一项高频任务。许多开发者在手动拼接JSON字符串时，容易忽略转义字符的双重含义——既属于Java字符串语法，也属于JSON格式规范。例如以下代码：

String json = "{\"name\": \"O\"Reilly\"}";

这段代码在编译阶段就会报错，原因在于双引号未被正确转义。Java将\"解析为一个双引号字符，但此时字符串内部的O\"Reilly会导致语法断裂。

根本问题在于：开发者混淆了“Java字符串转义”与“JSON内容转义”的边界。

2. 转义机制剖析：Java与JSON的双重语义

理解转义的关键是区分两层语义：

• Java字符串层面：使用反斜杠\对特殊字符如"、\、\n进行转义；
• JSON格式层面：根据RFC 7159标准，需对"、\、/、\b、\f、\n、\r、\t等进行转义。

当两者叠加时，若要在JSON值中表示一个双引号，必须写成\\"，因为Java先将其解释为\"，再交由JSON解析器识别为合法字符。

3. 手动转义的典型错误与修正示例

原始值	错误写法	正确写法	说明
O"Reilly	"{\\"name\\": \\"O\\"Reilly\\"}"	"{\\\"name\\\": \\\"O\\\"Reilly\\\"}"	Java需解析两次反斜杠
C:\path\note.txt	"{\\"path\\": \\"C:\\path\note.txt\\"}"	"{\\\"path\\\": \\\"C:\\\\path\\\\note.txt\\\"}"	Windows路径中的\和\n均需转义
Multi-line\ntext	"{\\"desc\\": \\"Multi-line\ntext\\"}"	"{\\\"desc\\\": \\\"Multi-line\\\\ntext\\\"}"	换行符在JSON中应保留为\\n

4. 推荐方案：使用标准JSON库自动处理转义

避免手动拼接的最佳实践是采用成熟的JSON库，如Jackson或Gson。它们会自动完成对象到JSON字符串的序列化，并正确处理所有转义逻辑。

// 使用Gson示例
Gson gson = new Gson();
Map<String, Object> data = new HashMap<>();
data.put("name", "O\"Reilly");
data.put("path", "C:\\path\\note.txt");
data.put("desc", "Line1\\nLine2");

String json = gson.toJson(data);
System.out.println(json); 
// 输出: {"name":"O\"Reilly","path":"C:\\path\\note.txt","desc":"Line1\\nLine2"}

5. 自定义转义工具类的设计思路

在无法引入第三方库的受限环境中，可构建轻量级转义工具。以下是一个符合JSON规范的转义方法：

public static String escapeJson(String input) {
    if (input == null) return null;
    StringBuilder sb = new StringBuilder();
    for (char c : input.toCharArray()) {
        switch (c) {
            case '\\': sb.append("\\\\"); break;
            case '"':  sb.append("\\\""); break;
            case '\b': sb.append("\\b"); break;
            case '\f': sb.append("\\f"); break;
            case '\n': sb.append("\\n"); break;
            case '\r': sb.append("\\r"); break;
            case '\t': sb.append("\\t"); break;
            default:
                if (c < 0x20 || c == '\\u007f') {
                    sb.append(String.format("\\u%04x", (int) c));
                } else {
                    sb.append(c);
                }
        }
    }
    return sb.toString();
}

6. 架构视角下的风险控制流程图

在微服务或API网关架构中，JSON构造环节应纳入统一的数据校验与编码策略。如下Mermaid流程图展示了安全生成JSON的推荐路径：

graph TD
            A[原始业务数据] --> B{是否可信?}
            B -- 否 --> C[清洗/过滤敏感字符]
            B -- 是 --> D[映射至POJO]
            C --> D
            D --> E[使用Jackson/Gson序列化]
            E --> F[输出安全JSON字符串]
            F --> G[日志记录或网络传输]