展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > Git 提交信息嵌入 Go 二进制方法

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

本教程介绍如何将Git仓库的当前commit信息嵌入到Go语言编译的二进制文件中,以便在程序运行时可以方便地查看构建版本信息,从而更好地进行部署后的问题排查。通过gobuild的-ldflags选项,可以在编译时动态设置程序中的变量,实现版本信息的注入。

将 Git Revision 信息添加到 Go 编译的二进制文件中

本文将介绍如何将 Git 仓库的当前 commit 信息嵌入到 Go 语言编译的二进制文件中,以便在程序运行时可以方便地查看构建版本信息,从而更好地进行部署后的问题排查。通过 go build 的 -ldflags 选项,可以在编译时动态设置程序中的变量,实现版本信息的注入。

实现方法

核心思路是利用 go build 命令的 -ldflags 参数,在编译时将 Git commit 信息注入到 Go 程序的变量中。

  1. 定义变量: 首先,在你的 Go 程序的主包 (main package) 中定义一个字符串类型的变量,用于存储 Git commit 信息。例如:

    package main
    
    import "fmt"
    
    var version string
    
    func main() {
        fmt.Println("Version:", version)
    }
  2. 获取 Git Commit 信息: 使用 Git 命令 git rev-parse --short HEAD 获取当前仓库的 commit ID 的简写形式。

  3. 编译时注入: 在执行 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)。
  4. 运行程序: 编译完成后,运行生成的可执行文件,即可看到版本信息。

    ./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 项目。

本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。