透过一个编译报错,总结两个Go程序编译的重要知识

原文忘记标注原创,补发一篇,各位海涵~!

最近调研了一下某个做 APM 的厂商的 Go 探针程序,说是引入一个包,全程不用再修改其他代码就能在项目里引入探针。没想到在刚引入包试着构建了一下就翻车了。

main.go:10:2: build constraints exclude all Go files in /xxx/github.com/xxx/agnet/xxxx

编译器编译的时候直接排除了某个包下的所有文件,啥意思呢?就是这个包下没有能在当前构建环境下构建的 Go 文件。猜测应该是这个包源码的构建标签上声明了不允许在Mac 环境下构建。打开源码看了看,确实是,所有文件的构建标签都是这么声明的。

// +build linux
// +build amd64

这个叫做条件编译,或者约束编译。那想在Mac下编译linux上才能运行的执行文件该怎么办呢?Go 里边还支持一个特性叫做交叉编译,就是干跨平台编译这个事儿的。具体怎么用呢,比如这个例子里是需要在Mac环境下编译能在Linux系统amd64架构下运行的执行文件,就得酱婶进行编译:

CGO_ENABLED=0  GOOS=linux  GOARCH=amd64  go build main.go

不过我后来想研究下为啥不让在 Mac 上编译,看了看这个包的探针是用CGO实现的调用了linux系统下的一个C语言实现的工具命令。看到这我已经不想继续研究这个包了,那么为了让此篇文章水的不那么明显:),接下来咱们就把Go语言的交叉编译和条件编译这两个知识点再复习一遍吧。

交叉编译

交叉编译是用来在一个平台上生成另一个平台的可执行程序。Go 的命令集是原生支持交叉编译的,使用方法也很简单,比如上面已经演示过的

CGO_ENABLED=0  GOOS=linux  GOARCH=amd64  go build main.go

参数说明

  • CGO_ENABLED : CGO 表示golang中的工具,CGO_ENABLED 表示CGO禁用,交叉编译中不能使用CGO的
  • GOOS: 目标平台
    • mac 对应  darwin
    • linux 对应 linux
    • windows 对应 windows
  • GOARCH :目标平台的体系架构【386,amd64,arm】, 目前市面上的个人电脑一般都是amd64架构的
    • 386 也称 x86 对应  32位操作系统
    • amd64 也称 x64 对应 64位操作系统
    • arm 这种架构一般用于嵌入式开发。比如 Android , IOS , Win mobile , TIZEN 等

了解完这几个参数后,我们在看下Mac、Linux、Windows这三个平台上执行交叉编译的例子,Windows的因为家境贫寒,条件不允许我没有试过,命令网上找的,如果有错误还请同学们在评论里留言帮我改正一下。

Mac  下编译, Linux  或者 Windows 的可执行程序

# linux可执行程序
CGO_ENABLED=0  GOOS=linux  GOARCH=amd64  go build main.go
# Windows 可执行程序
CGO_ENABLED=0 GOOS=windows  GOARCH=amd64  go  build  main.go

Linux 下编译 , Mac 或者 Windows 下去执行

# Mac 平台可执行程序
CGO_ENABLED=0 GOOS=darwin  GOARCH=amd64  go build main.go
# Windows可执行程序
CGO_ENABLED=0 GOOS=windows  GOARCH=amd64  go build main.go

Windows 下执行 , Mac 或  Linux 下去执行

需要写一个批处理程序,在里面去设置,因为windows 下的 terminal 不支持shell , 这跟 Mac 和 Linux下的有点不同

# Mac 下执行
SET  CGO_ENABLED=0
SET GOOS=darwin
SET GOARCH=amd64
go build main.go

#
 Linux 去执行
SET CGO_ENABLED=0
SET GOOS=linux
SET GOARCH=amd64
go build main.go

条件编译

交叉编译只是为了能在一个平台上编译出其他平台可运行的程序,Go 作为一个跨平台的语言,它提供的类库势必也是跨平台的,比如说程序的系统调用相关的功能,能根据所处环境选择对应的源码进行编译。让编译器只对满足条件的代码进行编译,将不满足条件的代码舍弃,这就是另外一个概念叫---条件编译。

在 Go 中,也称之为Build Constraints 编译约束,添加编译约束的方式有2种分别:

  • 编译标签(build tag)
  • 文件后缀

编译标签

编译标签是一种通过在源码文件顶部添加注释,来决定文件是否参与编译的约束方式。其格式如下:

// +build <tags>

注意:// +build的下一行必须是空行,否则会被解析为包注释。

// +build linux

// main package comment
package main

tags说明:

  • 以空格分开表示 AND
  • 以逗号分开表示 OR
  • !表示 NOT

标签可以指定为以下内容:

  • 操作系统,环境变量中GOOS的值,如:linuxdarwinwindows等等。
  • 操作系统的架构,环境变量中GOARCH的值,如:arch64x86i386等等。
  • 使用的编译器,gc或者gccgo
  • 是否开启CGO,cgo
  • golang版本号:比如Go Version 1.1为go1.1,Go Version 1.12版本为go1.12,以此类推。
  • 其它自定义标签,通过go build -tags指定的值。

例如,编译条件为(linux AND 386) OR (darwin AND (NOT cgo))

// +build linux,386 darwin,!cgo

另外一个文件可以有多个编译约束,比如条件为(linux OR darwin) AND amd64

// +build linux darwin
// +build amd64

也可以使用ignore标签将一个文件从编译中排除。

// +build ignore

文件后缀

除了编译标签,第二种添加编译约束的方法是通过源码文件的文件名实现的,这种方案比构造标签方案更简单。编译器也会根据文件后缀来自动选择编译文件:

$filename_$GOOS.go
$filename_$GOARCH.go
$filename_$GOOS_$GOARCH.go
  • $filename: 源文件名称。
  • $GOOS: 表示操作系统,从环境变量中获取。
  • $GOARCH: 表示系统架构,从环境变量中获取。

后缀的顺序记住不要颠倒,后缀中同时出现系统和架构名时,需要保持$filename_$GOOS_$GOARCH.go的顺序。

在 Go 的每个内置库里都有很多以不同系统名结尾的文件。下面是Goos内置库源代码的部分截图:


透过一个编译报错,总结两个Go程序编译的重要知识
文件后缀添加编译约束

两种添加编译限制的方式该如何选择

构建标签和文件名后缀在功能上是重叠的。比如,一个名为mypkg_linux.go的文件,再包含构建标签// +build linux会显得多余。

通常来说,当只有一个特定平台需要指定时,我们选择文件名后缀的方式。比如:

mypkg_linux.go         // 只在 linux 系统编译
mypkg_windows_amd64.go // 只在 windows amd 64位 平台编译

相反,如果你的文件需要指定给多个平台或体系架构使用,或者你需要排除某个特定平台时,我们选择构建标签的方式。比如:

// 在所有类unix平台编译
// +build darwin dragonfly freebsd linux netbsd openbsd

// 在非Windows平台编译
// +build !windows

总结

一个编译器报错,居然水了一篇文章....啊...(咳嗽声)引出来的交叉编译和条件编译(编译约束)这两个非常重要的知识点,其实这两个知识点在很早之前我也写过篇文章,这次相当于从实际遇到问题带出从头开始再分析一遍,希望大家能喜欢。

参考链接

  • http://www.oskip.com/post/golang/golang-build/
  • https://juejin.cn/post/6844903944808824845
  • https://mp.weixin.qq.com/s/Ys8o4arwIFYB6DPCdiGNNQ
- END -


扫码关注公众号「网管叨bi叨」


透过一个编译报错,总结两个Go程序编译的重要知识

给网管个星标,第一时间吸我的知识 

 

觉得好的话记得打赏赞助小灰灰哦,小灰灰灰更有动力的,谢谢

小灰灰

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: