Bash heredoc 的進階用法

在 Linux 系統管理與自動化腳本開發中，我們經常需要將多行文字或命令輸出傳遞給其他程式。雖然 echo 或 printf 能處理簡單的單行輸出，但在處理複雜配置檔生成、SQL 查詢撰寫或動態內容插入時，Here Document（縮寫為 heredoc） 才是真正的主力武器。

許多初學者只知道基本的 cat << EOF 用法，卻忽略了其強大的進階特性。今天我們將深入探討 Bash heredoc 的進階技巧，包括變數展開控制、命令替換以及縮排處理，幫助你寫出更優雅、更高效的 Shell 腳本。

基本回顧與變數展開的控制

最基本的 heredoc 語法如下：

cat << EOF
Hello, $USER
The date is $(date)
EOF

預設情況下，Bash 會對 heredoc 的內容進行參數擴展（Parameter Expansion）和命令替換（Command Substitution）。這意味著 $USER 會被替換為當前使用者名稱，$(date) 會被替換為執行時的日期時間。

然而，在某些場景下，我們希望將變數名稱或命令語法原樣輸出，而不進行展開。這時，只需在分隔符號（如 EOF）前加上單引號 ' 即可禁用擴展：

cat << 'EOF'
Hello, $USER
The date is $(date)
This will not be expanded.
EOF

執行上述程式碼，輸出結果將包含字面上的 $USER 和 $(date)，而非它們的值。這對於生成需要保留原始語法的配置檔（如 SSH 設定、Python 腳本或 LaTeX 文件）至關重要。

動態內容與命令替換的結合

當你需要在 heredoc 中動態插入命令結果時，可以將命令替換直接寫入內容中。這比串接多個 echo 指令來得直觀且易於維護。

以下是一個實際範例，用於生成一份簡單的系統報告：

#!/bin/bash

REPORT_DATE=$(date +"%Y-%m-%d %H:%M:%S")
HOSTNAME=$(hostname)
DISK_USAGE=$(df -h / | awk 'NR==2 {print $5}')

cat << EOF
========================================
       System Status Report
       Date: $REPORT_DATE
       Host: $HOSTNAME
========================================

Current Disk Usage on /: $DISK_USAGE

To generate a full report, run:
    sudo df -h > /var/log/disk_report.txt
    sudo free -m >> /var/log/disk_report.txt
EOF

在這個範例中，我們利用外部變數 $REPORT_DATE 等，並在 heredoc 內部直接使用 $(...) 即時獲取系統資訊。這種方式讓腳本的邏輯結構非常清晰，讀者一眼就能看出哪些部分是動態生成的。

處理縮排：使用 `<<-` 提升程式碼可讀性

當 heredoc 內容較長時，為了保持腳本整體的縮排風格（Indentation），我們通常會在內容前加上 Tab 鍵。然而，預設的 << 會將這些 Tab 視為內容的一部分，導致輸出結果左側多出空白，破壞格式。

Bash 提供了 <<- 運算子，它允許在每一行開頭的 Tab 被忽略。請注意，必須使用 Tab 鍵，而不能是空白字元，此特性才能生效。

#!/bin/bash

config_file="/tmp/test.conf"

# 使用 <<- 來移除行首的 Tab
cat <<- EOF > "$config_file"
    # Configuration File
    server.port=8080
    server.host=0.0.0.0
    debug.enabled=false
EOF

cat "$config_file"

執行後，/tmp/test.conf 的內容不會包含任何行首空白，保持整潔。這項技巧在撰寫大型腳本或函數時，能顯著提升程式碼的可讀性。

常見問題與注意事項

1. 分隔符號必須獨立成行 Heredoc 的結束標記（如 EOF）必須位於行的最前端，不能有任何前置空白（除非使用 <<- 且該空白為 Tab）。如果結束標記前有空格，Bash 會將其視為內容的一部分，導致腳本掛起等待輸入，直到你手動按下 Ctrl+C。

2. 引號的使用時機 許多使用者混淆何時該加引號。簡單的原則：需要動態內容時不加引號，需要靜態文字時加引號。例如，生成 JSON 檔時，若 JSON 中的 key 或 value 包含變數，通常不加引號以展開變數；但若 JSON 結構本身需要保留字串格式，則需謹慎處理引號嵌套，或考慮使用 jq 等工具輔助。