怎么在C++二進制文件中注入git信息詳解

更新時間：2021年06月27日 14:17:20 作者：后端技術小屋

這篇文章主要給大家介紹了關于怎么在C++二進制文件中注入git信息的相關資料,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下

在后端生產環(huán)境中，為了方便定位問題，我們需要根據一個binary文件獲取其對應的git信息，包括編譯出該binary所用的代碼分支、commitid、時間戳、commit message等。但是隨著代碼版本的升級，這些git信息也會隨之變化。有沒有辦法在每次編譯binary的時候，將git信息動態(tài)注入到其中呢？

答案是有！

創(chuàng)建以下幾個文件

創(chuàng)建頭文件version.hh，內容如下，其中聲明了表示git信息的數據結構

#pragma once

#include <string>

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;
  };
}

創(chuàng)建模板文件，version.cc.in，其中定義了Version中靜態(tài)變量的值。其中@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@";

創(chuàng)建main.cc

#include <iostream>
#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;

創(chuàng)建CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project (inject_git)
set(GIT_EXECUTABLE /usr/bin/git)

# 執(zhí)行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)

# 執(zhí)行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)


# 執(zhí)行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)

# 執(zhí)行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})

二進制文件執(zhí)行結果如下：

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

總結

到此這篇關于怎么在C++二進制文件中注入git信息的文章就介紹到這了,更多相關C++二進制注入git信息內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

Linux下C語言的幾道經典面試題小結(分享)
下面小編就為大家?guī)硪黄狶inux下C語言的幾道經典面試題小結(分享)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-05-05
C語言排序算法之冒泡排序實現(xiàn)方法【改進版】
這篇文章主要介紹了C語言排序算法之冒泡排序實現(xiàn)方法,結合具體實例形式分析了C語言實現(xiàn)的基本冒泡排序實現(xiàn)方法及增設flag標志位的改進型算法,需要的朋友可以參考下
2017-09-09
先序遍歷二叉樹的遞歸實現(xiàn)與非遞歸實現(xiàn)深入解析
以下是對先序遍歷二叉樹的遞歸實現(xiàn)與非遞歸實現(xiàn)進行了詳細的分析介紹，需要的朋友可以過來參考下
2013-07-07
C++實現(xiàn)基于不相交集合的O(mlgn)復雜度的kruskal算法
這篇文章主要為大家詳細介紹了C++如何實現(xiàn)基于不相交集合的O(mlgn)復雜度的kruskal算法，文中的示例代碼講解詳細，感興趣的小伙伴可以了解一下
2023-02-02
C++實現(xiàn)與Lua相互調用的示例詳解
這篇文章主要為大家詳細介紹了C++實現(xiàn)與Lua相互調用的方法，文中的示例代碼講解詳細，具有一定的學習價值，感興趣的小伙伴可以了解一下
2023-03-03
C++編程異常處理中try和throw以及catch語句的用法
這篇文章主要介紹了C++編程異常處理中try和throw以及catch語句的用法,包括對Catch塊的計算方式的介紹,需要的朋友可以參考下
2016-01-01
詳解C++ 重載運算符和重載函數
這篇文章主要介紹了C++ 重載運算符和重載函數的的相關資料，文中示例代碼非常詳細，幫助大家更好的理解和學習，感興趣的朋友可以了解下
2020-07-07
一文詳解C語言char類型中的存儲
C語言中的char是用于聲明單個字符的關鍵字,這篇文章主要給大家介紹了關于C語言char類型中存儲的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下
2023-01-01
C++嵌入式內存管理詳情
這篇文章主要介紹了C++嵌入式內存管理，是對上一篇內存的一個補充，主要講解Linux中的內存；這部分對于一些端側部署的伙伴來說比較重要，推薦針對不同的板子，下面來看看詳細內容吧,需要的朋友可以參考一下
2021-12-12
C++實現(xiàn)歸并排序算法
這篇文章主要為大家詳細介紹了C++實現(xiàn)歸并排序算法，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2020-03-03