Go 二进制嵌入 Git 提交信息方法

本文介绍如何在 Go 程序编译时，通过 ldflags 将 Git 提交哈希值嵌入到二进制文件中，以便在程序运行时可以方便地查看版本信息，帮助进行问题排查和版本追溯。

概述

在软件开发过程中，尤其是部署到生产环境后，快速定位问题往往需要知道当前运行的二进制文件是由哪个版本的代码构建的。将 Git revision 信息嵌入到 Go 二进制文件中，提供了一种便捷的方式来解决这个问题。 ldflags 是 go build 命令的一个选项，允许我们在链接阶段修改变量的值，从而可以在不修改源代码的情况下，将构建时的信息注入到程序中。

具体实现步骤

1. 在 Go 代码中声明版本变量：

   首先，需要在 main 包中声明一个字符串类型的变量，用于存储 Git revision 信息。例如：

   package main
   
   import "fmt"
   
   var version string
   
   func main() {
       fmt.Println("Version:", version)
   }

2. 编写 Shell 脚本获取 Git revision 并构建：

   接下来，编写一个 Shell 脚本，该脚本会获取当前 Git 仓库的 short commit hash，并使用 go build 命令的 -ldflags 选项将该值赋给 version 变量。

   #!/bin/sh
   VERSION=$(git rev-parse --short HEAD)
   go build -ldflags "-X main.version=$VERSION" main.go

   • git rev-parse --short HEAD: 获取当前 Git 仓库的 short commit hash。
   • -ldflags "-X main.version=$VERSION": 使用 ldflags 选项，-X 标志指定了要修改的变量的包名和变量名，这里是 main.version，并将 VERSION 变量的值赋给它。

3. 编译并运行程序：

   运行 Shell 脚本，编译生成二进制文件。然后运行该二进制文件，你将会看到输出的版本信息。

   ./build.sh  # 假设脚本名为 build.sh
   ./main

   输出类似于：

   Version: a1b2c3d

完整示例

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

注意事项

• 确保在执行 go build 命令之前，你已经在 Git 仓库中，否则 git rev-parse --short HEAD 命令会出错。
• 如果你的 Go 项目使用了 modules，需要确保 main 包的导入路径正确。
• ldflags 选项非常强大，可以用于修改各种变量的值，不仅仅是版本信息。可以根据实际需求进行灵活运用。
• 在 CI/CD 环境中，可以利用环境变量来传递版本信息，避免每次构建都依赖 Git 仓库。 例如： VERSION=$CI_COMMIT_SHORT_SHA go build -ldflags "-X main.version=$VERSION" main.go

总结

通过使用 ldflags，我们可以方便地将 Git revision 信息嵌入到 Go 二进制文件中，这对于版本管理和问题排查非常有帮助。该方法简单易用，并且不需要修改源代码，是一种推荐的做法。