在后端生产环境中,为了方便定位问题,我们需要根据一个binary文件获取其对应的git信息,包括编译出该binary所用的代码分支、commitid、时间戳、commit message等。但是随着代码版本的升级,这些git信息也会随之变化。有没有办法在每次编译binary的时候,将git信息动态注入到其中呢?答案是有!
% F) x4 R2 o! J 创建以下几个文件,创建头文件version.hh,内容如下,其中声明了表示git信息的数据结构:. D2 |0 @& _, R0 X& i( I Y( M
- #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;
- };
- }
创建模板文件,version.cc.in,其中定义了Version中静态变量的值。其中@XX@表示该变量通过cmake注入: ' k0 o! S: T; \
#include "version.hh"
4 N8 I5 N8 w$ H- #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
7 g `' d2 ^6 m8 |- #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;
创建CMakeLists.txt ) l0 C7 H# n8 d. h% g! M, `
- 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})
二进制文件执行结果如下:
" s8 o6 J9 q6 A% I6 w" O4 d. O$ ./inject_git ' ]' N, @7 ^& E. r5 u
building sha1: 74b25fc30d18001f72ec0cf0495165441df40a09
; S( Q0 ~# z2 s) C+ m! Ybuilding branch: master
3 ^ {* I# D0 |' |- G4 v8 bbuilding date: Fri May 28 14:49:16 2021% ?5 x/ t" J% K
building commit subject: add again |