登录
首页 >  Golang >  Go问答

在 Go 中生成构建时间戳

来源:stackoverflow

时间:2024-04-26 13:06:34 243浏览 收藏

Golang小白一枚,正在不断学习积累知识,现将学习到的知识记录一下,也是将我的所得分享给大家!而今天这篇文章《在 Go 中生成构建时间戳》带大家来了解一下##content_title##,希望对大家的知识积累有所帮助,从而弥补自己的不足,助力实战开发!


问题内容

我想在 go 程序中(在 debian/linux/x86-64 上使用 go 1.11.1)保留构建时间戳,并用一行解释最后一次 git commit

在 c 程序中(fwiw 我的 bismon 项目正在做非常类似的事情),我只会生成一些 _timestamp.c 文件,例如使用 makefile 配方,例如:

_timestamp.c: 
    date +'const char my_timestamp[]='%c';%n' > $@
    (echo -n 'const char my_lastgitcommit[]="'; \
     git log --format=oneline --abbrev=12 --abbrev-commit -q | head -1 \
       | tr -d '\n\r\f\"\\\\' ; echo '";') >> $@

我会将我的程序 myprog 链接到以下内容:

myprog: $(myobjects) _timestamp.c
    $(link.c) $(myobjects) _timestamp.c -o $@
    $(rm) _timestamp.c

请注意,_timestamp.c 会在每次成功链接时自动删除。当然,在某些标头中,我会声明 extern const char my_timestamp[];extern const char my_lastgitcommit[]: 我会使用例如我的 my_timestampmy_lastgitcommit 在我的 main.c 中(并且 myobjects 包含 main.o

看起来 gogenerate 可以用来以类似的方式表现。我想要一个包 "timestamp" 定义两个字符串全局变量 timestamp.my_timestamptimestamp.my_gitcommit 但我不太明白该怎么做。

我尝试添加一些 timestamp/timestamp.go 文件

package timestamp

//go:generate date +'var my_timestamp = "%c"%n'

// code generated - do not edit.

但是 gogenerate 然后 goinstall 并没有改变

当然,这些时间戳在编译时应该是常量字符串,我希望在 elf 可执行文件上运行 strings(1) 实用程序时找到它们。

顺便说一句,我记得 go 命令的动机之一:

go 从一开始就有一个明确的目标,就是能够仅使用源代码本身中找到的信息来构建 go 代码,而不需要编写 makefile 或 makefile 的许多现代替代品之一。如果 go 需要一个配置文件来解释如何构建程序,那么 go 就会失败。

所以我仍然期待一些东西可以单独进入源代码,而不需要额外的构建配置。

换句话说,我想在每次构建时生成一个类似于以下内容的 go 文件:

// generated timestamp.go file
package timestamp
var Buildtime = "Tue 30 Oct 2018 09:39:01 AM MET";
var Buildlastgitcommit = "7fde394b60bc adding timestamp.go"

buildtime 字符串由 date +%c 生成。 buildlastgitcommit 字符串可能是由类似于我的 _timestamp.c make 规则正在执行的命令生成的。

我需要这些字符串是常量,并且内置于 go 构建生成的 elf 可执行文件中(我更喜欢通过通常的命令来完成,不需要 go build 或任何其他参数)其他构建自动化工具,或者如果忘记强制参数,则通过某种方式使构建失败;因此 atanayel 的答案是不够的)。所以我希望 strings(1) 实用程序在可执行文件中快速找到这些字符串。并且此类文件的生成应该在某种文件中进行配置,而不需要向构建器提供额外的参数。

我可以考虑切换到其他一些go友好的构建自动化系统(但似乎即使使用gb我也不能轻松地做我想做的事:快速生成一些简单的.go每次构建时都文件)。但我不明白为什么在 go 程序中使用生成的 go 文件如此困难。生成简单代码遵循 unix 哲学,并且已经实践了几十年(例如,请参阅受旧 yacc 程序启发的 goyacc)。

注意:gogenerate 的基本原理明确提到:

本提案的目标不是构建像 unix make(1) 实用程序那样的通用构建系统。

及以后

一旦事情解决了,作者将生成的文件提交到源存储库,

(这不是我的用例)

ps。我只关心 posix 系统;我真的不在乎我的 go 软件是否不能在 windows 上构建。我倾向于认为(与 go 命令动机所解释的相反),在我的特定情况下,我确实需要一些构建自动化工具。在我的 bastavigo 玩具项目 (gplv3+) 中,我使用 make (驱动 go 命令)

解决方案


正如其他答案提到的,您可以在构建时将所需的值注入到二进制文件中。

例如,如果我们有这些包变量:

// build flags
var (
    buildtime  string
    commithash string
    goversion  string
    gittag     string
)

然后我们可以使用这个 bash 脚本填充它们:

#!/bin/sh

clear

TRG_PKG='main'
BUILD_TIME=$(date +"%Y%m%d.%H%M%S")
CommitHash=N/A
GoVersion=N/A
GitTag=N/A

if [[ $(go version) =~ [0-9]+\.[0-9]+\.[0-9]+ ]];
then
    GoVersion=${BASH_REMATCH[0]}
fi

GV=$(git tag || echo 'N/A')
if [[ $GV =~ [^[:space:]]+ ]];
then
    GitTag=${BASH_REMATCH[0]}
fi

GH=$(git log -1 --pretty=format:%h || echo 'N/A')
if [[ GH =~ 'fatal' ]];
then
    CommitHash=N/A
else
    CommitHash=$GH
fi

FLAG="-X $TRG_PKG.BuildTime=$BUILD_TIME"
FLAG="$FLAG -X $TRG_PKG.CommitHash=$CommitHash"
FLAG="$FLAG -X $TRG_PKG.GoVersion=$GoVersion"
FLAG="$FLAG -X $TRG_PKG.GitTag=$GitTag"

if [[ $1 =~ '-i' ]];
then
    echo 'go install'
    go install -v -ldflags "$FLAG"
else
    echo 'go build'
    go build -v -ldflags "$FLAG"
fi

示例代码取自此 repo

终于介绍完啦!小伙伴们,这篇关于《在 Go 中生成构建时间戳》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布Golang相关知识,快来关注吧!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>