如何在 YAML 中将字符串拆分为多行？问：答1:答2:答3:答4:答5:答6:答7:答8:答9:

71 阅读 0 评论 47 点赞

我是靠谱客的博主花痴向日葵，最近开发中收集的这篇文章主要介绍如何在 YAML 中将字符串拆分为多行？问：答1:答2:答3:答4:答5:答6:答7:答8:答9:，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

问：

在 YAML 中，我有一个很长的字符串。我想将其保留在编辑器的 80 列（左右）视图中，因此我想断开字符串。这个的语法是什么？

换句话说，我有这个：

Key: 'this is my very very very very very very long string'

我想要这个（或类似的东西）：

Key: 'this is my very very very ' +
'long string'

我想使用上面的引号，所以我不需要转义字符串中的任何内容。

答1:

huntsbot.com提供全网独家一站式外包任务、远程工作、创意产品分享与订阅服务!

在 YAML 中编写多行字符串有 5 6 NINE（或 63*，取决于您的计数方式）不同的方式。

TL;博士

大部分时间使用 > ：内部换行符被去掉，尽管你在最后得到一个： key: > 你的长字符串在这里。

使用 |如果您希望将这些换行符保留为 n （例如，带有段落的嵌入式降价）。键： | ### 标题 * 项目符号 * 点

如果您不想在末尾附加换行符，请使用 >- 或 |- 。

如果您需要在单词中间分割行或想要将换行符按字面意思键入为 n: key: "Antidisestab lishmentarianism。nn 开始使用，请使用 “…”。

YAML 很疯狂。

块标量样式 (>, |)

它们允许和 " 等字符不转义，并在字符串末尾添加新行 (n)。

Folded style 删除字符串中的单个换行符（但在末尾添加一个，并将双换行符转换为单个换行符）：

Key: >
this is my very very very
long string

→ this is my very very very long stringn

额外的前导空格被保留并导致额外的换行符。请参阅下面的注释。

建议：使用这个。通常这就是你想要的。

| Literal style 将字符串中的每个换行符转换为文字换行符，并在末尾添加一个：

Key: |
this is my very very very
long string

→ this is my very very verynlong stringn

这是来自 YAML Spec 1.2 的官方定义

标量内容可以用块表示法编写，使用文字样式（用“|”表示），其中所有换行符都很重要。或者，它们可以使用折叠样式（用“>”表示）编写，其中每个换行符都折叠到一个空格，除非它以空行或缩进更多的行结尾。

建议：使用它来插入格式化文本（尤其是 Markdown）作为值。

带有块咀嚼指示器的块样式（>-、|-、>+、|+）

您可以通过添加 block chomping indicator 字符来控制字符串中最后一个新行以及任何尾随空白行 (nn) 的处理：

, |: “clip”: 保持换行，去掉尾随的空行。

-, |-: “strip”: 去掉换行，去掉尾随的空行。

+, |+: “keep”: 保持换行，保持尾随空行。

“流” 标量样式 (, ", ')

这些具有有限的转义，并构造一个没有换行符的单行字符串。它们可以与键在同一行开始，也可以先使用额外的换行符，这些换行符被剥离。加倍的换行符变成一个换行符。

plain style（没有转义，没有 # 或 : 组合，第一个字符不能是 "、’ 或许多其他标点字符）：

Key: this is my very very very
long string

建议：避免。可能看起来很方便，但您可能会因意外使用禁止的标点符号并触发语法错误而自取其辱。

double-quoted style（和 " 必须用转义，可以使用文字 n 序列插入换行符，可以在不带空格的情况下使用尾随连接行）：

Key: "this is my very very "very" loooo
ng string.nnLove, YAML."

→ “this is my very very “very” loooong string.nnLove, YAML.”

建议：在非常特殊的情况下使用。这是您可以在不添加空格的情况下跨行打破非常长的标记（如 URL）的唯一方法。也许在中线添加换行符是有用的。

single-quoted style（文字 ’ 必须加倍，没有特殊字符，可能对表示以双引号开头的字符串有用）：

Key: 'this is my very very "very"
long string, isn''t it.'

→ “this is my very very “very” long string, isn’t it.”

建议：避免。好处很少，主要是不便。

带有缩进指示符的块样式

万一以上内容对您来说还不够，您可以添加一个“block indentation indicator”（在您的块咀嚼指示器之后，如果您有的话）：

- >8
My long string
starts over here
- |+1
This one
starts here

注意：折叠样式中的前导空格 (>)

如果您在折叠样式的非第一行的开头插入额外的空格，它们将被保留，并带有一个额外的换行符。（流样式不会发生这种情况。）Section 6.5：

此外，折叠不适用于包含前导空白的文本行周围的换行符。请注意，这样一个缩进更多的行可能只包含这样的前导空格。

- >
my long
string
many spaces above
- my long
string
many spaces above

→ [“my longn stringn nmany spaces aboven”,“my long stringnmany spaces above”]

概括

在此表中，_ 表示 space character。 n 表示“换行符”（JavaScript 中的 n），“其他功能”下除外。 “前导空格”在第一行之后应用（建立缩进）

| " ’ >- >+ |- |+ 空格/换行符转换为：尾随空格 → _ _ _ _ _ _ 前导空格 → n_ n_ n_ n_ n_ n_ 单个换行符 → _ n _ _ _ _ _ n n 双换行 → n nn n n n n n nn nn 最终换行 → n n n n 最终双换行 → n n nn 如何创建文字：单引号 ’ ’ ’ ’ ‘’ ’ ’ ’ ’ 双引号 " " " " " " " " " 反斜杠其他功能 In-用 n ???? ???? ???? ✅ ???? ???? ???? ???? ???? 用 ???? ???? ???? ✅ ???? ???? ???? ???? ???? # 或 : 在值中 ✅ ✅ ???? ✅ ✅ ✅ ✅ ✅ ✅ 可以在同一行开始✅ ✅ ✅ ???? ???? ???? ????

例子

请注意“空格”之前行中的尾随空格。

- >
very "long"
'string' with
paragraph gap, n and
spaces.
- |
very "long"
'string' with
paragraph gap, n and
spaces.
- very "long"
'string' with
paragraph gap, n and
spaces.
- "very "long"
'string' with
paragraph gap, n and
s
p
a
c
e
s."
- 'very "long"
''string'' with
paragraph gap, n and
spaces.'
- >-
very "long"
'string' with
paragraph gap, n and
spaces.
[
"very "long" 'string' withnparagraph gap, \n and
spaces.n",
"very "long"n'string' withnnparagraph gap, \n and
nspaces.n",
"very "long" 'string' withnparagraph gap, \n and spaces.",
"very "long" 'string' withnparagraph gap, n and spaces.",
"very "long" 'string' withnparagraph gap, \n and spaces.",
"very "long" 'string' withnparagraph gap, \n and
spaces."
]

*2 种块样式，每种都有 2 个可能的块缩进指示符（或没有），以及 9 个可能的缩进指示符（或没有），1 种普通样式和 2 种引用样式：2 x (2 + 1) x ( 9 + 1) + 1 + 2 = 63

其中一些信息也已汇总here。

打造属于自己的副业，开启自由职业之旅，从huntsbot.com开始!

在这 63 种语法中，你认为有一种可以让你在多行中拼写一个不应该有换行符和空格的字符串吗？我的意思是在大多数编程语言中人们会写成 "..." + "..."，或者在 Bash 中的换行符之前写成反斜杠。

@pepoluan 我尝试了所有可能的组合，发现只有一个允许无空格连接：在字符串周围加上双引号，在换行符（和缩进）之前加上反斜杠。示例：data:text/plain;base64,dGVzdDogImZvb1wKICBiYXIiCg==

@wvxvw 相反，我认为 YAML 是许多常见用例（例如，配置文件）的最差格式，尤其是因为大多数人被其明显的简单性所吸引，但后来才意识到它是一种极其复杂的格式。 YAML 使错误的东西看起来正确 - 例如，字符串数组中的一个字符串中的无害冒号 : 会使 YAML 将其解释为对象数组。它违反了 principle of least astonishment。

另一个多行字符串语法

我总是很难记住“|”中的哪一个或 '>' 保留或删除换行符。在某个时候，我意识到，如果从左到右阅读，运算符会告诉您他们如何转换字符串。 '|'两边的高度相同，这意味着字符串也将保持相同的高度；而'>'在右边比左边小，这意味着它将把字符串从多行“压缩”到一行。只是想把那个助记符留在这里给那些还没有发现它的人。

答2:

HuntsBot周刊–不定时分享成功产品案例，学习他们如何成功建立自己的副业–huntsbot.com

使用 yaml 折叠样式。每行的缩进将被忽略。最后将插入一个换行符。

Key: >
This is a very long sentence
that spans several lines in the YAML
but which will be rendered as a string
with only a single carriage return appended to the end.

http://symfony.com/doc/current/components/yaml/yaml_format.html

您可以使用“block chomping indicator”来消除尾随换行符，如下所示：

Key: >-
This is a very long sentence
that spans several lines in the YAML
but which will be rendered as a string
with NO carriage returns.

在任何一种情况下，每个换行符都被一个空格替换。

还有其他可用的控制工具（例如，用于控制缩进）。

请参阅https://yaml-multiline.info/

谢谢，但您不能将此语法用引号括起来，看来：引号在结果字符串中显示为文字。

在我的应用程序中翻译结束后以某种方式添加了回车。这样，Javascript 将其视为多行并失败。 {{- 'key'|trans -}} 也不起作用。

根据我的经验，此语法在字符串末尾附加了一个 n。这可能是也可能不是您正在寻找的。

每个换行符都替换为空格 <-- 但双换行符将是换行符。

@Rvanlaak 和 @rich-remer 使用 block chomper 避免末尾的换行符：>-

答3:

huntsbot.com洞察每一个产品背后的需求与收益，从而捕获灵感

要保留 newlines，请使用 |，例如：

|
This is a very long sentence
that spans several lines in the YAML
but which will be rendered as a string
with newlines preserved.

被翻译为“这是一个非常长的句子‌n，它在 YAML 中跨越了几行‌n，但将呈现为字符串‌n，并保留换行符。n”

这对我来说似乎可以用两条线但不能用三条线？

谢谢，就像你说的那样在那里工作得很好。出于某种原因，在 Pandoc 的 yaml 标头中，我需要在每一行重复 |，原因对我来说并不明显：groups.google.com/forum/#!topic/pandoc-discuss/xuqEmhWgf9A

如果我写：-field1：| 这不是问题吗？一二-field1：|三为'我得到：一n二n和三n？我会考虑 2 之后的 n 不在那里......

当使用带分隔符的多行 cat 时，这会导致将前导空格（YAML 所必需的）添加到输出中。

@Rubytastic 要在 Rails 生成的 HTML 页面中也有这些断行，你需要一些预防措施。我已经在这里回答了：stackoverflow.com/questions/10982706/…

答4:

huntsbot.com汇聚了国内外优秀的初创产品创意，可按收入、分类等筛选，希望这些产品与实践经验能给您带来灵感。

Block Notation(plain, flow-style, scalar)：删除块后换行符变成空格和多余的换行符

---
# Note: It has 1 new line after the string
content:
Arbitrary free text
over multiple lines stopping
after indentation changes...
...

等效的 JSON

{
"content": "Arbitrary free text over multiple lines stopping after indentation changes..."
}

2.文字块标量：文字块标量|将包括换行符和任何尾随空格。但删除了额外的

块后的换行符。

---
# After string we have 2 spaces and 2 new lines
content1: |
Arbitrary free text
over "multiple lines" stopping
after indentation changes...
...

等效的 JSON

{
"content1": "Arbitrary free textnover "multiple lines" stoppingnafter indentation changes...
n"
}

- 带有字面块标量的指标：在块后保留额外的换行符

---
# After string we have 2 new lines
plain: |+
This unquoted scalar
spans many lines.
...

等效的 JSON

{
"plain": "This unquoted scalarnspans many lines.nnn"
}

– 带有字面块标量的指示符： – 表示删除字符串末尾的换行符。

---
# After string we have 2 new lines
plain: |-
This unquoted scalar
spans many lines.
...

等效的 JSON

{
"plain": "This unquoted scalarnspans many lines."
}

5.折叠块标量（>）：

会将换行符折叠到空格，但会在块之后删除额外的换行符。

---
folded_newlines: >
this is really a
single line of text
despite appearances
...

等效的 JSON

{
"fold_newlines": "this is really a single line of text despite appearancesn"
}

如需更多信息，您可以访问我的Blog

您是否打算例如＃4 在冒号后使用“|-”？此外，您可能会在此处丢失“---”指令结束标记，因为您只显示一个文档。文档结束标记有助于突出显示文档中的尾随空格。不过，除此之外，不需要明确的文件。

感谢您指出。那是一个错字。 A已经解决了这个问题。我提供了开始和结束标记，以便每个人都可以看到字符串后面的新行。

Nr.1 在 YAML 规范中被描述为简单的、流式的标量。将其称为块样式具有误导性。

将 Nr.1 更改为普通的流式标量。

无法访问此站点。检查 interviewbubble.com 中是否有错字。 DNS_PROBE_FINISHED_NXDOMAIN。谢谢。 ????

答5:

与HuntsBot一起，探索全球自由职业机会–huntsbot.com

要连接没有空格的长行，请使用双引号并使用反斜杠转义换行符：

key: "Loremipsumdolorsitamet,consecteturadipiscingelit,seddoeiusmodtemp
orincididuntutlaboreetdoloremagnaaliqua."

（感谢@Tobia）

谢谢，这真的帮助我在多行上定义 Docker 卷！如果有人遇到同样的问题，here is my solution on an Online YAML Parser

啊终于。我试图将长 ssh-keys 包装在 Puppet 的 Hiera yaml 文件中的多行，但在我使用您的答案之前总是有不需要的空格。谢谢。

我正在寻找这个答案。这很愚蠢，在 yaml 中没有选择在这种方法中做一些简单的事情。

答6:

huntsbot.com全球7大洲远程工作机会，探索不一样的工作方式

你可能不相信，但是 YAML 也可以做多行键：

?
>
multi
line
key
:
value

huntsbot.com高效搞钱，一站式跟进超10+任务平台外包需求

需要解释（什么是“？”）。

@ilyaigpetrov 完全按照书面“多行”键。通常您会执行 key:value 之类的操作，但如果您的密钥包含换行符，您可以按照上述方式进行操作

有任何真实世界用例的例子吗？

@ilyaigpetrov ? 是关键指示符（如映射中的键）。在许多情况下，您可能会省略键指示符，因为键后面的（必需）值指示符 : 使解析明确。但事实并非如此，您必须使用它来显式标记密钥。

答7:

huntsbot.com聚合了超过10+全球外包任务平台的外包需求，寻找外包任务与机会变的简单与高效。

如果您在 Symfony 中使用 YAML 和 Twig 进行翻译，并希望在 Javascript 中使用多行翻译，则在翻译后立即添加回车。所以即使是下面的代码：

var javascriptVariable = “{{- ‘key’|trans -}}”;

其中有以下 yml 翻译：

key: >
This is a
multi line
translation.

仍然会在 html 中生成以下代码：

var javascriptVariable = "This is a multi line translation.
";

所以，Twig 中的减号并不能解决这个问题。解决方案是在 yml 中的大于号之后添加这个减号：

key: >-
This is a
multi line
translation.

将得到正确的结果，在 Twig 中的一行上进行多行翻译：

var javascriptVariable = "This is a multi line translation.";

这看起来像一个错误。你有机会提交错误报告吗？

答8:

huntsbot.com精选全球7大洲远程工作机会，涵盖各领域，帮助想要远程工作的数字游民们能更精准、更高效的找到对方。

对于字符串可能包含空格或不包含空格的情况，我更喜欢双引号和带有反斜杠的行继续：

key: "String 
with long c
ontent"

但请注意，连续行以空格开头的情况下的陷阱，它需要被转义（因为它将在其他地方被剥离）：

key: "String
 with lon
g content"

如果字符串包含换行符，则需要以 C 样式 n 编写。

另见this question。

如果它在其他地方被剥离，即不在那个位置，您能否用关于它将被剥离的信息更新您的答案。还请写下哪个解析器（针对哪种语言）可以做到这一点？我只看到解析器在适当的位置去除多行引号字符串中的前导/尾随空格。

答9:

huntsbot.com聚合了超过10+全球外包任务平台的外包需求，寻找外包任务与机会变的简单与高效。

在 Jekyll 项目的 YAML 文件中，上述解决方案都不适合我。在尝试了许多选项后，我意识到使用
进行 HTML 注入也可以，因为最终所有内容都呈现为 HTML：

姓名：|在拉曼查村
，我不想
记住它的名字。

至少它对我有用。不知道与此方法相关的问题。

您的解决方案涉及一个不同的问题：在您的情况下，您希望换行符出现在呈现的 HTML 中作为处理 YAML 的结果。 HTML 和 YAML 之间没有隐含的关系。即使 YAML 会通过常规换行符，HTML 也会忽略它们。最终，操作的问题与在 YAML 本身中使用换行符有关，以防止很长的行。它不关心最终如何呈现数据。为什么要讲这个？因为这解释了为什么这里给出的所有其他解决方案都不适用于您的情况。

原文链接：https://www.huntsbot.com/qa/6L7W/how-do-i-break-a-string-in-yaml-over-multiple-lines?lang=zh_CN&from=csdn