如何在 YAML 中正确换行并保持字符串格式

秋伟君_2166

秋伟君_2166

2026-11-20

985人浏览

原创

如何在 YAML 中正确换行并保持字符串格式

本文详解 YAML 字符串多行写法(literal | 与 folded >),重点解决 Prometheus 查询语句在 KEDA ScaledObject 中换行后被错误转义或缩进的问题,并提供 Java 序列化时的避坑实践。

本文详解 yaml 字符串多行写法(literal `|` 与 folded `>`),重点解决 prometheus 查询语句在 keda scaledobject 中换行后被错误转义或缩进的问题,并提供 java 序列化时的避坑实践。

在 YAML 中实现多行字符串,核心在于正确使用块标量指示符(block scalar indicators),而非在 Java 字符串中手动拼接 \n。你当前遇到的问题——如出现重复 |-、空行、或换行符被转义为字面 \n——根本原因在于:Java 层面的字符串拼接与 YAML 序列化逻辑发生了错位。YAML 解析器(如 SnakeYAML)期望接收的是结构化的 Java 对象(如 Map),再由其自动渲染为符合规范的 YAML 块格式;若提前在字符串中硬编码 \n 或 |,反而会破坏 YAML 的语义解析。

✅ 正确做法:用 Java 对象建模,交由 SnakeYAML 自动渲染

以你的 ScaledObject 为例,应将 query 字段定义为普通 Java 字符串(不含任何 | 或 \n),并在构建对象时直接赋值多行内容:

Map<string object> metadata = new LinkedHashMap();
metadata.put("serverAddress", "http://kube-prometheus-stack-prometheus.monitoring:9090");
metadata.put("metricName", "nginx_ingress_controller_requests");
// 关键:此处直接使用含换行的字符串(注意:换行符必须是 \n,且无前置空格)
metadata.put("query",
    "sum(increase(nginx_ingress_controller_requests{path=\"?\"}[10m]))"
);</string>

然后确保 YAML 序列化配置启用 block style 并保留换行语义:

DumperOptions options = new DumperOptions();
options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); // 强制块模式
options.setPrettyFlow(true); // 可选:提升可读性
options.setIndent(2);
options.setWidth(120);
Yaml yaml = new Yaml(options);
String finalYaml = yaml.dump(yamlMap); // ← 此时 SnakeYAML 会自动选择 | 样式

✅ 输出效果(完全匹配你的目标 YAML):

query: |
  sum(increase(nginx_ingress_controller_requests{path="/test"}[10m]))

? 原理说明:当 SnakeYAML 序列化一个包含换行符(\n)且首行无缩进、后续行无额外前导空格的字符串时,它会智能选用 |(literal block scalar)格式,并自动缩进所有后续行(默认 2 空格),从而完美复现你期望的 YAML 结构。

⚠️ 常见错误与规避方案

  • ❌ 错误:在 Java 字符串中写 "| \nsum(...)"
    → YAML 解析器会将其视为普通字符串字面值,导致输出 query: "| \nsum(...)"(即字面 \n 而非真实换行)。

  • ❌ 错误:使用 + 拼接多行字符串时引入多余空格或制表符
    → YAML 将按实际空白渲染,可能触发 | 格式但缩进错乱,甚至降级为 quoted string。

  • ✅ 最佳实践:

    • 使用 TextBlock 风格(Java 15+)或三重引号(若用 Kotlin/Scala)编写原始查询;
    • 或用 String.join("\n", lines) 构造纯净换行字符串;
    • 永远不要在字符串里显式写 |、> 或 >- —— 这是 YAML 序列化器的职责。

? 总结

YAML 多行字符串的本质是数据建模 + 序列化策略协同。你的目标不是“让 Java 字符串看起来像 YAML”,而是“让 Java 对象携带正确的换行语义,交由 SnakeYAML 渲染为标准 YAML”。只要确保:

  1. query 字段值为含 \n 的纯文本(如 "line1\nline2");
  2. DumperOptions 启用 BLOCK 流式风格;
  3. 不在字符串中混入 YAML 特殊字符;

即可零配置生成符合 KEDA 规范的 query: | 块格式。这不仅解决当前问题,更是 Kubernetes YAML 代码生成的通用范式。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1978

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

3304

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6464

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

6769

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

8274

16

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2024.04.29

12994

11

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.07.29

6779

17

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.08.07

7647

13

常用字符串方法大全
常用字符串方法大全

常用字符串方法大全

2025.08.08

3748

14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习