Go 二进制嵌入 Git 提交信息方法
本文介绍如何在Go程序编译时，通过ldflags将Git提交哈希值嵌入到二进制文件中，以便在程序运行时可以方便地查看版本信息，帮助进行问题排查和版本追溯。
本文介绍如何在 Go 程序编译时，通过 ldflags 将 Git 提交哈希值嵌入到二进制文件中，以便在程序运行时可以方便地查看版本信息，帮助进行问题排查和版本追溯。
概述
在软件开发过程中，尤其是部署到生产环境后，快速定位问题往往需要知道当前运行的二进制文件是由哪个版本的代码构建的。将 Git revision 信息嵌入到 Go 二进制文件中，提供了一种便捷的方式来解决这个问题。 ldflags 是 go build 命令的一个选项，允许我们在链接阶段修改变量的值，从而可以在不修改源代码的情况下，将构建时的信息注入到程序中。
具体实现步骤
在 Go 代码中声明版本变量：
首先，需要在 main 包中声明一个字符串类型的变量，用于存储 Git revision 信息。例如：
package main import "fmt" var version string func main() { fmt.Println("Version:", version) }编写 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 变量的值赋给它。
编译并运行程序：
运行 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 二进制文件中，这对于版本管理和问题排查非常有帮助。该方法简单易用，并且不需要修改源代码，是一种推荐的做法。
正软商城本月促销专区，汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动，提供限时折扣、特价授权和优惠购买信息，活动库存及价格以页面实时展示为准。
正软商城装机必备专区，精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件，帮助用户快速完成新电脑软件配置。
正软商城Windows软件专区，汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件，提供软件介绍、系统要求、正版授权及购买下载服务。
正软商城macOS软件专区，精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具，提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。
正软商城iOS软件专区，精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用，提供功能介绍、适用设备、系统要求和正版获取方式等信息。
正软商城AI软件专区，汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具，提供功能介绍、适用平台、收费方式及正版购买信息。
正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法，同时介绍常用PDF软件和工具的使用技巧。
赤友清理大师是一款为 Mac 设计的智能清理优化工具，可精准扫描垃圾、大文件、重复文件等，释放磁盘空间。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件，为私密数据添加多重保护。高频操作更强调就近处理，浏览、整理和跨目录移动文件时，来回切换和重复点击都会少很多。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
