一段消息本来有两行,直接把它粘进JSON引号里,校验却报错;把换行替换成反斜杠加n以后,日志又显示成另一种样子。处理这类问题时,先确定眼前看的是JSON源码,还是解析后的字符串值。

本文在JSON格式化工具中测试三种输入。它们的可见文字很像,实际包含的字符不同;示例仅有公开的 line1、line2,没有业务日志或账号信息。

真实换行不能直接放进双引号之间

第一组输入在 line1 后面实际按了一次回车:

{"message":"line1
line2"}
引号内存在真实换行时,本次校验显示第1行解析错误
引号内存在真实换行时,本次校验显示第1行解析错误

点击“校验 / 格式化”后,工具显示红色解析错误。编辑框看起来仍有层级和换行,不能因此忽略下面的错误提示;这一组没有通过校验,也没有因为排版变整齐就成为可提交的JSON。

JSON字符串中,换行、制表符等控制字符需要按语法转义。对象成员之间可以有排版换行,不等于字符串内部也能直接放一个换行符。判断时先找成对的双引号:回车是在引号外面分隔结构,还是在引号里面属于字段内容?

如果原始消息确实要分两行,不应简单删除换行,改成一长行。那会改掉业务内容。更合适的办法是让JSON序列化程序把字符串转换成合法表示。

一个反斜杠加n,在源码里表示换行

第二组改为这一行。代码块里的 \n 由反斜杠和字母n组成,没有在两词之间按回车:

{"message":"line1\nline2"}
合法的反斜杠n保留在JSON源码中,本次格式化成功
合法的反斜杠n保留在JSON源码中,本次格式化成功

这次出现绿色成功提示。格式化结果仍把 \n 展示在引号内,这是JSON源码的写法。解析这段JSON后,得到的 message 值中对应一个真实LF换行符;工具没有把源码编辑框变成聊天消息预览。

用本地 JavaScript 可把这两层拆开核对:

const source = "{\"message\":\"line1\\nline2\"}";
const data = JSON.parse(source);
console.log(data.message.includes("\n")); // true

这个示例同时出现了JavaScript字符串和JSON源码,因此代码中要再对反斜杠进行一层转义。不要照着屏幕数斜杠以后就全局替换,先确认当前字符串被哪一层语言包着。

两个反斜杠加n,解析后是普通字符

第三组输入如下:

{"message":"line1\\nline2"}
第三组同样通过,但源码中双反斜杠表示解析后的一个普通反斜杠
第三组同样通过,但源码中双反斜杠表示解析后的一个普通反斜杠

本次它也通过校验。这里的 \\ 是JSON对反斜杠本身的转义,后面的n只是普通字母。因此,解析后的值包含反斜杠和n,并不会在这个位置自动换行。格式化成功只能证明它是合法JSON,不能证明它符合“需要两行消息”的业务预期。

可以在接收程序里检查值的长度、是否包含LF,或查看每个字符的码点。第一种合法写法解析后的两词之间是一个换行字符,第二种则是两个普通字符。截图中看起来都带n,差别要回到原始源码和解析结果确认。

让序列化程序处理内容

自己在代码中构造请求时,优先把原始消息交给JSON序列化函数,而不是先手动替换换行再拼接引号。原始字符串里若还有双引号、制表符或反斜杠,序列化函数能按JSON语法统一处理;手工替换很容易漏掉一种字符,或者重复转义。

从日志复制时,还要确认日志是否又展示了一层“字符串的字符串”。同一份JSON在调试器、日志文件和编辑器中可能有不同展示。遇到多层反斜杠,可以参照JSON转义与去转义的层次核对,每次只确认当前这一层的输入和预期结果。