使用Azure CosmosDB Connector的replaceDocument时遇非法未转义字符错误

问题描述 #

调用Azure CosmosDB的replaceDocument函数处理包含JSON不友好字符串（例如"testing\n123"）的文档时，返回错误：Illegal unquoted character ((CTRL-CHAR, code 10))，即使调用了父文档的.toJson()方法仍无法解决。

解决方案 #

• 排查.toJson()方法实现：部分自定义或第三方库的.toJson()方法可能未严格遵循JSON规范，遗漏了换行符这类控制字符的转义。优先确认该方法是否会将\n转义为\\n，若没有则需要调整实现。
• 手动转义控制字符：对文档中的字符串字段显式处理，将所有JSON不允许的控制字符（如\n、\r、\t等）替换为转义后的形式，确保序列化后的JSON符合规范。
• 升级CosmosDB连接器：旧版本的SDK或连接器可能存在序列化缺陷，升级到最新版本可修复这类控制字符处理问题。
• 改用原生JSON序列化工具：放弃自定义的.toJson()，使用语言原生的序列化工具（如JavaScript的JSON.stringify()、Java的Jackson库），这类工具严格遵循JSON标准，能自动处理所有控制字符的转义。

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