教你如何在C++二進位制檔案中注入git資訊

導讀	這篇文章主要給大家介紹了關於怎麼在C++二進位制檔案中注入git資訊的相關資料,文中透過示例程式碼介紹的非常詳細,需要的朋友可以參考下

在後端生產環境中，為了方便定位問題，我們需要根據一個binary檔案獲取其對應的git資訊，包括編譯出該binary所用的程式碼分支、commitid、時間戳、commit message等。但是隨著程式碼版本的升級，這些git資訊也會隨之變化。有沒有辦法在每次編譯binary的時候，將git資訊動態注入到其中呢？

答案是有！

#pragma once
 
#includenamespace 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;
  };
}

#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@";

#include#include "version.hh"
 
using namespace my_app;
 
int main() {
    std::cout << "building sha1: " << Version::GIT_SHA1 << std::endl;
    std::cout << "building branch: " << Version::GIT_BRANCH << std::endl;
    std::cout << "building date: " << Version::GIT_DATE << std::endl;
    std::cout << "building commit subject: " << Version::GIT_COMMIT_SUBJECT << std::endl;
    return 0;

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資訊的文章就介紹到這了。

原文來自：