一個不一樣的 Go 專案版本號管理方案

版本資訊管理，是專案開發中需要考慮的問題。尤其在各類開源軟體中，重要的功能特性一定需要版本號綁定。透過版本號，使用者才能知道程式提供了哪些功能。

那麼，如何為專案新增版本號碼呢？很多人應該都使用過硬編碼方式，即將版本號直接寫入原始碼或設定文件，每次功能升級就修改版本號。這種方式，顯然是可行的，但也容易出錯。一是發版時，容易忘記更新版本號，二是多個分支代碼合併時，也可能搞混。

下文，帶給大家一個不一樣的管理方案。

ldflags  -X 變數傳遞

go 連結器Linker 是組裝二進位檔案的工具，我們在執行go build 指令時，可以透過<span style="font-size: 15px;">--ldflags</span> 標誌設定連結器參數，使用下列語句可檢視連結器可選參數。

go build --ldflags="--help"

參數很多，但我們感興趣的是<span style="font-size: 15px;">#-X</span>

$ go build --ldflags="--help"
usage: link [options] main.o
...
  -X definition
     add string value definition of the form importpath.name=value
...

<span style="font-size: 15px;">-X</span> 參數，指定importpath.name=value，用於修改變數值。其中 importpath 表示套件導入路徑，name 是程式中的變數名，value 代表我們想要設定的變數值。

下面，我们通过示例项目来具体感受一下。

$ mkdir versionDemo 
$ cd versionDemo/
$ go mod init versiondemo
go: creating new go.mod: module versiondemo
$ touch main.go

在 main 函数中，我们打印 version 值。

package main

import (
 "fmt"
)

var (
 version = "0.0.1"
)

func main() {
 fmt.Println("version: ", version)
}

如果正常编译执行程序，将得到以下结果

 $ go build -o main && ./main
version:  0.0.1

此时，我们指定 --ldflags 的 -X 参数重新编译执行

$ go build -o main --ldflags="-X 'main.version=client-0.0.2'" && ./main
version:  client-0.0.2

可以看到 version 参数值已经被改变。

添加 git 信息

开发中需要使用 git 工具，本文讨论的版本管理，也经常与 git tag 挂钩。那其实有更酷的操作：我们可以在构建期间，通过 git commit 信息自动填充版本号。

我们基于上文项目目录，添加 git commit 信息。

$ git init
$ git add .
$ git commit -m "initial commit"

通过以下命令，可拿到 git commit 的 hash 值

 $ git rev-parse HEAD
46dab0ddb6ba20445c2c1f047575e25d3aad1a27

该值较长，我们可以添加 --short 选项获取短 hash 值。

$ git rev-parse --short HEAD
46dab0d

此时，通过指定 --ldflags 的 -X 参数，将 version 值替换成 git commit 的哈希值。这样，我们成功地将项目版本与 git 信息绑定在了一起。

$ go build -o main --ldflags="-X 'main.version=$(git rev-parse --short HEAD)'" && ./main
version:  46dab0d

总结

本文介绍了一种如何通过 ldflags  -X 变量传递的方式。使用这种方式我们可以在构建时轻松设定一些元信息，例如本文示例的程序版本信息。而这种构建的动作不应该手动去执行，而是放入到  CI/CD 流程中，让整个过程变得更加丝滑。

以上是一個不一樣的 Go 專案版本號管理方案的詳細內容。更多資訊請關注PHP中文網其他相關文章！