快捷導(dǎo)航

詳解Golang如何在編譯時(shí)注入版本信息

更新時(shí)間：2023年06月18日 08:58:07 作者：Shawn27

這篇文章主要為大家詳細(xì)介紹了Golang如何在編譯時(shí)實(shí)現(xiàn)注入版本信息，文中的示例代碼講解詳細(xì)，具有一定的學(xué)習(xí)價(jià)值，感興趣的可以了解一下

問題

一般而言，稍微做得好一點(diǎn)的開源軟件，其二進(jìn)制文件都會(huì)帶上版本信息，比如Docker，你可以通過以下命令來查看：

$ docker --version
Docker version 20.10.17, build 100c701
$ docker version
...
//輸出太長，這里就不展示了

有些Web應(yīng)用還提供了/version接口，你可以通過接口來獲取：

$ curl http://127.0.0.1:8080/version | jq
{
  "Build Time": "Fri, 16 Jun 2023 16:19:23 +0800",
  "Git Commit": "b554659",
  "Go Version": "go1.19",
  "OS/Arch": "darwin/amd64",
  "version": "0.9.2"
}

然而很多公司并沒有這方面的強(qiáng)制性規(guī)范，多數(shù)開發(fā)人員也沒有這樣的意識(shí)或習(xí)慣，所以大部分項(xiàng)目并沒有實(shí)現(xiàn)這個(gè)功能。如果二進(jìn)制文件不帶上版本信息，你可能要借助其它系統(tǒng)來查詢或追溯，這無疑是一件難受的事，對(duì)于代碼調(diào)試和問題定位很不友好。

那么在Golang中，如何實(shí)現(xiàn)這個(gè)功能呢？

思路

版本信息有很多，比如代碼版本號(hào)、Git提交號(hào)、編譯時(shí)間、Go版本號(hào)等，如何讓二進(jìn)制文件帶上這些信息呢？

硬編碼在代碼里肯定不行。因?yàn)镚it提交號(hào)是將代碼提交到代碼倉庫時(shí)才產(chǎn)生，而Go版本號(hào)和編譯時(shí)間只有在編譯時(shí)才能拿到。

比較合理的做法是在編譯時(shí)注入。Go編譯工具提供了-ldflags選項(xiàng)，通過-X參數(shù)可以注入包變量的值，我們只需要在代碼中將版本信息定義成包變量，然后在編譯時(shí)完成注入即可。這個(gè)過程可以實(shí)現(xiàn)為自動(dòng)化完成，下面以make工具為例說明。

實(shí)現(xiàn)步驟

1. 在代碼中定義版本信息的變量

將代碼版本號(hào)、Git提交號(hào)、編譯時(shí)間定義為包變量：

package config
var (
	Version   string  //代碼版本號(hào)
	GitCommit string  //Git提交號(hào)
	BuildTime string  //編譯時(shí)間
)

Go版本號(hào)等信息可以借助runtime包獲取：

runtime.Version()  //Go版本
runtime.GOOS       //操作系統(tǒng)
runtime.GOARCH     //平臺(tái)架構(gòu)

2. 在代碼中使用這些變量

1）實(shí)現(xiàn)--version參數(shù)或version子命令

以Cobra命令行框架為例，為rootCmd實(shí)現(xiàn)--version參數(shù)：

rootCmd.Version = config.Version
rootCmd.SetVersionTemplate(fmt.Sprintf(`{{with .Name}}{{printf "%%s version information: " .}}{{end}}
    {{printf "Version:    %%s" .Version}}
    Git Commit: %s
    Build Time: %s
    Go version: %s
    OS/Arch:    %s/%s
`, config.GitCommit, config.BuildTime, runtime.Version(), runtime.GOOS, runtime.GOARCH))

2）實(shí)現(xiàn)/version接口

以Gin框架為例，將/version路由到如下的Version函數(shù)：

func Version(ctx *gin.Context) {
    ctx.Writer.Header().Set("Content-Type", "application/json")
    ctx.Writer.WriteHeader(http.StatusOK)
    json.NewEncoder(ctx.Writer).Encode(map[string]string{
        "version":    config.Version,
        "Git Commit": config.GitCommit,
        "Build Time": config.BuildTime,
        "Go Version": runtime.Version(),
        "OS/Arch":    runtime.GOOS + "/" + runtime.GOARCH,
    })
}

3. 在編譯前獲取版本信息

在Makefile中，用git命令獲取代碼版本號(hào)、Git提交號(hào)，用date命令獲取當(dāng)前時(shí)間

VERSION    = $(shell git describe --tags --always)
GIT_COMMIT = $(shell git rev-parse --short HEAD)
BUILD_TIME = $(shell date -R)

4. 在編譯時(shí)注入版本信息

在Makefile中，通過-ldflags選項(xiàng)為go build命令傳入編譯參數(shù)，實(shí)現(xiàn)版本信息的注入

define LDFLAGS
"-X 'github.com/myname/myapp/config.Version=${VERSION}' \
-X 'github.com/myname/myapp/config.GitCommit=${GIT_COMMIT}' \
-X 'github.com/myname/myapp/config.BuildTime=${BUILD_TIME}'"
endef
build:
    go build -ldflags ${LDFLAGS} -o myapp_${VERSION} .

5. 驗(yàn)證效果

編譯出二進(jìn)制，即可驗(yàn)證--version參數(shù)；用二進(jìn)制啟動(dòng)服務(wù)進(jìn)程，即可驗(yàn)證/version接口。

$ make build
...
//編譯過程，省略輸出
$ myapp --version
myapp version information: 
    Version:    0.9.2
    Git Commit: b554659
    Build Time: Sat, 17 Jun 2023 11:30:44 +0800
    Go version: go1.20.5
    OS/Arch:    darwin/arm64
$ myapp
...
//啟動(dòng)進(jìn)程，省略輸出
$ curl http://127.0.0.1:8080/version | jq
{
  "Build Time": "Sat, 17 Jun 2023 11:30:44 +0800",
  "Git Commit": "b554659",
  "Go Version": "go1.20.5",
  "OS/Arch": "darwin/arm64",
  "version": "0.9.2"
}