如何将 heredoc 写入 Bash 脚本中的文件？

Question

如何在 Bash 脚本中将 here 文档写入文件？

Answer 1

阅读高级 Bash 脚本指南Chapter 19. Here Documents。

这是一个将内容写入/tmp/yourfilehere的文件的示例

cat << EOF > /tmp/yourfilehere
These contents will be written to the file.
        This line is indented.
EOF

请注意，最后的 'EOF' (LimitString) 在单词前面不应有任何空格，因为这意味着将无法识别 LimitString。

在 shell 脚本中，您可能希望使用缩进来使代码可读，但是这可能会产生缩进 here 文档中的文本的不良影响。在这种情况下，请使用 <<-（后跟破折号）禁用前导标签（注意，要对此进行测试，您需要将前导空格替换为制表符 ，因为我无法在此处打印实际的制表符。）

#!/usr/bin/env bash

if true ; then
    cat <<- EOF > /tmp/yourfilehere
    The leading tab is ignored.
    EOF
fi

如果你不想解释文本中的变量，那么使用单引号：

cat << 'EOF' > /tmp/yourfilehere
The variable $FOO will not be interpreted.
EOF

通过命令管道传递heredoc：

cat <<'EOF' |  sed 's/a/b/'
foo
bar
baz
EOF

输出：

foo
bbr
bbz

... 或使用sudo 将heredoc 写入文件：

cat <<'EOF' |  sed 's/a/b/' | sudo tee /etc/config_file.conf
foo
bar
baz
EOF

Answer 2

使用 tee 代替 cat 和 I/O 重定向可能会有用：

tee newfile <<EOF
line 1
line 2
line 3
EOF

它更简洁，而且与重定向运算符不同，如果您需要写入具有 root 权限的文件，它可以与 sudo 结合使用。

Answer 3

注意：

• 以下内容浓缩并整理了本主题中的其他答案，尤其是Stefan Lasiewski 和Serge Stroobandt 的出色工作
• Lasiewski 和我推荐Ch 19 (Here Documents) in the Advanced Bash-Scripting Guide

问题（如何将 here 文档（又名 heredoc）写入 bash 脚本中的文件？）具有（至少）3 个主要的独立维度或子问题：

1. 您要覆盖现有文件、追加到现有文件还是写入新文件？
2. 您的用户或其他用户（例如，root）是否拥有该文件？
3. 您是想按字面意思编写heredoc 的内容，还是让bash 解释heredoc 中的变量引用？

（还有其他我认为不重要的维度/子问题。考虑编辑此答案以添加它们！）以下是上面列出的问题维度的一些更重要的组合，以及各种不同的定界标识符 - -EOF 没有什么神圣之处，只要确保您用作分隔标识符的字符串不出现在您的 heredoc 中：

1. 覆盖您拥有的现有文件（或写入新文件），替换 heredoc 中的变量引用：

   cat << EOF > /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   EOF
   

2. 要附加您拥有的现有文件（或写入新文件），替换 heredoc 中的变量引用：

   cat << FOE >> /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   FOE
   

3. 使用 heredoc 的文字内容覆盖您拥有的现有文件（或写入新文件）：

   cat << 'END_OF_FILE' > /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   END_OF_FILE
   

4. 使用 heredoc 的文字内容附加您拥有的现有文件（或写入新文件）：

   cat << 'eof' >> /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   eof
   

5. 要覆盖root拥有的现有文件（或写入新文件），替换heredoc中的变量引用：

   cat << until_it_ends | sudo tee /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   until_it_ends
   

6. 使用 heredoc 的文字内容附加 user=foo 拥有的现有文件（或写入新文件）：

   cat << 'Screw_you_Foo' | sudo -u foo tee -a /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   Screw_you_Foo
   

Answer 4

以@Livven 的answer 为基础，这里有一些有用的组合。

1. 变量替换，保留前导选项卡，覆盖文件，回显到标准输出

   tee /path/to/file <<EOF
   ${variable}
   EOF
   

2. 无变量替换，保留前导选项卡，覆盖文件，回显到标准输出

   tee /path/to/file <<'EOF'
   ${variable}
   EOF
   

3. 变量替换，删除前导标签，覆盖文件，回显到标准输出

   tee /path/to/file <<-EOF
       ${variable}
   EOF
   

4. 变量替换，保留前导标签，附加到文件，回显到标准输出

   tee -a /path/to/file <<EOF
   ${variable}
   EOF
   

5. 变量替换，保留前导选项卡，覆盖文件，不回显到标准输出

   tee /path/to/file <<EOF >/dev/null
   ${variable}
   EOF
   

6. 上面也可以和sudo结合

   sudo -u USER tee /path/to/file <<EOF
   ${variable}
   EOF
   

Answer 5

需要root权限时

当目标文件需要root权限时，使用|sudo tee而不是>：

cat << 'EOF' |sudo tee /tmp/yourprotectedfilehere
The variable $FOO will *not* be interpreted.
EOF

cat << "EOF" |sudo tee /tmp/yourprotectedfilehere
The variable $FOO *will* be interpreted.
EOF

Answer 6

对于未来可能遇到此问题的人，以下格式有效：

(cat <<- _EOF_
        LogFile /var/log/clamd.log
        LogTime yes
        DatabaseDirectory /var/lib/clamav
        LocalSocket /tmp/clamd.socket
        TCPAddr 127.0.0.1
        SelfCheck 1020
        ScanPDF yes
        _EOF_
) > /etc/clamd.conf

Answer 7

作为实例，您可以使用它：

首先（建立 ssh 连接）：

while read pass port user ip files directs; do
    sshpass -p$pass scp -o 'StrictHostKeyChecking no' -P $port $files $user@$ip:$directs
done <<____HERE
    PASS    PORT    USER    IP    FILES    DIRECTS
      .      .       .       .      .         .
      .      .       .       .      .         .
      .      .       .       .      .         .
    PASS    PORT    USER    IP    FILES    DIRECTS
____HERE

第二（执行命令）：

while read pass port user ip; do
    sshpass -p$pass ssh -p $port $user@$ip <<ENDSSH1
    COMMAND 1
    .
    .
    .
    COMMAND n
ENDSSH1
done <<____HERE
    PASS    PORT    USER    IP
      .      .       .       .
      .      .       .       .
      .      .       .       .
    PASS    PORT    USER    IP    
____HERE

第三（执行命令）：

Script=$'
#Your commands
'

while read pass port user ip; do
    sshpass -p$pass ssh -o 'StrictHostKeyChecking no' -p $port $user@$ip "$Script"

done <<___HERE
PASS    PORT    USER    IP
  .      .       .       .
  .      .       .       .
  .      .       .       .
PASS    PORT    USER    IP  
___HERE

Forth（使用变量）：

while read pass port user ip fileoutput; do
    sshpass -p$pass ssh -o 'StrictHostKeyChecking no' -p $port $user@$ip fileinput=$fileinput 'bash -s'<<ENDSSH1
    #Your command > $fileinput
    #Your command > $fileinput
ENDSSH1
done <<____HERE
    PASS    PORT    USER    IP      FILE-OUTPUT
      .      .       .       .          .
      .      .       .       .          .
      .      .       .       .          .
    PASS    PORT    USER    IP      FILE-OUTPUT
____HERE

Answer 8

对于那些寻找纯 bash 解决方案（或需要速度）的人，这里有一个没有 cat 的简单解决方案：

# here-doc tab indented
{ read -r -d '' || printf >file '%s' "$REPLY"; } <<-EOF
        foo bar
EOF

或简单的“mycat”功能（并避免将 REPLY 留在环境中）：

mycat() {
  local REPLY
  read -r -d '' || printf '%s' "$REPLY"
}
mycat >file <<-EOF
        foo bar
EOF

“mycat”与 OS cat 的快速速度比较（我的 OSX 笔记本电脑上 1000 个循环 >/dev/null）：

mycat:
real    0m1.507s
user    0m0.108s
sys     0m0.488s

OS cat:
real    0m4.082s
user    0m0.716s
sys     0m1.808s

注意：mycat 不处理文件参数，它只是处理“将 heredoc 写入文件”的问题

Answer 9

我喜欢这种在缩进脚本中简洁、可读性和演示的方法：

<<-End_of_file >file
→       foo bar
End_of_file

→        是 tab 字符。

Answer 10

如果你想让 heredoc 缩​​进以提高可读性：

$ perl -pe 's/^\s*//' << EOF
     line 1
     line 2
EOF

Bash中支持缩进heredoc的内置方法只支持前导制表符，不支持空格。

Perl 可以替换为 awk 以节省一些字符，但如果您了解基本的正则表达式，Perl 可能更容易记住。