关于后端:如何获取及嵌入Go二进制执行包信息

期待已久的 Go 1.18 终于公布了，这次版本更新的内容很多，包含泛型、含糊测试、多 module 工作区、新的 net/netip 包、新的 string.Cut 函数等。

上述的个性，或者大家都早已耳闻。在菜刀看完 release note 之后，留神到一个可能没有被大家关注到的新性能：二进制文件信息嵌入。

之所以关注到该点，起因就在于，咱们于上周刚在一个不一样的 Go 我的项目版本号治理计划一文中探讨过该方面的问题，感觉和官网接了一个完满 combo。

构建信息嵌入
在 Go 1.18，通过 go build 构建命令，咱们能够将构建信息嵌入到二进制文件中。

接下来，咱们通过示例来直观感触。

首先，通过 go version 命令确保曾经装置好了 Go 1.18 版本。

$ go version
go version go1.18 darwin/amd64

接着，初始化我的项目环境

$ mkdir versionDemo
$ cd versionDemo
$ go mod init example/version
$ touch main.go

在 main.go 中，写个简略的打印逻辑

package main

import ("fmt")

func main() {fmt.Println("HELLO GOPHER")
}

此时，咱们编译失去二进制文件

$ go build -o main1.18 example/version

失去二进制文件之后，就能够通过以下命令获取到编译该文件时的一些元信息

$ go version -m main1.18
main1.18: go1.18
 path example/version
 mod example/version (devel)
 build -compiler=gc
 build CGO_ENABLED=1
 build CGO_CFLAGS=
 build CGO_CPPFLAGS=
 build CGO_CXXFLAGS=
 build CGO_LDFLAGS=
 build GOARCH=amd64
 build GOOS=darwin
 build GOAMD64=v1

能够看到，通过 go version -m binaries，咱们能够获取到二进制文件的各项构建信息。

当然，如果在构建过程中，为二进制文件指定了 -tags 等，咱们同样可能以上的形式获取。

$ go build -tags version1.1 --ldflags="-X'main.s=sss'" -o main1.18more example/version
$ go version -m main1.18more
main1.18more: go1.18
 path example/version
 mod example/version (devel)
 build -compiler=gc
 build -ldflags="-X'main.s=sss'"
 build -tags=version1.1
 build CGO_ENABLED=1
 build CGO_CFLAGS=
 build CGO_CPPFLAGS=
 build CGO_CXXFLAGS=
 build CGO_LDFLAGS=
 build GOARCH=amd64
 build GOOS=darwin
 build GOAMD64=v1

VCS 信息嵌入
正如在一个不一样的 Go 我的项目版本号治理计划一文中探讨过的一样，版本信息不应该仅蕴含 Go 自身的信息，还应该蕴含 VCS 信息，例如 Git、Mercurial、Fossil 和 Bazaar。

在 Go 1.18，通过 go help build 命令，能够看到多了 -buildvcs 参数，它默认是关上的。

$ go help build
...
 -buildvcs
  Whether to stamp binaries with version control information. By default,
  version control information is stamped into a binary if the main package
  and the main module containing it are in the repository containing the
  current directory (if there is a repository). Use -buildvcs=false to
  omit version control information.
...

在上述我的项目中，咱们增加 Git 版本控制。

$ git init
$ go build -o mainwithgit example/version
$ go version -m mainwithgit
mainwithgit: go1.18
 path example/version
 mod example/version (devel)
 build -compiler=gc
 build CGO_ENABLED=1
 build CGO_CFLAGS=
 build CGO_CPPFLAGS=
 build CGO_CXXFLAGS=
 build CGO_LDFLAGS=
 build GOARCH=amd64
 build GOOS=darwin
 build GOAMD64=v1
 build vcs=git
 build vcs.modified=true

此时，输入信息中多出了两列对于 vcs 的信息。接下来，咱们将仓库内文件保留并提交。

$ git add go.mod main.go
$ git commit -m 'feat: this is a commit message'
$ go build -o mainwithgit example/version
$ go version -m mainwithgit
 $ go version -m mainwithgit
mainwithgit: go1.18
 path example/version
 mod example/version (devel)
 build -compiler=gc
 build CGO_ENABLED=1
 build CGO_CFLAGS=
 build CGO_CPPFLAGS=
 build CGO_CXXFLAGS=
 build CGO_LDFLAGS=
 build GOARCH=amd64
 build GOOS=darwin
 build GOAMD64=v1
 build vcs=git
 build vcs.revision=f28c77dfcfcfb5289fae9318d3ab3e487b8a3b37
 build vcs.time=2022-03-20T14:26:24Z
 build vcs.modified=true

二进制文件中记录了更具体 vcs 信息，包含 git 版本号，提交工夫等。

出于某些起因，有时咱们并不想二进制中蕴含这些 vcs 信息，这时，在构建时指定 -buildvcs=false 即可。

没有 Go 环境，如何查看嵌入信息
在下面的场景中，咱们都是通过执行 go version -m binaries 命令查看二进制文件的嵌入信息的。然而，在能拿到二进制文件的场景下，并不总是存在 Go 环境，例如没有 Go 环境的近程服务器。这样的场景中，如何查看它的嵌入信息呢？

这时，能够通过 runtime/debug.ReadBuildInfo 获取。例如，咱们将上述例子中的 main.go 的内容更改如下

package main

import (
 "fmt"
 "runtime/debug"
)

func main() {info, _ := debug.ReadBuildInfo()
 fmt.Println("=========== build info ===========")
 fmt.Println(info)
}

同样可失去构建信息如下

=========== build info ===========
go      go1.18
path    workspace/example/versionDemo
mod     workspace/example/versionDemo   (devel) 
build   -compiler=gc
build   CGO_ENABLED=1
build   CGO_CFLAGS=
build   CGO_CPPFLAGS=
build   CGO_CXXFLAGS=
build   CGO_LDFLAGS=
build   GOARCH=amd64
build   GOOS=darwin
build   GOAMD64=v1
build   vcs=git
build   vcs.revision=b3f9cd7b83d4e624be942365728d676dfdca6a3e
build   vcs.time=2022-03-20T14:10:44Z
build   vcs.modified=true

因而，为了解决没有 Go 环境的近程服务器不能查看嵌入信息的状况。咱们无妨利用 runtime/debug.ReadBuildInfo 函数，将其封装为一个接口，拜访该接口即可获取以后二进制文件的嵌入信息。

总结
其实在 1.18 之前的版本中，Go 二进制文件就包含了少许的嵌入信息。例如同样是上文中的我的项目，咱们通过 1.16 构建二进制文件，读取它的嵌入信息，其仅包含了 path 与 mod 信息。

$ go1.16.4 build -o main1.16 example/version
$ go1.16.4 version -m main1.16
main1.16: go1.16.4
 path example/version
 mod example/version (devel)

在 1.18 中，通过丰盛二进制文件的嵌入信息，可能让咱们更好地理解到以后程序。例如利用 vcs 信息能够判断从三方获取的 Go 二进制文件是否是预期程序，代码提交的发版部署是否有误等。

我想肯定会有小伙伴会问，减少了嵌入信息会让二进制文件更大吧？这个无妨留给读者去入手比照。

关注获取更多好文

本文由 mdnice 多平台公布