讲师中心 微信公众号
AI工具推荐 视频效率加速

C++怎么在编译期将Git Commit ID自动写入可执行文件

星杰大大_9463

星杰大大_9463

发布时间:2026-10-21 08:33:10

|

898人浏览过

|

来源于php中文网

原创

最可靠方式是编译时用 git describe 生成版本字符串,如 v1.2.0-5-gabc1234,配合 --always --dirty --abbrev=8 参数确保无 tag 或有修改时仍能输出有效标识,并通过 CMake 的 execute_process 在构建时动态获取并注入 GIT_VERSION 宏。

c++怎么在编译期将git commit id自动写入可执行文件

编译时用 git describe 生成版本字符串最可靠

直接读取 .git/HEAD 或 .git/refs/heads/* 文件风险高:工作区可能处于分离头状态、子模块未更新、或仓库被裁剪(如 CI 中用 git clone --depth=1)。git describe 能稳定输出带最近 tag 的短哈希(如 v1.2.0-5-gabc1234),且加 --always --dirty 后,即使没 tag 或有未提交变更也能 fallback 到纯哈希 + -dirty 标记。

实操建议:

  • 在构建脚本(CMake / Makefile)中执行:git describe --always --dirty --abbrev=8 2>/dev/null || echo unknown
  • 把结果存为预处理器宏,例如 CMake 中:add_compile_definitions(GIT_VERSION=\"${GIT_VER}\")
  • 确保源码树根目录存在 .git(CI 中别用 git archive 打包,它不带 Git 元数据)

CMake 中用 execute_process 捕获 Git 输出并注入宏

CMake 是主流选择,但要注意命令执行时机和缓存问题:若只在 configure 阶段运行一次,后续 git commit 后不会自动重触发,导致版本号 stale。必须让 CMake 检测 .git 目录变动,或每次 build 都重新获取。

推荐写法(CMakeLists.txt 片段):

立即学习“C++免费学习笔记(深入)”;

execute_process(
  COMMAND git describe --always --dirty --abbrev=8
  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
  OUTPUT_VARIABLE GIT_VERSION
  OUTPUT_STRIP_TRAILING_WHITESPACE
  ERROR_QUIET
)
if(NOT GIT_VERSION)
  set(GIT_VERSION "unknown")
endif()
add_compile_definitions(GIT_VERSION="${GIT_VERSION}")

关键点:

YiHui GIT MONITOR
YiHui GIT MONITOR

通用Git项目监控工具,支持GitHub、GitLab、Gitee等所有平台,自动检测、添加/删除仓库更新并生成变更摘要。

下载
  • 必须加 WORKING_DIRECTORY,否则在子目录构建时可能找不到 .git
  • ERROR_QUIET 防止 git 命令失败时 CMake 报错中断
  • 不要用 set(GIT_VERSION ... CACHE ...),否则不会随 git 状态变化而更新

在 C++ 代码里安全引用 GIT_VERSION 宏

宏展开后是字符串字面量,但若用户提交时含双引号、反斜杠或换行(极少见但可能),直接拼进宏会导致编译失败。不能假设输入干净。

稳妥做法:

  • 用 shell 脚本预处理:把 git describe 结果用 printf %q 转义,再喂给 CMake
  • 更简单的是在 C++ 侧用 constexpr 函数做运行时校验(虽无必要,但防呆)
  • 定义方式统一用:extern const char* const kGitVersion = GIT_VERSION;,避免宏在 printf 中被误展开

示例使用:

extern const char* const kGitVersion = GIT_VERSION;
// …
std::cout << "Built from git: " << kGitVersion << "\n";

静态链接下 .rodata 段可查,但 strip 会清空

写入的版本字符串最终落在二进制的只读数据段,可用 strings ./myapp | grep ^v 或 readelf -p .rodata ./myapp 验证。但注意:strip 默认会删掉所有符号和调试段,.rodata 中的字符串常量通常保留——除非你用了 --strip-all 或链接时加 -Wl,--strip-all,这时字符串也会消失。

验证是否残留的方法:

  • 构建后立即运行:strings ./myapp | grep -E '^[a-f0-9]{7,}'
  • 如果用 objcopy --strip-unneeded,它比 strip 温和,一般保留 .rodata
  • 发布前务必在目标环境(如容器内)实际检查二进制,别只信本地开发机结果

Git ID 看似只是个字符串,但一旦涉及自动化发布、故障回溯或灰度标记,它就变成不可信输入——从生成、注入、到落盘,每一步都可能静默失效。最常被忽略的是 CI 环境的 shallow clone 和权限限制,得亲手在 runner 里跑一遍 git describe 看输出才踏实。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2248

2024.03.14

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

1019

2024.03.14

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

447

2024.03.14

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

327

2024.03.14

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

406

2024.03.14

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

580

2024.03.14

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

1409

2024.03.21

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

1217

2024.03.22

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Libclang tutorial
Libclang tutorial

共0课时 | 0人学习

vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn