如何转义json串

JSON串转义全解析：为何转义、如何转义及最佳实践**

在JSON（JavaScript Object Notation）数据交换格式中，转义是一个至关重要的概念，无论是前端开发人员将数据传递给后端，还是后端API返回数据给前端，正确处理JSON串中的特殊字符都是确保数据完整性和解析正确性的关键，本文将详细解释JSON串为何需要转义，常见的转义字符有哪些，以及在不同编程语言中如何进行JSON串的转义。

为何需要转义JSON串？

JSON格式对字符串的构成有严格的规定,字符串必须用双引号（）括起来，字符串内部可以包含Unicode字符、控制字符（如换行符、制表符）以及一些特殊字符，这些特殊字符如果直接出现在JSON字符串中，可能会破坏JSON的结构，导致解析器无法正确识别数据的开始和结束，或者误解其含义。

假设我们有一个字符串：He said, "Hello, World!"，如果直接将其作为JSON值而不进行转义，JSON解析器会在第一个双引号处误认为字符串结束，从而导致语法错误：

{
  "message": He said, "Hello, World!"
}

这显然是无效的JSON,我们需要对字符串中的双引号以及其他特殊字符进行转义，以确保JSON格式的有效性。

JSON中常见的转义字符

JSON定义了一组转义序列,用于表示特殊字符，这些转义序列以反斜杠（\）开头：

重要提示：

1. 双引号（）是必须转义的，因为它是JSON字符串的界定符。
2. 反斜杠（\）本身也必须转义，即用\\表示，否则无法正确表示转义序列。
3. 正斜杠（）虽然在JSON中可以不转义，但为了统一和避免某些特殊情况（如在XML嵌入JSON时），也可以转义为\/。
4. \uXXXX用于表示非ASCII字符，例如\u4e2d\u6587表示“中文”。

如何转义JSON串（编程语言示例）

几乎所有的现代编程语言都提供了内置的库或函数来处理JSON的序列化和反序列化,这些库会自动处理字符串的转义。强烈建议使用这些内置功能，而不是手动拼接转义字符，因为手动转义容易出错，且难以覆盖所有边缘情况。

JavaScript

在JavaScript中,可以使用JSON.stringify()方法将JavaScript对象或字符串转换为JSON格式的字符串，该方法会自动处理所有必要的转义。

const str = 'He said, "JSON is great!", and then\nnew line.';
const obj = { message: str, chinese: "中文" };
// 自动转义
const jsonString = JSON.stringify(obj);
console.log(jsonString);
// 输出: {"message":"He said, \"JSON is great!\", and then\nnew line.","chinese":"中文"}

JSON.stringify()会自动将双引号、反斜杠、换行符等转换为对应的转义序列。

Python

在Python中,可以使用json模块的dumps()函数（dump to string）来序列化对象为JSON字符串。

import json
str = 'He said, "JSON is great!", and then\nnew line.'
obj = {"message": str, "chinese": "中文"}
# 自动转义
json_string = json.dumps(obj, ensure_ascii=False)  # ensure_ascii=False 显示非ASCII字符
print(json_string)
# 输出: {"message": "He said, \"JSON is great!\", and then\nnew line.", "chinese": "中文"}

同样,json.dumps()会自动处理转义。ensure_ascii=False参数允许直接输出非ASCII字符（如中文），否则会被转义为\uXXXX形式。

Java

在Java中,可以使用org.json库（如JSONObject、JSONArray）或Jackson、Gson等库，这里以org.json为例：

import org.json.JSONObject;
public class JsonEscapeExample {
    public static void main(String[] args) {
        String str = "He said, \"JSON is great!\", and then\nnew line.";
        JSONObject obj = new JSONObject();
        obj.put("message", str);
        obj.put("chinese", "中文");
        // 自动转义
        String jsonString = obj.toString();
        System.out.println(jsonString);
        // 输出: {"message":"He said, \"JSON is great!\", and then\nnew line.","chinese":"中文"}
    }
}

Jackson和Gson等主流库也会在序列化时自动处理转义。

C

在C#中，可以使用System.Text.Json命名空间下的类（如JsonSerializer）或Newtonsoft.Json库。

using System;
using System.Text.Json;
public class JsonEscapeExample
{
    public class MessageObject
    {
        public string Message { get; set; }
        public string Chinese { get; set; }
    }
    public static void Main()
    {
        string str = "He said, \"JSON is great!\", and then\nnew line.";
        var obj = new MessageObject { Message = str, Chinese = "中文" };
        // 自动转义
        string jsonString = JsonSerializer.Serialize(obj);
        Console.WriteLine(jsonString);
        // 输出: {"message":"He said, \"JSON is great!\", and then\nnew line.","chinese":"中文"}
    }
}

手动转义（不推荐，仅作理解）

虽然不推荐,但理解手动转义的逻辑有助于更好地理解JSON，在JavaScript中手动转义一个简单的字符串：

function escapeJsonString(str) {
    return str.replace(/["\\\/\b\f\n\r\t]/g, function (char) {
        switch (char) {
            case '"': return '\\"';
            case '\\': return '\\\\';
            case '/': return '\\/';
            case '\b': return '\\b';
            case '\f': return '\\f';
            case '\n': return '\\n';
            case '\r': return '\\r';
            case '\t': return '\\t';
            default: return char;
        }
    });
}
const unescaped = 'He said, "Hello", and then\nleft.';
const escaped = escapeJsonString(unescaped);
console.log(escaped);
// 输出: He said, \"Hello\", and then\nleft.

再次强调： 手动转义复杂字符串和Unicode字符容易出错，应优先使用语言内置的JSON序列化方法。

最佳实践

1. 优先使用标准库：几乎所有编程语言都提供了成熟的JSON处理库，始终使用它们进行序列化和反序列化，避免手动转义。
2. 验证JSON：在生成JSON字符串后，可以使用在线JSON验证工具（如JSONLint）或库函数来验证其有效性。
3. 处理Unicode：如果需要JSON字符串中直接包含非ASCII字符（如中文），确保使用的库支持并正确配置（如Python的ensure_ascii=False）。
4. 注意前后端交互：确保前端和后端在JSON数据的处理上保持一致，特别是字符编码（通常为UTF-8）。
5. 安全考虑：虽然JSON本身是数据格式，但在处理来自不可信源的JSON数据时，要注意防范JSON注入等攻击，确保解析库的安全性。

JSON串的转义是确保数据在序列化和传输过程中保持格式正确性的基础,理解常见的转义字符及其含义固然重要，但更重要的是并善用所在编程语言提供的标准JSON处理工具，这些工具能够自动、高效、准确地完成转义工作，让我们能更专注于业务逻辑的实现，而不是陷入繁琐且易错的字符处理细节。让专业的库做专业的事，这是处理JSON转义乃至整个JSON数据交互的核心准则。