详解Golang如何在编译时注入版本信息

 更新时间:2023年06月18日 08:58:07   作者:Shawn27  
这篇文章主要为大家详细介绍了Golang如何在编译时实现注入版本信息,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下

问题

一般而言,稍微做得好一点的开源软件,其二进制文件都会带上版本信息,比如Docker,你可以通过以下命令来查看:

$ docker --version
Docker version 20.10.17, build 100c701
$ docker version
...
//输出太长,这里就不展示了

有些Web应用还提供了/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"
}

然而很多公司并没有这方面的强制性规范,多数开发人员也没有这样的意识或习惯,所以大部分项目并没有实现这个功能。如果二进制文件不带上版本信息,你可能要借助其它系统来查询或追溯,这无疑是一件难受的事,对于代码调试和问题定位很不友好。

那么在Golang中,如何实现这个功能呢?

思路

版本信息有很多,比如代码版本号、Git提交号、编译时间、Go版本号等,如何让二进制文件带上这些信息呢?

硬编码在代码里肯定不行。因为Git提交号是将代码提交到代码仓库时才产生,而Go版本号和编译时间只有在编译时才能拿到。

比较合理的做法是在编译时注入。Go编译工具提供了-ldflags选项,通过-X参数可以注入包变量的值,我们只需要在代码中将版本信息定义成包变量,然后在编译时完成注入即可。这个过程可以实现为自动化完成,下面以make工具为例说明。

实现步骤

1. 在代码中定义版本信息的变量

将代码版本号、Git提交号、编译时间定义为包变量:

package config
var (
	Version   string  //代码版本号
	GitCommit string  //Git提交号
	BuildTime string  //编译时间
)

Go版本号等信息可以借助runtime包获取:

runtime.Version()  //Go版本
runtime.GOOS       //操作系统
runtime.GOARCH     //平台架构

2. 在代码中使用这些变量

1)实现--version参数或version子命令

Cobra命令行框架为例,为rootCmd实现--version参数:

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)实现/version接口

Gin框架为例,将/version路由到如下的Version函数:

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命令获取代码版本号、Git提交号,用date命令获取当前时间

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

4. 在编译时注入版本信息

在Makefile中,通过-ldflags选项为go build命令传入编译参数,实现版本信息的注入

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. 验证效果

编译出二进制,即可验证--version参数;用二进制启动服务进程,即可验证/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
...
//启动进程,省略输出
$ 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"
}

总结

二进制文件直接带上版本信息,能为代码调试和问题定位带来很大的方便。本文介绍了通过-ldflags选项实现在编译时注入版本信息的具体做法。

这是一个比较通用的方法,很多开源软件比如 Docker 也是这样做的。

到此这篇关于详解Golang如何在编译时注入版本信息的文章就介绍到这了,更多相关Golang编译注入版本信息内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go web入门Go pongo2模板引擎

    Go web入门Go pongo2模板引擎

    这篇文章主要为大家介绍了Go web编程入门Go pongo2模板引擎使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • 一文掌握Go语言并发编程必备的Mutex互斥锁

    一文掌握Go语言并发编程必备的Mutex互斥锁

    Go 语言提供了 sync 包,其中包括 Mutex 互斥锁、RWMutex 读写锁等同步机制,本篇博客将着重介绍 Mutex 互斥锁的基本原理,需要的可以参考一下
    2023-04-04
  • golang实现大文件上传功能全过程

    golang实现大文件上传功能全过程

    Go语言可以用来实现大文件传输,下面这篇文章主要给大家介绍了关于golang实现大文件上传功能的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-07-07
  • Minio基本介绍及如何搭建Minio集群

    Minio基本介绍及如何搭建Minio集群

    MinIO主要采用Golang语言实现,客户端与存储服务器之间采用http/https通信协议,本文重点给大家介绍什么是Minio?如何搭建Minio集群?感兴趣的朋友一起看看吧
    2022-06-06
  • 深入了解Golang为什么需要超时控制

    深入了解Golang为什么需要超时控制

    本文将介绍为什么需要超时控制,然后详细介绍Go语言中实现超时控制的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起了解一下
    2023-05-05
  • Golang语言中切片的长度和容量的概念和使用

    Golang语言中切片的长度和容量的概念和使用

    这篇文章主要介绍了Golang语言中切片的长度和容量的概念和使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-11-11
  • go实现限流功能示例

    go实现限流功能示例

    这篇文章主要为大家介绍了go实现限流功能示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • Golang第三方库robfig/cron定时器库用法小结

    Golang第三方库robfig/cron定时器库用法小结

    robfig/cron是Golang生态中最常用的定时器库之一,实现了标准的Unix Cron表达式解析与任务调度功能,本文就来详细的介绍一下第三方库robfig/cron定时器库用法,感兴趣的可以了解一下
    2026-04-04
  • Go快速开发一个RESTful API服务

    Go快速开发一个RESTful API服务

    这篇文章主要为大家介绍了Go快速开发一个RESTful API服务,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • golang连接kafka的示例代码

    golang连接kafka的示例代码

    本文主要介绍了golang连接kafka的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04

最新评论