EvolutionAPI中JSON格式处理与换行符转义问题解析

在使用EvolutionAPI进行消息发送时，开发者可能会遇到JSON格式中换行符处理的问题。本文将深入分析这一技术问题，并提供有效的解决方案。

问题现象

当通过N8N向EvolutionAPI发送POST请求时，如果JSON消息体包含换行符\n，系统会返回格式错误。例如，当消息内容为：

"TRATATIVA COM O CLIENTE": "Olá!\n\nTudo bem com o Senhor?"

API会拒绝处理这样的请求，开发者不得不通过JavaScript的replace方法对JSON进行额外格式化处理。

技术分析

这个问题本质上不是EvolutionAPI的bug，而是JSON格式规范的要求。根据JSON标准规范：

1. JSON字符串中不能直接包含换行符
2. 换行必须使用转义序列\n表示
3. 在某些环境中，可能需要双重转义\\n

解决方案

针对不同的使用场景，开发者可以采用以下方法正确处理换行符：

方法一：标准转义

在JSON字符串中使用标准的\n转义序列：

{
  "message": "第一行\n第二行\n第三行"
}

方法二：环境特定转义

在某些特殊环境（如某些HTTP客户端或中间件）中，可能需要双重转义：

{
  "message": "第一行\\n第二行\\n第三行"
}

方法三：编程语言处理

在生成JSON前，使用编程语言的字符串处理功能：

// JavaScript示例
const message = "第一行\n第二行";
const jsonPayload = {
  text: message.replace(/\n/g, "\\n")
};

最佳实践建议

1. 在构建JSON请求体时，始终确保字符串内容已正确转义
2. 对于多行文本，建议先在代码中处理好换行符，再构建JSON
3. 使用JSON验证工具检查生成的JSON格式是否正确
4. 考虑在API调用前添加日志输出，确认最终发送的JSON格式

总结

理解JSON格式规范对于API集成至关重要。EvolutionAPI遵循标准的JSON处理规则，开发者需要确保发送的请求体符合这些规范。通过正确处理换行符转义，可以避免这类格式问题，确保API调用的可靠性。

对于需要频繁处理多行文本的场景，建议封装专门的JSON构建工具函数，统一处理各种特殊字符的转义问题，提高代码的可维护性和健壮性。