build tag允许进行有限的条件编译,即根据某些条件编译不同版本的代码。
标签是在每个文件的顶部指定的,然后是空行和代码。
标签的典型用例是提供相同功能的实现,并选择使用标签编译的功能。
比如,在一个目录中有三个文件:
foo_alt.go
// +build alt
package main
func foo() {
fmt.Printf("This is alternative foo\n")
}
foo.go
// You can have other comments before build tags
// +build !alt
package main
func foo() {
fmt.Printf("This is regular foo\n")
}
main.go
package main
func main() {
foo()
}
不使用build tag来编译:
go build -o main .
./main
This is non-alt foo
使用alt build标签进行编译:
go build -tags alt -o main_alt .
./main_alt
This is alternative foo
当我们指定-tags alt时,我们编译了foo_alt.go文件,因为它包含// // + build alt指令,如果-tags选项提供了build tag alt,它会告诉构建工具编译文件。
我们没有编译foo.go文件,因为它包含// // build!alt指令,该指令告诉构建程序不要编译是否提供了build alt。
同样,如果我们没有为go build命令指定任何构建标记,则文件foo.go会被编译(因为它只说如果提供了alt标记就不会编译),并且foo_alt.go也不会被编译。
参数-tags适用于许多命令,例如 去运行,去安装,去测试等等。
指定多个标签
您可以指定多个构建约束(标签):
// +build tag1,tag2 tag3,!tag4
// +build tag5
package foo
这对条件(tag1 AND tag2)或(tag3 AND(NOT tag4))AND tag5进行编码。
同样,对于go命令:go build -tags“ tag1 tag2”。
忽略文件(从编译中排除)
// +build ignore
package foo
预定义的构建标签
Go工具链使用几个构建标记:
- arm, arm64, 386, amd64, s390x : 针对不同的处理器架构
- windows, darwin, linux, dragonfly, freebsd, netbsd, openbsd, plan9, solaris, android : 针对不同的操作系统
- cgo : 当启用cgo
- gc gccgo : 用于gc和gccgo工具链
- go1.11 for Go version 1.11+, go1.12 for Go version 1.12+ etc.
使用文件名代替构建标签
在文件中提供构建标签指令的另一种方法是使用文件名后缀,例如 foo_windows.go等效于在文件中包含// + build Windows。
陷阱
以下内容无法正常工作:
// +build alt
package main
func foo() {
fmt.Printf("This is alternative foo\n")
}
构建标记行后需要一个空行:
// +build alt
package main
单独的集成测试
构建标记的一个常见用例是将常规单元测试与需要外部资源(例如数据库或网络访问权限)的集成测试分开。
为此,将自定义构建约束添加到测试文件的顶部:
// +build integration
package main
import (
"testing"
)
func TestThatRequiresNetworkAccess(t *testing.T) {
t.Fatal("It failed!")
}
除非您使用go test -tags“ integration”运行测试,否则这些测试将无法编译:
go test -tags "integration"
--- FAIL: TestThatRequiresNetworkAccess (0.00s)
main_test.go:10: It failed!
FAIL
exit status 1
FAIL bitbucket.org/yourname/yourproject 0.003s
针对特定架构的优化实施
构建标签的另一个用例是编写利用特定体系结构的功能的优化实现。
例如,Go标准库使用此技术来实现优化的异或功能。
xor_generic.go
// +build !amd64,!ppc64,!ppc64le
package cipher
func xorBytes(dst, a, b []byte) int {
// generic implementation if more specific is not available
}
xor_ppc64x.go
// +build ppc64 ppc64le
package cipher
func xorBytes(dst, a, b []byte) int {
// implementation specific to ppc64 processor
}
开发与生产版本
对于后端服务器,通常需要在其中配置开发配置和生产配置(指向其他数据库服务器等)。
// !build dev
package config
const (
MONGODB_HOST = "mongodb://127.0.0.1:27017"
)
// !build prod
package config
const (
MONGODB_HOST = "mongodb://mongo.myserver.com:27017"
)
然后,我们构建go build -tags dev进行开发构建,并构建go build -tags prod进行生产构建。