经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 软件/图像 » Git » 查看文章
怎么在C++二进制文件中注入git信息详解
来源:jb51  时间:2021/6/28 9:09:34  对本文有异议

在后端生产环境中,为了方便定位问题,我们需要根据一个binary文件获取其对应的git信息,包括编译出该binary所用的代码分支、commitid、时间戳、commit message等。但是随着代码版本的升级,这些git信息也会随之变化。有没有办法在每次编译binary的时候,将git信息动态注入到其中呢?

答案是有!

创建以下几个文件

创建头文件version.hh,内容如下,其中声明了表示git信息的数据结构

  1. #pragma once
  2.  
  3. #include <string>
  4.  
  5. namespace my_app
  6. {
  7. struct Version
  8. {
  9. static const std::string GIT_SHA1;
  10. static const std::string GIT_BRANCH;
  11. static const std::string GIT_DATE;
  12. static const std::string GIT_COMMIT_SUBJECT;
  13. };
  14. }

创建模板文件,version.cc.in,其中定义了Version中静态变量的值。其中@XX@表示该变量通过cmake注入
#include "version.hh"

  1. #include "version.hh"
  2.  
  3. using namespace my_app;
  4.  
  5. const std::string Version::GIT_SHA1 = "@GIT_SHA1@";
  6. const std::string Version::GIT_BRANCH = "@GIT_BRANCH@";
  7. const std::string Version::GIT_DATE = "@GIT_DATE@";
  8. const std::string Version::GIT_COMMIT_SUBJECT = "@GIT_COMMIT_SUBJECT@";

创建main.cc

  1. #include <iostream>
  2. #include "version.hh"
  3.  
  4. using namespace my_app;
  5.  
  6. int main() {
  7. std::cout << "building sha1: " << Version::GIT_SHA1 << std::endl;
  8. std::cout << "building branch: " << Version::GIT_BRANCH << std::endl;
  9. std::cout << "building date: " << Version::GIT_DATE << std::endl;
  10. std::cout << "building commit subject: " << Version::GIT_COMMIT_SUBJECT << std::endl;
  11. return 0;

创建CMakeLists.txt

  1. cmake_minimum_required(VERSION 3.5)
  2. project (inject_git)
  3. set(GIT_EXECUTABLE /usr/bin/git)
  4.  
  5. # 执行git rev-parse HEAD, 生成commitid, 将结果保存于变量GIT_SHA1
  6. execute_process(COMMAND
  7. "${GIT_EXECUTABLE}" rev-parse HEAD
  8. WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  9. OUTPUT_VARIABLE GIT_SHA1
  10. ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
  11.  
  12. # 执行git rev-parse --abbrev-ref HEAD, 生成branch name, 将结果保存于变量GIT_BRANCH
  13. execute_process(COMMAND
  14. "${GIT_EXECUTABLE}" rev-parse --abbrev-ref HEAD
  15. WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  16. OUTPUT_VARIABLE GIT_BRANCH
  17. ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
  18.  
  19.  
  20. # 执行git log -1 --format=%ad --date=local, 生成提交日期, 将结果保存于变量GIT_DATE
  21. execute_process(COMMAND
  22. "${GIT_EXECUTABLE}" log -1 --format=%ad --date=local
  23. WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  24. OUTPUT_VARIABLE GIT_DATE
  25. ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
  26.  
  27. # 执行git log -1 --format=%s, 生成提交日志, 将结果保存于变量GIT_COMMIT_SUBJECT
  28. execute_process(COMMAND
  29. "${GIT_EXECUTABLE}" log -1 --format=%s
  30. WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  31. OUTPUT_VARIABLE GIT_COMMIT_SUBJECT
  32. ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
  33.  
  34. # 上述变量初始化后,将其注入到模板文件version.cc.in中,生成version.cc
  35. configure_file("${CMAKE_CURRENT_SOURCE_DIR}/version.cc.in" "${CMAKE_CURRENT_BINARY_DIR}/version.cc" @ONLY)
  36.  
  37. set(SOURCES
  38. main.cc
  39. version.cc
  40. )
  41.  
  42. # 由version.cc和main.cc生成二进制
  43. add_executable(inject_git ${SOURCES})

二进制文件执行结果如下:

  1. $ ./inject_git
  2. building sha1: 74b25fc30d18001f72ec0cf0495165441df40a09
  3. building branch: master
  4. building date: Fri May 28 14:49:16 2021
  5. building commit subject: add again

总结

到此这篇关于怎么在C++二进制文件中注入git信息的文章就介绍到这了,更多相关C++二进制注入git信息内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue!

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号