在Linux环境中使用Go编译静态二进制文件[译]

Part1 引言

Go语言的一个优势是能够生成静态链接的可执行程序。但是，这并不是说默认情况下编译出来的Go可执行程序都是静态链接的。在有些情况下，需要额外的操作才能实现。具体情况取决于操作系统，本文介绍Unix系统下如何达成这一目标。

Part2 示例

下面是用Go语言编写的hello world程序，在linux机器上将其编译成可执行文件。然后检查该可执行文件是静态链接还是动态链接。

package main

import "fmt"

func main() {
 fmt.Println("hello world")
}

编译helloworld可执行文件，操作如下。

Part3 检查可执行程序是动态链接还是静态链接

有多种方法检查可执行程序链接类型，这里介绍三种方法：

1 通过file命令

file命令输出中明确说明helloworld可执行文件为 statically linked类型，即静态链接。

2 通过ldd命令

ldd命令会输出helloworld程序依赖的动态库，由于helloworld非动态链接，所以输出结果为 不是动态可执行程序

3 通过nm命令

使用nm命令列举出helloworld中未定义符号（期望在链接运行时通过动态库加载）。输出为空，表明helloworld中没有任何未定义符号。

Part4 DNS和用户组

在Unix机器上，当满足特定条件时，Go语言标准库会借助libc实现DNS和用户组功能。

• 当cgo启用时（默认情况下，在Unix系统下 CGO_ENABLED 值为1，表示默认开启）。Go语言标准库中的net包会调用C语言库实现DNS查找功能。这意味着Go程序在进行域名解析时，会使用底层操作系统提供的C库函数，如getaddrinfo和getnameinfo。
• 同理，当启用cgo时，Go语言标准库中的os/user包会调用C语言库来查找用户和用户组。

DNS查询代码如下，保存在lookuphost.go文件中。

package main

import (
 "fmt"
 "net"
)

func main() {
 fmt.Println(net.LookupHost("go.dev"))
}

编译出可执行程序 lookuphost

通过ldd命令可以看出lookuphost可执行程序是一个动态链接，需要在运行时通过ilbc加载共享库。

为啥编译出来的程序是动态链接在官方net包文档中有详细说明。Go语言标准库也提供了纯Go实现的DNS功能（尽管纯Go实现可能缺少一些高级特性），如果我们想使用纯Go实现，而不是依赖于系统的libc，可以在编译的时候设置tags实现。具体操作如下：

此外，我们还可以通过关闭cgo来编译出静态链接程序。在Unix系统中，默认cgo是开启的，查看方法如下。

关闭cgo再次编译lookuphost程序。

查找用户的用户组信息程序如下，代码保存在userlookup.go文件中。

package main

import (
  "encoding/json"
  "log"
  "os"
  "os/user"
)

func main() {
  user, err := user.Lookup("bob")
  if err != nil {
    log.Fatal(err)
  }

  je := json.NewEncoder(os.Stdout)
  je.Encode(user)
}

编译上述代码，然后通过ldd命令看到可执行程序为动态链接。

同上面的DNS程序，我们可以添加编译tags，将其编译为静态链接程序。

此外，我们也可以通过关闭cgo达到同样的效果。

Part5 将C代码链接到Go二进制文件

Go语言支持通过cgo调用C语言中的函数接口（FFI)，下面通过一个具体例子说明，下述代码保存在cstdio.go文件中。

package main

//#include <stdio.h>
// void helloworld(){
// printf("hello,world from C\n");
//}
import "C"

func main() {
 C.helloworld()
}

由于使用了cgo，C代码中调用了printf函数，该函数属于libc，即使程序中没有显式调用C运行时，当Go代码通过cgo与C代码交互时，cgo会生成一些“胶水代码”，确保程序能够正常执行。通过ldd命令可以看到上述程序编译后的可执行文件为动态链接类型。

注意：即使我们编写的程序中没有C代码，cgo也可能会涉及。因为我们程序引用的依赖库可能使用了cgo，像常用的go-sqlite3驱动程序就需要cgo，如果我们编写的程序导入了该包，则自然使用了cgo。

这种情况下，通过关闭CGO_ENABLED是无效的。那有什么解决方法吗？请看下一章节内容。

Part6 链接静态libc

如果Go程序包含了C代码，在Unix系统上编译出来的二进制文件是动态链接。具体原因如下：

1. C代码调用libc(C运行时)
2. 在Unix系统上通常使用的libc是glibc
3. 推荐的方式是通过动态链接到glibc
4. 因此，go build得到的二进制文件是动态链接类型

我们可以换用其他的libc，而不是默认的glibc，比如使用静态链接的libc，这样编译后的可执行文件就是静态的。目前musl就是一个满足我们期望的libc，它是一个轻量级的C标准库，兼容POSIX的API，是许多静态链接应用程序和容器化应用程序的首选。

1 安装musl

1. 从官网下载musl源码

1. 解压源码压缩包 musl-1.2.5.tar.gz

1. 进入 musl-1.2.5目录，执行 ./configure --prefix=<MUSLDIR>， MUSLDIR是安装路径，我这里选择的是/usr/local/bin/
2. 最后执行 make / make install 进行安装, 安装成功如下

2 编译

下面采用musl对cstdio.go文件进行重行编译，操作如下。CC告诉go build 使用哪个c编译器进行cgo编译。后面的连接器参数设置使用外部连接器。最后执行静态链接。详细信息阅读官方文档

上述编译静态程序的方法同样适用于复杂程序，作者提供了一个use-sqlite.go文件，使用了go-sqlite3包，下面通过两种方式编译对比效果。

// use-sqlite.go 
package main

import (
 "database/sql"
 "fmt"
 "log"

 _ "github.com/mattn/go-sqlite3"
)

func main() {
 // Open the database file in /tmp/
 db, err := sql.Open("sqlite3", "/tmp/example.db")
 if err != nil {
  log.Fatal(err)
 }
 defer db.Close()

 // Create a table if it doesn't exist
 createTableSQL := `CREATE TABLE IF NOT EXISTS users (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  name TEXT NOT NULL,
  age INTEGER NOT NULL
 );`
 _, err = db.Exec(createTableSQL)
 if err != nil {
  log.Fatal(err)
 }

 // Insert some data
 insertUserSQL := `INSERT INTO users (name, age) VALUES (?, ?)`
 _, err = db.Exec(insertUserSQL, "Alice", 30)
 if err != nil {
  log.Fatal(err)
 }
 _, err = db.Exec(insertUserSQL, "Bob", 25)
 if err != nil {
  log.Fatal(err)
 }

 // Query the data
 querySQL := `SELECT id, name, age FROM users`
 rows, err := db.Query(querySQL)
 if err != nil {
  log.Fatal(err)
 }
 defer rows.Close()

 fmt.Println("User data:")
 for rows.Next() {
  var id int
  var name string
  var age int
  err = rows.Scan(&id, &name, &age)
  if err != nil {
   log.Fatal(err)
  }
  fmt.Printf("ID: %d, Name: %s, Age: %d\n", id, name, age)
 }
 err = rows.Err()
 if err != nil {
  log.Fatal(err)
 }
}

• 采用默认编译器编译

• 采用musl编译

采用musl，我们可以在不使用-tags netgo标签，也不用禁用cgo的情况，编译一个静态链接的lookuphost程序。

Part7 使用Zig作为C编译器

Zig 是一种新的系统编程语言，与Go语言类似，它也提供了一系列编译工具即Zig工具链，该工具链包含有Zig编译器、C/C++编译器、链接器和用于静态链接的libc。所以Zig可以用来将Go二进制文件与C代码静态链接。

安装Zig后采用下面的命令编译可执行程序，其中ZIGDIR为Zig的安装目录。相比上一章节的musl-gcc，调用命令会简单一些。

$ CC="$ZIGDIR/zig cc -target x86_64-linux-musl" go build cstdio.go
$ CC="$ZIGDIR/zig cc -target x86_64-linux-musl" go build use-sqlite.go

Part8 总结

• 大部分情况下Go语言编译出来的可执行程序是静态，但在某些情况下默认编译出来的是动态链接，我们可以设置build tags或关闭cgo来编译静态链接程序。
• Go语言中有一个提案，即在 go build 命令中添加一个 -static 标志，表明将程序编译为静态类型，目前还未实现。