教你如何在C++二进制文件中注入git信息

75次阅读

共计 2376 个字符，预计需要花费 6 分钟才能阅读完成。

导读	这篇文章主要给大家介绍了关于怎么在 C ++ 二进制文件中注入 git 信息的相关资料, 文中通过示例代码介绍的非常详细, 需要的朋友可以参考下

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

答案是有！

创建以下几个文件

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

#pragma once
 
#include 
 
namespace my_app
{
  struct Version
  {
    static const std::string GIT_SHA1;
    static const std::string GIT_BRANCH;
    static const std::string GIT_DATE;
    static const std::string GIT_COMMIT_SUBJECT;
  };
}

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

#include "version.hh"
 
using namespace my_app;
 
const std::string Version::GIT_SHA1 = "@GIT_SHA1@";
const std::string Version::GIT_BRANCH = "@GIT_BRANCH@";
const std::string Version::GIT_DATE = "@GIT_DATE@";
const std::string Version::GIT_COMMIT_SUBJECT = "@GIT_COMMIT_SUBJECT@";

创建 main.cc

#include 
#include "version.hh"
 
using namespace my_app;
 
int main() {std::cout

创建 CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project (inject_git)
set(GIT_EXECUTABLE /usr/bin/git)
 
# 执行 git rev-parse HEAD, 生成 commitid, 将结果保存于变量 GIT_SHA1
execute_process(COMMAND
  "${GIT_EXECUTABLE}" rev-parse HEAD
  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  OUTPUT_VARIABLE GIT_SHA1
  ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
 
# 执行 git rev-parse --abbrev-ref HEAD, 生成 branch name, 将结果保存于变量 GIT_BRANCH
execute_process(COMMAND
  "${GIT_EXECUTABLE}" rev-parse --abbrev-ref HEAD
  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  OUTPUT_VARIABLE GIT_BRANCH
  ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
 
 
# 执行 git log -1 --format=%ad --date=local, 生成提交日期, 将结果保存于变量 GIT_DATE
execute_process(COMMAND
  "${GIT_EXECUTABLE}" log -1 --format=%ad --date=local
  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  OUTPUT_VARIABLE GIT_DATE
  ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
 
# 执行 git log -1 --format=%s, 生成提交日志, 将结果保存于变量 GIT_COMMIT_SUBJECT
execute_process(COMMAND
  "${GIT_EXECUTABLE}" log -1 --format=%s
  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
  OUTPUT_VARIABLE GIT_COMMIT_SUBJECT
  ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
 
# 上述变量初始化后，将其注入到模板文件 version.cc.in 中，生成 version.cc
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/version.cc.in" "${CMAKE_CURRENT_BINARY_DIR}/version.cc" @ONLY)
 
set(SOURCES
    main.cc
      version.cc
)
 
# 由 version.cc 和 main.cc 生成二进制
add_executable(inject_git ${SOURCES})

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

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

到此这篇关于怎么在 C ++ 二进制文件中注入 git 信息的文章就介绍到这了。