45.Go 使用构建标签进行条件编译

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 ? bitbucket.org/yourname/yourproject [no test files] 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进行生产构建。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容