一种 shell 脚本很酷的写法——多行字符串变量

在看 Kubernetes 的文档时，看到一种定义多行字符串作为变量的写法，感觉挺有意思，如下：

kubectl apply -f - <<EOF
apiVersion: v1
kind: Pod
metadata:
  name: private-image-test-1
spec:
  containers:
    - name: uses-private-image
      image: $PRIVATE_IMAGE_NAME
      imagePullPolicy: Always
      command: [ "echo", "SUCCESS" ]
EOF

# Create a secret with several keys from stdin
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  password: $(echo -n "s33msi4" | base64 -w0)
  username: $(echo -n "jane" | base64 -w0)
EOF

看起来很是牛逼的感觉，实际上也避免了一些不必要的文件创建、可以让命令更加地精简。

Here document

Wikipedia 定义

In computing, a here document (here-document, here-text, heredoc, hereis, here-string or here-script) is a file literal or input stream literal:

it is a section of a source code file that is treated as if it were a separate file. The term is also used for a form of multiline string literals that use similar syntax, preserving line breaks and other whitespace (including indentation) in the text.

简单理解

它是一种特殊的表达方式，它本质上是源代码的一部分，但是表现出来像是真的从独立文件里面获取到的一样。

格式：

[n]<<word
    here-document
delimiter

• n 为文件描述符，省略是默认为0，即标准输入；
• word 被引号括住，不解析变量、数据计算等；
• << 不省略 ；<<- 会忽略 。

word 与 delimiter 被称为 here tag，它们之间的文字叫做 here doc。

使用场景示例

下面几种是 here doc 的常见使用模板

多行输出

cat << EOF
heredoc> biubiubiu
heredoc> bala
heredoc> EOF

# 输出
biubiubiu
bala

定义多行变量

sql=$(cat <<EOF
SELECT foo, bar FROM db
WHERE foo='baz'
EOF
)

echo $sql

# 输出
SELECT foo, bar FROM db
WHERE foo='baz'

将多行数据重定向到文件

cat <<EOF > print.sh
#!/bin/bash
echo \$PWD
echo $PWD
EOF

cat print.sh

# 输出
#!/bin/bash
echo $PWD
echo /Users/feiv

将多行数据通过管道传递给后续命令

cat <<EOF | grep 'b' | tee b.txt
foo
bar
baz
EOF

# 输出
bar
baz

思考与尝试

here tag 即常用的 EOF 是只要求前后匹配即可，不一定非得要 EOF，如下：

cat << BALABALA
biubiubiu
bala
BALABALA

# 输出
biubiubiu
bala

关于引号把 word 括起来的效果，可以参考如下示例：

a=0
cat <<EOF
$a
EOF

# 输出
0

#################

a=0
cat <<'EOF'
$a
EOF

# 输出
$a

#################

a=0
cat <<"EOF"
$a
EOF

# 输出
$a

cat 后面其实可以接多个 << word，但目前还未发现其用途，如下：

cat <<eof1; cat <<eof2
Hi,
eof1
Helene.
eof2

Reference

• What is Cat EOF in Bash Script
• How does “cat << EOF” work in bash?
• 2.7.4 Here-Document