HTML CSS JAVASCRIPT JQUERY AI PHP SQL EXCEL LINUX C# C++ C PYTHON JAVA 教程库 参考手册 技术文章 测验 练习 HOWTO FAQ

Bash HereDoc 教程及示例

linuxoperating systemopen source更新于 2026/2/6 9:07:17

如果您是 Linux 或 Unix 用户，您可能对 Bash(一种在这些系统上常用的命令行 Shell)并不陌生。Bash 拥有许多强大的功能，可以显著提升命令行操作效率，其中之一就是"HereDoc"。在本教程中，我们将解释什么是 HereDoc，它是如何工作的，并提供一些示例，说明如何在 Bash 脚本中使用它。

什么是 HereDoc?

HereDoc 是"Here Document"的缩写，是一种在 Bash 脚本中包含文本块的方法。该文本块可以包含任何内容，包括命令、变量和其他特殊字符。 HereDocs 非常有用，因为它们允许您包含大段文本，而无需担心转义特殊字符或处理复杂的引用规则。

以下是 HereDoc 的实际示例 -

cat << EOF
This is a HereDoc example.
It can include multiple lines of text.
EOF

在此示例中，我们使用"cat"命令将一段文本输出到终端。"<< EOF"语法告诉 Bash 以 HereDoc 块开头，而结尾的"EOF"则告诉 Bash 块的结束位置。这两个标记之间的任何内容都包含在 HereDoc 中。

HereDoc 块可以包含任何文本，包括变量、命令和其他特殊字符。以下示例演示了如何使用 HereDoc 将 SQL 查询存储在变量中 -

query=$(cat << EOF
   SELECT *
   FROM users
   WHERE username='john.doe';
   EOF
)

echo "$query"

在本例中，我们使用 HereDoc 将 SQL 查询存储在"query"变量中。然后使用"echo"命令将变量的内容输出到终端。当您需要在脚本中存储大块文本时，这是一种非常有用的技术。

HereDoc 语法

HereDoc 的基本语法如下:

command << EOF
text
EOF

在此语法中，"command"是接收 HereDoc 作为输入的命令，"text"是将包含在 HereDoc 中的文本块。"EOF"标记告诉 Bash HereDoc 的结束位置。

HereDoc 语法非常灵活，可以以多种方式使用。以下是一些示例 -

您可以使用 HereDoc 为命令提供输入，如下所示 -

command << EOF
input
EOF

您可以使用 HereDoc 将文本块赋值给变量，如下所示 -

variable=$(cat << EOF
   text
   EOF
)

您可以使用 HereDoc 创建一个包含文本块的文件，如下所示 -

cat << EOF > file.txt
text
EOF

您可以使用 HereDoc 将文本块附加到文件，如下所示 -

cat << EOF >> file.txt
text
EOF

HereDoc 示例

让我们看一些实际示例，了解如何在 Bash 脚本中使用 HereDoc。

示例 1:使用 HereDoc 创建配置文件

假设您正在编写一个需要从配置文件中读取设置的脚本。您可以使用 HereDoc 在脚本内部生成文件，而无需手动创建文件。以下是示例 -

cat << EOF > config.ini
[server]
host = example.com
port = 80

[database]


name = mydatabase
user = myuser
password = mypassword
EOF

在本例中，我们使用 HereDoc 生成一个名为"config.ini"的配置文件。该文件包含多个部分，包括"服务器"部分和"数据库"部分。每个部分都包含多个键值对，用于定义脚本的设置。

通过使用 HereDoc 生成配置文件，我们可以确保文件始终正确生成并包含所有必要的设置。

示例 2:使用 HereDoc 运行 SQL 脚本

假设您有一个需要在远程服务器上运行的 SQL 脚本。您可以使用 HereDoc 远程运行脚本，而无需将脚本复制到服务器并手动运行。以下是示例 -

ssh user@example.com << EOF
mysql -u myuser -p mypassword < script.sql
EOF

在本例中，我们使用 HereDoc 在远程服务器上运行名为"script.sql"的 SQL 脚本。我们使用"ssh"命令连接到服务器，并使用"<< EOF"语法启动 HereDoc 块。

HereDoc 块包含一个命令"mysql -u myuser -p mypassword < script.sql"，该命令在远程服务器上运行 SQL 脚本。通过使用 HereDoc 远程运行脚本，我们可以避免手动将脚本复制到服务器。

示例 3:使用 HereDoc 生成 HTML 输出

假设您正在编写一个需要生成 HTML 输出的脚本。您可以使用 HereDoc 生成 HTML 代码，而无需手动连接字符串和标签。以下是示例 -

cat << EOF > index.html

<!DOCTYPE html>
<html>
<head>
   <title>My Website</title>
</head>
<body>
   <h1>Welcome to my website</h1>
   <p>This is some sample text.</p>
</body>
</html>
EOF

在此示例中，我们使用 HereDoc 生成一个名为"index.html"的 HTML 文件。该文件包含基本的 HTML 结构，包括标题、页眉和一些示例文本。通过使用 HereDoc 生成 HTML 代码，我们可以确保代码始终正确生成，并包含所有必要的标记。

HereDocs 的其他提示和最佳实践

使用描述性标记

定义 HereDoc 块时，请使用描述性标记，而不仅仅是"EOF"。例如，如果您正在定义 SQL 查询，则可以使用"<< SQL"作为标记。这使代码更具可读性，并有助于避免混淆。

使用单引号

定义 HereDoc 块时，最好使用单引号将标记括起来。这会阻止 Bash 解释块中的任何变量或特殊字符。

使用缩进

定义 HereDoc 块时，最好使用缩进来提高代码的可读性。当块包含多层缩进时，这尤其有用。

使用"-r"选项

从 HereDoc 读取输入时，最好在 read 命令中使用"-r"选项。这可以防止反斜杠被解释为转义字符。

避免使用制表符

定义 HereDoc 块时，避免使用制表符进行缩进。这可能会导致某些命令出现问题，尤其是那些需要以特定方式格式化输入的命令。

在 HereDoc 中使用变量

您可以在 HereDoc 中使用变量，就像在 Bash 脚本的任何其他部分一样。这是一种生成动态内容的强大技术。

将 HereDocs 与其他 Bash 功能结合使用

HereDocs 可以与其他 Bash 功能(例如循环、条件和函数)结合使用。这可以使您的脚本更加强大和灵活。

通过遵循这些技巧和最佳实践，您可以在 Bash 脚本中有效地使用 HereDocs 并充分利用其诸多优势。无论您是生成配置文件、运行远程脚本还是生成 HTML 输出，HereDocs 都可以帮助您提高 Bash 脚本的效率和效果。

结论

在本教程中，我们解释了什么是 HereDoc 以及它在 Bash 中的工作原理。我们还提供了一些示例，展示了如何在 Bash 脚本中使用 HereDocs，包括生成配置文件、远程运行 SQL 脚本以及生成 HTML 输出。

HereDocs 是 Bash 的一项强大功能，可以帮助您编写更高效的脚本。使用 HereDocs，您可以在脚本中包含大段文本，而无需担心特殊字符的转义或复杂的引用规则。所以，如果您是 Bash 用户，一定要尝试一下 HereDocs!

相关文章

有用资源

打印 下一节:Bash if elif else 语句综合教程 ❯❮ 上一节:Bash 导出变量