kaml配置全解析YamlConfiguration的14个选项如何让你的YAML处理如虎添翼【免费下载链接】kamlYAML support for kotlinx.serialization项目地址: https://gitcode.com/gh_mirrors/ka/kamlkaml是一款为 Kotlin 生态打造的YAML 序列化库它为 kotlinx.serialization 补上了 YAML 支持。而 YamlConfiguration 正是 kaml 的配置中枢——目前版本共开放了 16 个配置项覆盖严格模式、多态风格、缩进与折行、引号风格、命名策略等几乎你能想到的 YAML 读写细节。读懂它们你就掌握了 kaml 的全部调优能力。 YamlConfiguration 在哪里配置所有配置项都集中在一个 data class 中定义源码位于src/commonMain/kotlin/com/charleskorn/kaml/YamlConfiguration.kt使用时只需在创建Yaml实例时传入配置即可入口类见src/commonMain/kotlin/com/charleskorn/kaml/Yaml.ktval yaml Yaml( configuration YamlConfiguration( strictMode false, encodingIndentationSize 4, yamlNamingStrategy YamlNamingStrategy.Builtins.SnakeCase ) )由于YamlConfiguration是 data class所有参数都有默认值你可以只改关心的那几项。下面按读取 / 写入 / 命名三大场景逐一解析。 读取场景让 kaml 更安全、更兼容strictMode —— 遇到未知字段是报错还是忽略默认值true作用true时YAML 中出现对象里不存在的属性会直接抛异常改为false则静默忽略。处理别人家的配置文件时把strictMode关掉可以避免版本演进带来的字段不兼容问题。anchorsAndAliases —— 锚点与别名默认出于安全禁用默认值AnchorsAndAliases.Forbidden作用YAML 的锚点和别名*是合法特性但也是YAML 炸弹攻击的常见入口因此 kaml 默认禁用。进阶AnchorsAndAliases.Permitted(maxAliasCount 100u)可放开限制maxAliasCount为null表示不限量。这个设计非常贴心需要时能开默认却替你挡掉了安全风险。extensionDefinitionPrefix —— Docker Compose 风格的扩展字段默认值null禁用作用指定根级别扩展键的前缀如x-让 kaml 支持类似 Docker Compose 的定义一次、多处合并的扩展写法。x-common: common timeout: 30 app: : *common name: demopolymorphismStyle 与 polymorphismPropertyName —— 多态类型怎么标记默认值PolymorphismStyle.Tag属性名为type三种风格Tag用 YAML 标签标记类型如!frontend { hostname: a.com }Property用一个普通属性标记类型如{ type: frontend, hostname: a.com }None不写入类型信息适合结构已知的场景polymorphismPropertyName则允许把Property风格下的类型字段从type改成kind、action等任意名字方便对接已有格式。codePointLimit —— 输入体积的保险丝默认值约 3 MB以码点计作用限制输入 YAML 文档的最大长度防止超大文件拖垮解析器。解析外部来源的 YAML 时适当调小这个值是一道低成本的安全防线。decodeEnumCaseInsensitive —— 枚举大小写不敏感默认值false实验性 API作用开启后Running、running、RUNNING都能匹配同一个枚举值。对接第三方配置时它能让枚举解析少踩一个差一个大小写就崩的坑。 写入场景让输出的 YAML 更好看encodeDefaults —— 默认值要不要写出来默认值true作用设为false时等于默认值的属性不再写入 YAML输出更简洁。生成用户可编辑的配置文件时这项几乎是必开项——少写噪声用户只关注真正要改的值。encodingIndentationSize 与 sequenceBlockIndent —— 缩进自由默认值均为2/0作用前者控制对象属性的缩进空格数可设为 4 对齐团队习惯后者专门控制块风格序列的缩进让-符号顶格还是缩进由你决定。breakScalarsAt —— 长字符串自动折行默认值80作用标量字符串等超过该长度时自动拆成多行生成的 YAML 天然符合 80 列阅读习惯diff 也更友好。sequenceStyle —— 列表的两种长相默认值SequenceStyle.Block两种风格# Block默认 members: - Bob - Cindy # Flow members: [Bob, Cindy]短列表想省行数换成Flow一行搞定。singleLineStringStyle、multiLineStringStyle 与 ambiguousQuoteStyle —— 引号三连默认值单行DoubleQuoted多行跟随单行风格歧义引用DoubleQuoted作用控制字符串以双引号、单引号还是裸Plain形式写出。其中PlainExceptAmbiguous是最值得了解的一项普通字符串不加引号但会被误读成其他类型的值如True、1、1.2会自动加引号保护ambiguousQuoteStyle则指定用双引号还是单引号保护。输出人类友好的 YAML 时它通常是最优解。️ 命名场景yamlNamingStrategy 一键转换字段名默认值null保持原名作用把 Kotlin 属性名批量转换成 YAML 中使用的键名。内置四种策略见src/commonMain/kotlin/com/charleskorn/kaml/YamlNamingStrategy.kt策略示例转换SnakeCaseuserName→user_nameKebabCaseuserName→user-namePascalCaseuserName→UserNameCamelCaseuser_name→userName它同时作用于读和写两个方向是适配第三方 YAML 格式最常用的一项。⚡ 速查表先配置哪几项场景推荐配置解析外部/第三方 YAMLstrictMode falsedecodeEnumCaseInsensitive true允许锚点合并Compose 风格anchorsAndAliases Permitted(...)extensionDefinitionPrefix x-生成干净的配置文件encodeDefaults falsebreakScalarsAt 80输出人类友好的 YAMLsingleLineStringStyle PlainExceptAmbiguous对接 snake_case 格式yamlNamingStrategy SnakeCase多态类型用属性表达polymorphismStyle PropertypolymorphismPropertyName kind✅ 总结kaml 的YamlConfiguration用 16 个配置项覆盖了 YAML 序列化的三大核心诉求安全strictMode、锚点限制、体积上限、兼容扩展字段、枚举大小写、命名策略和美观缩进、折行、引号与列表风格。它默认值保守而合理按需打开对应选项就能让 kaml 的 YAML 处理真正做到如虎添翼。更多使用示例可以参考官方说明 README.md相关行为都有对应的测试覆盖如src/commonTest/kotlin/com/charleskorn/kaml/YamlReadingTest.kt与src/commonTest/kotlin/com/charleskorn/kaml/YamlWritingTest.kt。【免费下载链接】kamlYAML support for kotlinx.serialization项目地址: https://gitcode.com/gh_mirrors/ka/kaml创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考