Go 项目版本号管理方案之ldflags -X 变量传递

作者: memory
时间: 2024-07-06
分类: 工具使用

go 链接器 Linker 是组装二进制文件的工具，我们在执行go build命令时，可以通过--ldflags标志设定链接器参数，使用以下语句可查看链接器可选参数。
go build --ldflags="--help"
参数很多，但我们感兴趣的是-X

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

-X参数，指定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
154d0e19b63567fe85f713fd441f3f6a82a7aa7d

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

$ git rev-parse --short HEAD
154d0e1

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

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

Makefile学习

VERSION = $$(git describe --abbrev=0 --tags)
COMMIT_TAG = $$(git tag --points-at HEAD)
VERSION_DATE = $$(git log -1 --pretty='%ad' --date=format:'%Y-%m-%d' $(VERSION))
COMMIT_REV = $$(git rev-list -n 1 $(VERSION))
MAINTAINER = "Memory"

all: build

build:
    go build -ldflags "-X config/config.version=$(VERSION)" -o bin/doGo main.go && upx bin/doGo

mac
    env GOARCH=amd64 go build -ldflags "-s -w -X config/config.version=$(VERSION)" -o bin/macos/doGo && upx bin/macos/doGo

linux
    env GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X config/config.version=$(VERSION)" -o bin/linux/doGo && upx bin/linux/doGo

docker-build:
    docker build --build-arg VERSION=$(VERSION) --build-arg MAINTAINER=$(MAINTAINER) -t memory/doGo .