简介
如果你曾经运行过 docker version,
就会发现它提供了很多信息:
对于编译好的二进制文件而言, 获取版本信息是非常重要的.
尽可能地提供详细信息, 有利于后期的维护和排错.
如何实现
对于版本信息等, 有两种方式,
一种从外部获取, 比如配置文件等,
另一种从源代码中获取, 将配置信息写死在源代码中.
这两种都不太好, 比如编译时间就不太好确定.
最好是能在 go build 时确定这些信息.
幸好, go build 提供了一个选项叫做 -ldflags '[pattern=]arg list'.
这使得我们可以在编译生成二进制文件时, 指定某些变量的值.
比如我们有个文件是 company/buildinfo 包的一部分.
运行 go build -ldflags="-X 'company/buildinfo.BuildTime=$(date)'" 会记录编译时间,
将 BuildTime 的值设置为编译时的时间, 即从 $(date) 中获取的时间.
参考:
Compile packages and dependencies
Command link
Including build information in the executable
实践
新增 pkg/version 包, 用于获取版本信息.
主要定义了一个结构体, 保持版本信息.
有些信息可以通过 runtime 获取, 有些是编译时传进来的.
这里没有明确的版本号, 而是使用 git tag 作为版本标签.
最后, 定义一个命令 version.
别忘了使用 AddCommand 添加子命令.
由此, 代码基本已经改完了, 还剩下最后一点, 修改 Makefile 文件,
以便简化操作过程.
修改 Makefile
首行定义了运行的 shell, 默认是 /bin/sh, 这里改成了更常用的 /bin/bash.
然后, 就是定义了一大堆需要的参数.
在运行 go build 的时候添加了参数 -ldflags ${ldflags}.
如此, 以后只要使用 make build 就能生成具有版本信息的二进制文件了.
编译好之后, 可以运行 ./web version 查看具体的版本信息.
总结
通过为编译时添加额外信息, 可以生成更具交互性的二进制文件.
同时, 也能体会到 Makefile 带来的便捷.
当前部分的代码
作为版本 v0.12.0
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。