Une solution différente de gestion des numéros de version des projets Go

La gestion des informations de version est une question qui doit être prise en compte lors du développement du projet. Surtout dans divers types de logiciels open source, les fonctionnalités fonctionnelles importantes doivent être liées aux numéros de version. Grâce au numéro de version, les utilisateurs peuvent connaître les fonctions fournies par le programme.

Alors, comment ajouter un numéro de version au projet ? De nombreuses personnes doivent avoir utilisé le codage en dur, c'est-à-dire écrire le numéro de version directement dans le code source ou le fichier de configuration et modifier le numéro de version à chaque mise à niveau de la fonction. Cette méthode est évidemment réalisable, mais elle est également sujette aux erreurs. Premièrement, il est facile d’oublier de mettre à jour le numéro de version lors de la publication d’une version. Deuxièmement, lorsque plusieurs codes de succursale sont fusionnés, une confusion peut survenir.

Ce qui suit vous apportera un plan de gestion différent.

ldflags -X variable transfer

go linker Linker est un outil d'assemblage de fichiers binaires Lorsque nous exécutons la commande go build, nous pouvons passer <code style='font-size: 14px;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgba(14, 210, 247, 0.15);'><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>--ldflags flags définissent les paramètres de l'éditeur de liens. Utilisez l'instruction suivante pour afficher les paramètres facultatifs de l'éditeur de liens.

🎜

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

🎜🎜Il existe de nombreux paramètres, mais ceux qui nous intéressent sont 🎜🎜-X 🎜🎜

package main

import (
 "fmt"
)

var (
 version = "0.0.1"
)

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

🎜🎜-X🎜🎜 Paramètres, spécifiez importpath.name=value, utilisé pour modifier la valeur de la variable. Parmi eux, importpath représente le chemin d'importation du package, name est le nom de la variable dans le programme et value représente la valeur de la variable que nous souhaitons définir. 🎜🎜

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

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!