如何将含source引用的多份Bash脚本合并为单个脚本？求最佳实践

当然有！把分散的Bash脚本合并成单文件来分发是非常实用的需求，我自己也经常这么处理，这里分享几个经过实践验证的最佳实践：

如果你的脚本文件不多（就像你说的3个），手动合并是最直接的方式，步骤也很简单：

1. 打开你的main.sh，找到开头的source ./common.sh和source ./config.sh命令
2. 把common.sh里的所有内容（去掉开头的#!/bin/bash）直接粘贴到main.sh里替换掉source ./common.sh
3. 同理处理config.sh的内容
4. 最后只保留main.sh开头的一个#!/bin/bash

示例合并后的脚本结构：

#!/bin/bash

# --------------------------
# 来自common.sh的工具函数
# --------------------------
function log_info() {
    echo "[INFO] $(date +'%Y-%m-%d %H:%M:%S'): $1"
}

function error_exit() {
    echo "[ERROR] $1" >&2
    exit 1
}

# --------------------------
# 来自config.sh的配置项
# --------------------------
APP_NAME="my-tool"
LOG_PATH="/var/log/$APP_NAME"
MAX_RETRY=3

# --------------------------
# 来自main.sh的主逻辑
# --------------------------
log_info "Starting $APP_NAME service..."
if [ ! -d "$LOG_PATH" ]; then
    mkdir -p "$LOG_PATH" || error_exit "Failed to create log directory"
fi
# 后续主代码...

这种方式的好处是直观，容易调试，适合文件内容不常变动的场景。

如果你想保留原文件的结构，方便后续单独维护，再定期合并成单文件，可以用eval来内嵌其他文件的内容。具体来说，就是把common.sh和config.sh的内容用单引号包裹，作为字符串传给eval执行：

#!/bin/bash

# 内嵌common.sh的内容
eval '
function log_info() {
    echo "[INFO] $(date +'%Y-%m-%d %H:%M:%S'): $1"
}

function error_exit() {
    echo "[ERROR] $1" >&2
    exit 1
}
'

# 内嵌config.sh的内容
eval '
APP_NAME="my-tool"
LOG_PATH="/var/log/$APP_NAME"
MAX_RETRY=3
'

# 原main.sh的主逻辑
log_info "Starting $APP_NAME service..."
# 后续代码...

这里要注意：如果原文件里有单引号，需要转义成'\''，避免破坏eval的字符串包裹。

如果你的脚本经常迭代更新，手动合并太麻烦，可以写一个小脚本自动完成合并工作。比如写一个merge-scripts.sh：

#!/bin/bash
# 定义输出文件名
OUTPUT_SCRIPT="my-tool.sh"

# 清空输出文件并写入主shebang
echo "#!/bin/bash" > "$OUTPUT_SCRIPT"

# 依次合并common.sh、config.sh、main.sh，跳过各自的shebang行
for script in common.sh config.sh main.sh; do
    echo -e "\n# --------------------------" >> "$OUTPUT_SCRIPT"
    echo "# 来自$script的内容" >> "$OUTPUT_SCRIPT"
    echo "# --------------------------" >> "$OUTPUT_SCRIPT"
    # 过滤掉每个文件的shebang，避免重复
    grep -v "^#!/bin/bash" "$script" >> "$OUTPUT_SCRIPT"
done

# 给合并后的脚本添加执行权限
chmod +x "$OUTPUT_SCRIPT"

echo "合并完成！输出文件：$OUTPUT_SCRIPT"

运行这个脚本后，会自动生成合并好的单文件，还会给每个部分加上注释标注来源，非常方便维护。

• 检查重复定义：合并后要确保三个文件里没有同名的函数或变量，避免覆盖问题。可以用declare -F查看已定义的函数，set查看变量来排查。
• 处理路径问题：原来的脚本如果用了相对路径（比如读取本地配置文件），合并后要确保路径依然有效，最好换成绝对路径，或者让用户通过环境变量指定路径。
• 务必测试：合并后的脚本一定要在目标环境测试，确保功能和分散脚本完全一致，避免因为合并引入隐藏问题。
• 添加版本注释：在合并后的脚本开头加上版本号和合并日期，方便后续追踪更新。

内容的提问来源于stack exchange，提问作者Nice Codes