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

当前位置:

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

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

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

本文目录

    使用 ldflags 在 Go 二进制文件中嵌入 Git Revision 信息

    本文介绍如何在 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 二进制文件中,这对于版本管理和问题排查非常有帮助。该方法简单易用,并且不需要修改源代码,是一种推荐的做法。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

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

    Windows

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

    PDF教程

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

    macOS软件

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

    IOS软件

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

    AI

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

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。