如何在Bash中为变量分配heredoc值？

How to assign a heredoc value to a variable in Bash?

我有这个多行字符串(包括引号)：

1
2
3

abc'asdf"
$(dont-execute-this)
foo"bar"''

如何使用bash中的heredoc将其分配给变量？

我需要保留新行。

我不想逃避字符串中的字符，那会很烦人…

相关讨论

您可以避免使用cat，并更好地处理不匹配的引号：

1
2
3
4
5

$ read -r -d '' VAR <<'EOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
EOF

如果在回送变量时不引用它，新行将丢失。引用它可以保护它们：

1
2
3
4

$ echo"$VAR"
abc'asdf"
$(dont-execute-this)
foo"bar"''

如果要在源代码中使用缩进来提高可读性，请在小于号后使用破折号。只能使用制表符(无空格)进行缩进。

1
2
3
4
5
6
7
8
9

$ read -r -d '' VAR <<-'EOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
EOF
$ echo"$VAR"
abc'asdf"
$(dont-execute-this)
foo"bar"''

如果您希望保留结果变量内容中的制表符，则需要从IFS中删除制表符。此处文档(EOF的终端标记不能缩进。

1
2
3
4
5
6
7
8
9

$ IFS='' read -r -d '' VAR <<'EOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
EOF
$ echo"$VAR"
abc'asdf"
$(dont-execute-this)
foo"bar"''

通过按ctrl vbkbd t，可以在命令行插入选项卡。如果您使用的编辑器取决于哪个编辑器，它也可以工作，或者您可能需要关闭自动将制表符转换为空格的功能。

相关讨论

这对于在bash变量中嵌入多行Perl程序非常有用，当与-r选项结合使用时，也可以保留反斜杠。
@特立尼特龙：是的，read几乎应该总是有-r。我忘了把它包括在内了。
@布兰登：谢谢你的夸奖！
我认为值得一提的是，如果您的脚本中有set -o errexit(也就是set -e)，并且您使用它，那么它将终止您的脚本，因为read在到达eof时返回非零返回代码。
@Markbyers：这是我从不使用set -e的原因之一，我总是建议不要使用它。最好使用正确的错误处理。以东十一〔二十四〕是你的朋友。其他朋友：else和||等。
@丹尼斯，我该怎么做，同时包括缩进的制表符？我知道我可以利用空间，但这是可能的吗？
@丹尼斯威廉姆森有没有其他方法可以在read上使用-d参数？我一直在使用一个没有-d选项的环境，但我无法找到任何其他方法让read加载多条线路。
在这种情况下，避免使用cat真的值得吗？用cat将heredoc赋给变量是一个众所周知的习惯用法。不知怎么地，使用read会使事情变得模糊，对我来说没有什么好处。
无聊的。一个试图变得太聪明的人(我)的警告：read -rd'' VAR << EOF不起作用，因为VAR将被解析为分隔符(而heredoc将以$REPLY结束)。
@ulidtko这是因为在d和空字符串之间没有空格；bash在read看到它的参数之前，将-rd''折叠为简单的-rd，所以VAR被视为-d的参数。
@切普纳，正确。我也是这么写的。
在这种格式中，read将返回一个非零的退出代码。这使得该方法在启用了错误检查的脚本(如set -e中)中不太理想。
@瑞士：不应使用set -e——应进行适当的错误检查。
@丹尼斯·威廉姆森(DennisWilliamson)就是一个例子。我的观点是读命令在运行时报告失败。
是否可以使用它并获得变量替换？我想在多行字符串中使用$变量。
@兰登库恩：删除在这里的名字周围的引号。这也将允许对命令替换进行评估，并以我在回答中指出的方式影响空白。
这太慢了，因为shell在这里的文档中每1个字节调用一个read(2)。
为什么执行IFS='' read -r -d '' VAR <<'EOF'后$?==1，即使在行首消耗一个"eof"？有办法解决这个问题吗？
回答我自己的问题，请看这个答案(谢谢@ffledgling)。
虽然我也喜欢trap中的错误，但当您在共享代码库中工作时，更改商定的标准(如#!/bin/bash -eu中的标准)是不礼貌的。所以，我在这个原本很好的答案的结尾加了一个注释。
@布鲁诺布隆斯基：不应该使用set -e。
这些论点是什么意思？我在江户记1〔21〕找不到。例3在我的例子中效果很好。
@Lacostenycoder:man read是关于操作系统函数调用的，因此它不直接应用。在这种情况下，read是bash内置的，您可以使用help read或man bash获得有关它的信息。-r的选项是从字面上接受反斜杠，而不是使用它们来转义任何字符。-d选项将以下参数的第一个字符设置为记录(行)之间的分隔符，而不是默认的换行符。在这个示例中，我将分隔符设置为空字符串。
@丹尼斯威廉姆森太好了，非常感谢！
对于这个另一个美妙的答案，一个小小的提示是：除非IFS=，否则前面/后面的空白行被read选中。

使用$()将cat的输出分配给变量，如下所示：

1
2
3
4
5
6
7
8
9
10
11

VAR=$(cat <<'END_HEREDOC'
abc'asdf"
$(dont-execute-this)
foo"bar"''
END_HEREDOC
)

# this will echo variable with new lines intact
echo"$VAR"
# this will echo variable without new lines (changed to space character)
echo $VAR

确保用单引号分隔起始和结束文档。

注意，结束Heredoc分隔符END_HEREDOC必须单独在行上(因此结束括号在下一行上)。

感谢@ephemient的回答。

相关讨论

这是丹尼斯方法的变体，在脚本中看起来更优雅。

函数定义：

1 2	define(){ IFS=' ' read -r -d '' ${1} \|\| true; }

用途：

1
2
3
4
5
6
7

define VAR <<'EOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
EOF

echo"$VAR"

享受

P.S.为不支持read -d的shell制作了一个"读循环"版本。应该与set -eu和不成对的背景信号一起工作，但测试不太好：

1
2
3

define(){ o=; while IFS="
" read -r a; do o="$o$a"'
'; done; eval"$1=\$o"; }

相关讨论

在此处添加评论作为答案，因为我没有足够的代表点来评论您的问题文本。

There is still no solution that preserves newlines.

这不是真的-你可能只是被回声的行为误导了：

echo $VAR # strips newlines

echo"$VAR" # preserves newlines

相关讨论

1
2
3

VAR=<<END
abc
END

不起作用，因为您正在将stdin重定向到不关心它的内容，即分配

1
2
3
4
5
6

export A=`cat <<END
sdfsdf
sdfsdf
sdfsfds
END
` ; echo $A

有效，但有一个背后的抽搐，可能会阻止你使用这个。另外，您应该避免使用反勾号，最好使用命令替换符号$(..)。

1
2
3
4
5
6

export A=$(cat <<END
sdfsdf
sdfsdf
sdfsfds
END
) ; echo $A

相关讨论

从Neil的答案出发，您通常根本不需要var，您可以以与变量相同的方式使用函数，而且它比内联或基于read的解决方案更容易读取。

1
2
3
4
5
6
7
8
9
10
11
12

$ complex_message() {
cat <<'EOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
EOF
}

$ echo"This is a $(complex_message)"
This is a abc'asdf"
$(dont-execute-this)
foo"bar"''

数组是一个变量，因此在这种情况下，mapfile可以工作

1
2
3
4
5

mapfile y <<z
abc'asdf"
$(dont-execute-this)
foo"bar"''
z

然后你可以这样打印

1	printf %s"${y[@]}"

相关讨论

将HereDoc值赋给变量

1
2
3
4
5
6

VAR="$(cat <<'VAREOF'
abc'asdf"
$(dont-execute-this)
foo"bar"''
VAREOF
)"

用作命令的参数

1
2
3
4
5
6
7

echo"$(cat <<'SQLEOF'
xxx''xxx'xxx'xx 123123 123123
abc'asdf"
$(dont-execute-this)
foo"bar"''
SQLEOF
)"

相关讨论

我发现自己必须读取一个包含空值的字符串，所以这里有一个解决方案，可以读取任何您向它抛出的内容。尽管您实际上处理的是空值，但您需要在十六进制级别处理它。

$cat>读.dd.sh

1
2
3
4
5
6
7
8

read.dd() {
buf=
while read; do
buf+=$REPLY
done < <( dd bs=1 2>/dev/null | xxd -p )

printf -v REPLY '%b' $( sed 's/../ \\\x&/g' <<< $buf )
}

证明：

1
2
3
4
5

$ . read.dd.sh
$ read.dd < read.dd.sh
$ echo -n"$REPLY"> read.dd.sh.copy
$ diff read.dd.sh read.dd.sh.copy || echo"File are different"
$

Heredoc示例(带^J、^M、^I)：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

$ read.dd <<'HEREDOC'
> (TAB)
> (SPACES)
(^J)^M(^M)
> DONE
>
> HEREDOC

$ declare -p REPLY
declare -- REPLY=" (TAB)
(SPACES)
(^M)
DONE

"

$ declare -p REPLY | xxd
0000000: 6465 636c 6172 6520 2d2d 2052 4550 4c59 declare -- REPLY
0000010: 3d22 0928 5441 4229 0a20 2020 2020 2028 =".(TAB). (
0000020: 5350 4143 4553 290a 285e 4a29 0d28 5e4d SPACES).(^J).(^M
0000030: 290a 444f 4e45 0a0a 220a ).DONE

相关讨论

由于dimo414的回答，这显示了他伟大的解决方案是如何工作的，并且显示了文本中也可以轻松地包含引号和变量：

实例输出

1
2
3
4
5
6

$ ./test.sh

The text from the example function is:
Welcome dev: Would you"like" to know how many 'files' there are in /tmp?

There are" 38" files in /tmp, according to the"wc" command

试验室

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

#!/bin/bash

function text1()
{
COUNT=$(\ls /tmp | wc -l)
cat <<EOF

$1 Would you"like" to know how many 'files' there are in /tmp?

There are"$COUNT" files in /tmp, according to the"wc" command

EOF
}

function main()
{
OUT=$(text1"Welcome dev:")
echo"The text from the example function is: $OUT"
}

main

相关讨论

1
2
3
4
5
6
7
8

$TEST="ok"
read MYTEXT <<EOT
this bash trick
should preserve
newlines $TEST
long live perl
EOT
echo -e $MYTEXT

相关讨论