后台管理系统要展示一批用 YAML 写的服务编排配置,表单组件只吃 JSON,转换这一步绕不开。评审会上吵了两轮:一派主张自己引个解析库,几行代码的事;一派主张走现成的转换接口,省掉依赖维护。吵到最后发现,双方争的根本不是同一个问题——一个在算实现成本,一个在担心边界特性。
下面拿数据鱼API的「YAML 转 JSON」服务当例子。convert 端点收 YAML 文本返回 JSON,转换上限 200KB;而真正值得先看的,是它的 ping 端点——把支持什么、不支持什么,直接列成了两份清单。
能力边界,先问再看
ping 返回的 support 清单包括:映射、序列、嵌套、内联写法([a,b] 与 {a: 1})、类型推断、引号字符串、注释。not_support 清单也不含糊:锚点 & 与别名 *、多文档 ---、复杂折叠标量。
类别 内容 对转换的影响
支持 映射、序列、嵌套 常规配置文件的主力语法
支持 内联、类型推断、引号与注释 简写与注释可直接消化
不支持 锚点 & 与别名 * 重复片段展开不了,需预处理
不支持 多文档 --- 一次只能转一段,需先拆分
不支持 复杂折叠标量 多行折叠文本需改写为引号字符串
一张表看完,争论的焦点立刻变了:问题不是「谁来实现转换」,而是「我们的配置里有没有这三类不支持特性」。翻了一遍仓库,锚点用了十几处,还有一份用 --- 拼起来的合并配置——这才是真正的工作量所在。转换类工具最怕的不是报错,是静默出错:丢了属性、平了嵌套,页面照常渲染,数据已经变了样。数据鱼这个接口把能力声明直接做进 ping,等于替调用方省掉一轮试错:不用拿真实文件去撞,一次探活就知道行不行。提前把边界问清楚,胜过上线后修三次。
三类不支持特性,怎么落地
锚点与别名的本质是同一份数据在多处引用,转换器不展开它,调用方就得先做预处理:要么把锚点改写成普通节点,要么在调用前跑一遍展开脚本,把引用处替换成实体内容。多文档的处理更机械:按 --- 切开,逐段调 convert,再把结果按文档顺序拼回数组,顺手还能校验每段是否合法。折叠标量最隐蔽,多行文本折叠后的换行语义容易出错,改写成带引号的字符串最稳。
体量也是要提前算的一笔账。数据鱼这个接口的 convert 单次收 200KB 的 YAML 文本,多数单文件配置远远用不满,但如果是把整个配置仓库合并转换,就要按模块切分、分批调用,再在业务层把结果挂回原来的路径上。切分的粒度定在「一个服务一份配置」,比定在「一个仓库一份配置」稳得多。
POST /api/yaml-to-json/convert
{"yaml": "services:\n web:\n image: nginx:stable"}
参数类错误以 4001 到 4003 区分:缺参数、格式非法、取值不在支持列表。错误码拆得细,做提示时可以直接映射成用户能看懂的文案,不用自己再猜一遍失败原因。
自研解析与现成接口,怎么选
回到那场争论。自己引解析库,好处是全功能覆盖、离线可用,代价是升级依赖、处理方言差异都归自己管;走现成接口,好处是能力边界有人替你声明清楚、格式特性更新不用你追,代价是超限与网络路径要自己兜住。两条路线放在一起看,差异其实集中在三处:边界由谁声明、特性由谁跟进、异常由谁兜底。一次性脚本、内网小工具,自研直接利落;要做成长期跑的产品功能,边界清晰比功能齐全更重要——用户不会原谅静默转换错的文件,但能接受一句明确的「暂不支持锚点语法」。
我们的结论是折中:先跑预处理拆掉多文档,锚点交给展开脚本处理,剩下的常规 YAML 走接口转换。写代码之前,把 ping 返回的两份清单贴进需求文档——转换的坑,大多不在语法表里,在没提前问的那句「支不支持」。
以上整理自数据鱼API「YAML 转 JSON」接口的公开文档;文中配置为演示用脱敏示例。