Websocat工具中实现JSON消息多行输入的支持

在WebSocket开发和调试过程中，开发者经常需要处理复杂的JSON消息。作为一款强大的WebSocket命令行工具，Websocat近期增加了一项实用功能——支持多行JSON消息的输入，极大提升了开发者的工作效率。

多行输入的需求背景

在传统的Websocat使用中，当开发者需要发送格式化的JSON消息时，会遇到一个实际问题：工具默认按行发送输入内容。这意味着从编辑器复制粘贴的漂亮打印（pretty-printed）JSON格式消息会被拆分成多行发送，而不是作为一个完整的JSON对象发送。

例如，当开发者尝试发送以下格式化的JSON时：

{
  "command": "list",
  "args": [1, 2]
}

Websocat会将其视为三行独立内容分别发送，这显然不符合预期。

解决方案的演进

最初，开发者提出了使用自定义标记符的方案，建议通过类似##的标记来标识消息的开始和结束。这种方法虽然可行，但需要额外的语法标记，增加了使用复杂度。

随后，项目维护者提出了更优雅的解决方案——利用空行作为消息分隔符。这个方案基于以下观察：

1. 格式化的JSON消息内部通常不会包含空行
2. 空行作为分隔符在UNIX/Linux环境中是常见模式
3. 无需引入额外语法，保持简洁性

实现细节

在websocat4分支中，该功能通过--separator-n 2选项实现。这个选项指定使用连续的两个换行符作为消息分隔符，工作原理如下：

1. 工具会持续读取输入，直到遇到两个连续的换行符
2. 将两个换行符之间的所有内容（包括其中的换行符）作为一个完整消息
3. 发送这个完整的消息到WebSocket服务器

使用示例

开发者现在可以这样使用Websocat：

websocat --separator-n 2 ws://example.com/ws

然后直接粘贴多行JSON内容，用空行结束：

{
  "command": "getStatus",
  "params": {
    "id": 12345,
    "verbose": true
  }
}

最后的空行（即两个连续的换行符）会触发消息发送。

技术优势

1. 保持JSON可读性：开发者可以继续使用格式化的JSON，保持代码可读性
2. 简化工作流程：直接从编辑器复制粘贴，无需额外处理
3. 兼容性好：与现有UNIX工具的空行分隔惯例一致
4. 无侵入性：不需要修改JSON内容本身

应用场景

这项改进特别适用于以下场景：

• 开发调试复杂的WebSocket API
• 自动化测试中准备测试数据
• 教学演示时展示完整的协议消息
• 与代码仓库中的示例消息保持格式一致

总结

Websocat通过引入多行消息输入支持，解决了WebSocket开发中的一个实际痛点。这种以空行作为分隔符的方案既保持了工具的简洁性，又提供了足够的灵活性，体现了优秀工具设计中的实用主义哲学。对于经常需要处理WebSocket协议消息的开发者来说，这无疑是一个值得关注的功能增强。