本文将介绍如何将 Git 仓库的当前 commit 信息嵌入到 Go 语言编译的二进制文件中，以便在程序运行时可以方便地查看构建版本信息，从而更好地进行部署后的问题排查。通过 go build 的 -ldflags 选项，可以在编译时动态设置程序中的变量，实现版本信息的注入。
实现方法
核心思路是利用 go build 命令的 -ldflags 参数，在编译时将 Git commit 信息注入到 Go 程序的变量中。
-
定义变量： 首先，在你的 Go 程序的主包 (main package) 中定义一个字符串类型的变量，用于存储 Git commit 信息。例如：
package main import "fmt" var version string func main() { fmt.Println("Version:", version) } 获取 Git Commit 信息： 使用 Git 命令 git rev-parse --short HEAD 获取当前仓库的 commit ID 的简写形式。
-
编译时注入： 在执行 go build 命令时，使用 -ldflags 参数将 Git commit 信息赋值给定义的变量。-ldflags 参数允许我们修改链接器行为，-X 标志用于更新字符串变量的值。
#!/bin/sh VERSION=`git rev-parse --short HEAD` go build -ldflags "-X main.version=$VERSION" myfile.go
这条命令做了以下事情：
- VERSION=\git rev-parse --short HEAD`: 获取当前 Git 仓库的 commit ID 的简写形式，并将其赋值给VERSION` 变量。
- go build -ldflags "-X main.version=$VERSION" myfile.go: 使用 go build 命令编译 myfile.go 文件。
- -ldflags "-X main.version=$VERSION": 传递链接器参数，-X main.version=$VERSION 表示将 main 包中的 version 变量的值设置为 $VERSION 的值（即 Git commit ID）。
-
运行程序： 编译完成后，运行生成的可执行文件，即可看到版本信息。
./myfile
输出类似：
Version: a1b2c3d
完整示例
假设你的 Go 程序文件名为 main.go，包含以下内容：
package main
import "fmt"
var version string
func main() {
fmt.Println("Version:", version)
}创建一个名为 build.sh 的脚本，包含以下内容：
#!/bin/sh VERSION=`git rev-parse --short HEAD` go build -ldflags "-X main.version=$VERSION" main.go
运行 build.sh 脚本：
chmod +x build.sh ./build.sh
运行生成的可执行文件：
./main
输出结果将显示 Git commit 信息。
注意事项
- 确保在执行 go build 命令之前，当前目录是一个 Git 仓库。
- 如果你的变量不在 main 包中，需要相应地修改 -X 标志后面的包名。例如，如果变量 version 在 mypackage 包中，则应使用 -X mypackage.version=$VERSION。
- 可以使用完整的 commit ID (使用 git rev-parse HEAD)，也可以使用 commit ID 的简写形式 (使用 git rev-parse --short HEAD)，根据需要选择。
- 这种方法在编译时将版本信息硬编码到二进制文件中，因此每次修改代码后都需要重新编译才能更新版本信息。
总结
通过 -ldflags 参数，我们可以方便地将 Git commit 信息嵌入到 Go 编译的二进制文件中，方便在程序运行时查看版本信息，从而更好地进行部署后的问题排查。这种方法简单易用，适用于大多数 Go 项目。
