如何在 Go 二进制中嵌入并执行 Bash 脚本

go 1.16+ 支持 `embed` 包,可将 bash 脚本以字符串形式编译进二进制;配合 `exec.command("bash")` 并设置 `stdin`,即可直接执行嵌入脚本,无需外部文件依赖,完美支持跨平台编译。

在 Go 程序中调用外部 Bash 脚本时,若希望构建完全自包含的静态二进制(尤其在跨平台交叉编译场景下),传统方式(如读取磁盘上的 .sh 文件)会引入部署耦合与路径风险。Go 1.16 引入的 embed 包为此提供了优雅解法:将脚本内容直接编译进二进制,零运行时依赖。

✅ 基础用法:嵌入并执行

利用 embed 可将任意文本文件(包括 .sh)声明为 string 或 []byte 类型变量。关键在于:Bash 支持从标准输入读取脚本(bash

package main

import (
    "embed"
    "fmt"
    "os/exec"
    "strings"
)

//go:embed script.sh
var script string // 自动嵌入同目录下的 script.sh 内容

func main() {
    cmd := exec.Command("bash")
    cmd.Stdin = strings.NewReader(script)

    output, err := cmd.Output()
    if err != nil {
        fmt.Printf("执行失败: %v\n", err)
        return
    }
    fmt.Println(string(output))
}

? 注意://go:embed 指令前需有空行,且 embed 包必须显式导入(即使未直接使用,_ "embed" 亦可,但推荐 import "embed" 以明确语义)。

✅ 进阶技巧:向脚本传参

若需动态传递参数(如路径、标志),可改用 sh -s - 模式:-s 表示从 stdin 读脚本,- 后的参数将作为 $1, $2 等位置参数供脚本使用:

package main

import (
    "fmt"
    "os/exec"
    "strings"
)

func main() {
    // 执行时 $1="foo", $2="/tmp"
    cmd := exec.Command("sh", "-s", "-", "foo", "/tmp")
    cmd.Stdin = strings.NewReader(`
echo "参数1: $1, 参数2: $2"
ls -l "$2"
`)

    out, err := cmd.Output()
    if err != nil {
        fmt.Printf("错误: %v\n", err)
        return
    }
    fmt.Print(string(out))
}

此方式比拼接字符串更安全,避免 shell 注入风险(参数由 exec.Command 安全转义)。

⚠️ 注意事项与最佳实践

  • 兼容性:embed 仅支持 Go 1.16+;若需旧版本支持,可用 go:generate + stringer 预处理脚本为 const 字符串。
  • 脚本调试:开发期建议保留独立 .sh 文件,并用 os.ReadFile 临时加载,便于快速迭代;发布前切回 embed。
  • Shell 选择:示例使用 bash,但生产环境推荐 sh(POSIX 兼容性更好)。若脚本含 bash 特有语法(如 [[ ]]、source),请确保目标系统存在 bash,或改用 #!/usr/bin/env bash + exec.Command("/usr/bin/env", "bash", "-s")。
  • 错误处理:务必检查 cmd.Run() 或 cmd.Output() 的返回错误,bash 退出码非 0 时 err 不为 nil,但 Output() 仍可能返回部分输出。

通过 embed + exec 组合,你获得了一个轻量、可靠、可移植的“脚本容器”模式——既保有 Bash 的灵活性,又享受 Go 二进制的分发便利。