Go -v 显示版本号和编译时间示例

C语言想要 -v 显示编译时间,能够使用 _DATE_, _TIME_ 这两个宏,mysql

而 Go 没有相似的常量,固然能够使用 Go 调用 C 代码(这是另外一种方法)git

然而,更好的方法是使用 go build 的 -ldflags 参数github

原理以下:sql

$ go build --help
	-ldflags 'flag list'
		arguments to pass on each go tool link invocation.

$ go tool link --help
	-X definition
		add string value definition of the form importpath.name=value

也就是能够在编译Go程序时,添加指定包的指定变量shell

----------------------------- 项目示例分割线 ----------------------------函数

完整项目见 githubui

version/version.go:code

package version

import (
	"fmt"
	"os"
)

var (
	BuildVersion string
	BuildTime    string
	BuildName    string
)

func init() {
	args := os.Args
	if nil == args || len(args) < 2 {
		return
	}
	if "-v" == args[1] {
		fmt.Printf("%s: v%s (%s)\n", BuildName, BuildVersion, BuildTime)
	} else if "-h" == args[1] {
		fmt.Println("Usage:")
		fmt.Printf("./%s\n", BuildName)
		fmt.Printf("./%s -v\n", BuildName)
		fmt.Printf("./%s -h\n", BuildName)
	}
	os.Exit(0)
}

makefile:orm

BUILD_VERSION	:= 1.0.0
BUILD_TIME		:= $(shell date "+%F %T")
BUILD_NAME		:= go-version-sample
SOURCE			:= ./*.go
TARGET_DIR		:= /path-you-want/${BUILD_NAME}

all:
	go build -ldflags \
	"-X ${BUILD_NAME}/version.BuildVersion=${BUILD_VERSION} \
	-X '${BUILD_NAME}/version.BuildTime=${BUILD_TIME}' \
	-X ${BUILD_NAME}/version.BuildName=${BUILD_NAME}" \
	-o ${BUILD_NAME} ${SOURCE}

clean:
	rm ${BUILD_NAME} -f

install:
	# mkdir -p ${TARGET_DIR}
	# cp ${BUILD_NAME} ${TARGET_DIR} -f

.PHONY : all clean install ${BUILD_NAME}

makefile 文件中定义了 version 包中的 BuildTime 等变量,get

而后在 version 包的 init() 函数中使用

(还能够添加 COMMIT_SHA1=`git rev-parse HEAD` 相似的变量)

main.go:

package main

import _ "go-version-sample/version"

import (
	"fmt"
)

func main() {
	fmt.Println("From main(): hello")
}

这里把 version 包的引用放在最前面,好处是程序第一时间检查参数,-v 显示版本号后直接退出程序(包的初始化是按照声明顺序)。

不然程序会执行其余包没必要要的初始化(好比mysql链接)

(不把变量放到main包也是一样的道理,由于main总会包含其余包)

最后,使用 make, make clean, make install 命令就能够使用了

相关文章
相关标签/搜索