給Go程式加入編譯版本時間等資訊-有解無憂

先看效果

$./myapp -v
GitCommitLog=d97d098e5bb4ad38a2a7968f273a256e10a0108f mod bininfo comment
GitStatus=cleanly
BuildTime=2019.10.26.194341
GoVersion=go version go1.13 darwin/amd64
runtime=darwin/amd64

myapp 是一個演示用的 demo 程式，輸入 -v 引數運行時，列印出程式的一些資訊，以上資訊對應的說明如下：

# GitCommitLog
  d97d098e5bb4ad38a2a7968f273a256e10a0108f: 原始碼最近一次 commit 的 sha 值
  mod bininfo comment: 原始碼最近一次 commit 的描述資訊
# GitStatus
  cleanly: 表示本地代碼相對于最近一次 commit，并沒有任何修改
  如果本地代碼有修改，此處會顯示修改過的檔案
# BuildTime
  2019.10.26.194341: 程式的編譯時間為2019年10月26號19點43分41秒
# GoVersion
  go version go1.13 darwin/amd64: 程式編譯使用的 Go 版本為1.13，darwin 即 macos
# runtime
  程式運行時的平臺，因為 Go 的跨平臺編譯做的比較好，為了避免混淆，我
  們在 GoVersion 列印了編譯平臺的同時，把運行平臺也列印出來

ok，下面就來介紹是如何實作的，

依賴的知識點

Go 語言編譯時，可以通過 go build -ldflags 的方式向程式中指定的包中的變數傳遞值，

拿下面這個十來行的程式做個演示：

package main

import "fmt"

var Foo string

func main() {
	if Foo == "" {
		fmt.Println("Foo is empty.")
	} else {
		fmt.Printf("Foo=%s\n", Foo)
	}
}

如果直接使用 go build 編譯，運行的結果是 Foo is empty.，

如果使用 go build -ldflags "-X 'main.Foo=test'" 編譯，則運行的結果為 Foo=test，它的格式為 -X '<包名>.<變數名>=<值>'

編譯期將感興趣的資訊傳入程式中

通過上面這種手法，我們可以撰寫一個用于編譯 Go 程式的 shell 腳本，在腳本中獲取一些編譯時期的資訊，傳遞到程式中，

比如：

# 獲取原始碼最近一次 git commit log，包含 commit sha 值，以及 commit message
GitCommitLog=`git log --pretty=oneline -n 1`
# 檢查原始碼在最近一次 git commit 基礎上，是否有本地修改，且未提交的檔案
GitStatus=`git status -s`
# 獲取當前時間
BuildTime=`date +'%Y.%m.%d.%H%M%S'`
# 獲取Go的版本
BuildGoVersion=`go version`

# 之后將上面這些變數傳遞到 go build -ldflags 中，編譯 Go 程式，
# 完整的 shell 腳本地址后文有，

更進一步

其實前面也提到， Go 不僅僅支持在編譯時向 main 包中的變數傳遞值，也支持向非 main 包傳遞，

基于以上前提，為了以后寫不同應用程式時，減少模板代碼的拷貝，我專門寫了一個 package （package bininfo github地址），代碼如下：

package bininfo

import (
	"fmt"
	"runtime"
	"strings"
)

var (
	// 初始化為 unknown，如果編譯時沒有傳入這些值，則為 unknown
	GitCommitLog   = "unknown"
	GitStatus      = "unknown"
	BuildTime      = "unknown"
	BuildGoVersion = "unknown"
)

// 回傳單行格式
func StringifySingleLine() string {
	return fmt.Sprintf("GitCommitLog=%s. GitStatus=%s. BuildTime=%s. GoVersion=%s. runtime=%s/%s.",
		GitCommitLog, GitStatus, BuildTime, BuildGoVersion, runtime.GOOS, runtime.GOARCH)
}

// 回傳多行格式
func StringifyMultiLine() string {
	return fmt.Sprintf("GitCommitLog=%s\nGitStatus=%s\nBuildTime=%s\nGoVersion=%s\nruntime=%s/%s\n",
		GitCommitLog, GitStatus, BuildTime, BuildGoVersion, runtime.GOOS, runtime.GOARCH)
}

// 對一些值做美化處理
func beauty() {
	if GitStatus == "" {
		// GitStatus 為空時，說明本地原始碼與最近的 commit 記錄一致，無修改
		// 為它賦一個特殊值
		GitStatus = "cleanly"
	} else {
		// 將多行結果合并為一行
		GitStatus = strings.Replace(strings.Replace(GitStatus, "\r\n", " |", -1), "\n", " |", -1)
	}
}

func init() {
	beauty()
}

然后我們用一個 demo 程式 myapp.go 來演示如何使用，代碼如下：

package main

import (
	"flag"
	"fmt"
	"os"

	"github.com/q191201771/naza/pkg/bininfo"
)

func main() {
	v := flag.Bool("v", false, "show bin info")
	flag.Parse()
	if *v {
		_, _ = fmt.Fprint(os.Stderr, bininfo.StringifyMultiLine())
		os.Exit(1)
	}

	fmt.Println("my app running...")
	fmt.Println("bye...")
}

最后，是我們的 build.sh 腳本，原始碼如下：

#!/usr/bin/env bash

set -x

# 獲取原始碼最近一次 git commit log，包含 commit sha 值，以及 commit message
GitCommitLog=`git log --pretty=oneline -n 1`
# 將 log 原始字串中的單引號替換成雙引號
GitCommitLog=${GitCommitLog//\'/\"}
# 檢查原始碼在git commit 基礎上，是否有本地修改，且未提交的內容
GitStatus=`git status -s`
# 獲取當前時間
BuildTime=`date +'%Y.%m.%d.%H%M%S'`
# 獲取 Go 的版本
BuildGoVersion=`go version`

# 將以上變數序列化至 LDFlags 變數中
LDFlags=" \
    -X 'github.com/q191201771/naza/pkg/bininfo.GitCommitLog=${GitCommitLog}' \
    -X 'github.com/q191201771/naza/pkg/bininfo.GitStatus=${GitStatus}' \
    -X 'github.com/q191201771/naza/pkg/bininfo.BuildTime=${BuildTime}' \
    -X 'github.com/q191201771/naza/pkg/bininfo.BuildGoVersion=${BuildGoVersion}' \
"

ROOT_DIR=`pwd`

# 如果可執行程式輸出目錄不存在，則創建
if [ ! -d ${ROOT_DIR}/bin ]; then
  mkdir bin
fi

# 編譯多個可執行程式
cd ${ROOT_DIR}/demo/add_blog_license && go build -ldflags "$LDFlags" -o ${ROOT_DIR}/bin/add_blog_license &&
cd ${ROOT_DIR}/demo/add_go_license && go build -ldflags "$LDFlags" -o ${ROOT_DIR}/bin/add_go_license &&
cd ${ROOT_DIR}/demo/taskpool && go build -ldflags "$LDFlags" -o ${ROOT_DIR}/bin/taskpool &&
cd ${ROOT_DIR}/demo/slicebytepool && go build -ldflags "$LDFlags" -o ${ROOT_DIR}/bin/slicebytepool &&
cd ${ROOT_DIR}/demo/myapp && go build -ldflags "$LDFlags" -o ${ROOT_DIR}/bin/myapp &&
ls -lrt ${ROOT_DIR}/bin &&
cd ${ROOT_DIR} && ./bin/myapp -v &&
echo 'build done.'

寫在最后

本文中的 package bininfo，編譯腳本，示例代碼都在我的 github 專案 naza (https://github.com/q191201771/naza) 中，

這個倉庫包含了我平時學習 Go 練手寫的一些基礎庫代碼，有些已經在我的線上服務中使用了，后續我還會寫一些文章介紹這個倉庫中的其他包，

感謝閱讀，如果覺得文章還不錯的話，順手給我的 github 專案來個 star 就更好啦， ??

原文鏈接： https://pengrl.com/p/37397/
原文出處： yoko blog (https://pengrl.com)
原文作者： yoko
著作權宣告： 本文歡迎任何形式轉載，轉載時完整保留本宣告資訊（包含原文鏈接、原文出處、原文作者、著作權宣告）即可，本文后續所有修改都會第一時間在原始地址更新，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/67357.html

標籤：Go

上一篇：[系列] go-gin-api 路由中間件 - 簽名驗證（七）

下一篇：GO實作簡單(命令列)工具:sftp,文檔壓解,RDS備份,RDS備份下載