知识卡片

普通读书笔记卡 · 5230.a.3.a.3

自研应用的配置数据设计

理解等级:高级

自研应用可以设计成与可复用配置语言共存。总策略:语言问题交给配置语言,其他一切交给应用。最佳实践:

  • 应用只读一个纯数据文件,拆分文件用配置语言的 import——实现只需输出、应用只需读取单个文件,组合方式也清楚明确;
  • 命名实体集合用对象而不是数组:{"cat": {...}, "dog": {...}} 优于每个元素带 name 字段的数组——便于扩展,按名引用(animals.cat)而不是脆弱的下标(animals[0]);
  • 不要在顶层按类型分组,而是把逻辑相关的配置放在同一子树:pot_assembly1: {pot, lid} 优于 pots: {...}, lids: {...}——这样配置语言层的抽象能沿功能边界进行(kitchen.SaucePan { pot+: { color: 'red' } });
  • 数据表示保持简单:不要在数据表示里嵌入语言特性(陷阱1),否则功能不足又让用户纠结在哪层抽象;不必担心数据表示太冗长,减少冗长会引入复杂性,冗长交给配置语言解决;避免在应用中解释自定义字符串插值(条件、占位符引用),除非描述生成纯数据之后才执行的动作(告警、处理器);
  • 能删除配置就删;配置语言能用带默认值的模板隐藏底层模型的复杂度,但生成的数据并没有完全隐藏——会被工具处理、被人查看、进入配置数据库。所以不要靠配置语言掩盖底层模型的命名不一致、单复数或错误,应在模型本身修复;实在修不了,就在语言层接受它们,避免更多不一致。

验证生成的配置数据:随着时间推移,配置变更往往成为中断的主要根因(见附录C)。配置执行后立即验证——只做语法验证(JSON 能否解析)发现不了多少错误;通用模式验证后还要检查领域属性:必填字段是否存在、引用的文件是否存在、值是否在允许范围内。可用 JSON Schema;用 protobuf 的应用可生成规范 JSON,反序列化时自动验证。不要忽略无法识别的字段名——它们可能是配置语言层的拼写错误;不应输出的字段用 :: 隐藏。同样的验证也放进预提交钩子。

译文提示:本书为社区机器辅助译本,本卡按上下文和官方英文版理解,引文保留中文原样。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《谷歌站点可靠性工作手册》第15章《第15章 配置细节》15 集成自定义应用程序(内部软件)(源文件:extracted/谷歌站点可靠性工作手册/_epub-src/OEBPS/Text/21.html,来源项目 book-sources) - 结论依据:第15章给出自研应用与配置语言共存的实践:只读单个纯数据文件、命名集合用对象而非数组、按功能而非类型分组、数据表示保持简单且不解释自定义插值、在模型本身修复不一致,并要求在配置生成后做领域语义验证且不忽略未知字段。 - 原始内容:不管您决定如何验证,都不要忽略无法识别的字段名称,因为它们可能表示在配置语言级别上有错字。