0

0

一个不一样的 Go 项目版本号管理方案

Go语言进阶学习

Go语言进阶学习

发布时间:2023-07-24 16:07:55

|

1175人浏览过

|

来源于Go语言进阶学习

转载

版本信息管理,是项目开发中需要考虑的问题。尤其在各类开源软件中,重要的功能特性一定需要版本号绑定。通过版本号,用户才能知道该程序提供了哪些功能。

那么,如何为项目添加版本号呢?很多人应该都使用过硬编码方式,即将版本号直接写入源码或者配置文件,每次功能升级就修改版本号。这种方式,显然是可行的,但是也容易出错。一是发版时,容易忘记更新版本号,二是多个分支代码合并时,也可能搞混。

下文,给大家带来一个不一样的管理方案。

ldflags  -X 变量传递

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
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 流程中,让整个过程变得更加丝滑。

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

640

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

527

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

264

2023.07.24

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

550

2024.04.09

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

513

2024.04.09

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

11

2026.01.19

微信聊天记录删除恢复导出教程汇总
微信聊天记录删除恢复导出教程汇总

本专题整合了微信聊天记录相关教程大全,阅读专题下面的文章了解更多详细内容。

79

2026.01.18

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

109

2026.01.16

全民K歌得高分教程大全
全民K歌得高分教程大全

本专题整合了全民K歌得高分技巧汇总,阅读专题下面的文章了解更多详细内容。

153

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 3.9万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号