在C/C++中可以通过宏定义实现条件编译,比如在不同平台的机器上,调用不同的函数,或者通过编译是传递参数,调用不同的函数,比如下面的例子
C++条件编译
1#include <iostream>
2
3#ifdef DEBUG
4
5void fun1() {
6 std::cout << "I am debug" << std::endl;
7}
8
9#else
10
11void fun1() {
12 std::cout << "I am release" << std::endl;
13}
14
15#endif
16
17int main() {
18 fun1();
19 return 0;
20}
现在就可以使用不同的编译参数,控制程序调用不同的函数
- 不添加参数,直接编译
g++ -o test main.cpp
程序中没有定义 DEBUG这个宏,所以程序最终会调用 I am release这个函数 执行程序验证一下
和我们预期的一样- 在编译的时候添加参数,让程序调用debug函数
g++ -DDEBUG -o test main.cpp
也没有问题,程序最终调用的是 I am debug 这个函数
go条件编译
go虽然不支持宏定义,但是go可以通过 build tags 实现类似的功能。
go的条件编译没有C++那么强大,可以在代码任意位置添加宏,实现条件编译,go的tags的作用范围是文件,也就是说go的编译器通过不同的tag去选择不同的文件。
先创建file.go
file_debug.go
main.go
这三个文件
file.go
1// +build !debug
2
3package main
4
5import "fmt"
6
7func Fun1() {
8 fmt.Println("I am release")
9}
file_debug.go
1// +build debug
2
3package main
4
5import "fmt"
6
7func Fun1() {
8 fmt.Println("I am debug")
9}
main.go
1package main
2
3func main() {
4 Fun1()
5}
go的tags有几个注意的点
// +build debug
必须在文件的最开始位置,一般在第一行//
和+
之间必须有一个空格// +build debug
下面必须有一个空行
只有满足这些条件后,这个tag才能正确的被编译器识别
先正常编译
go build -o release.exe
执行程序,最终程序调用的是I am release 这个函数在编译的时候,加参数使用debug版本的函数
go build -tags debug -o debug.exe
go1.17改变
在go1.17之前,go的build tags 格式是 // +build 条件
从go1.17开始,开始支持 //go:build 条件
这种格式了
//go:build 条件
这种格式有什么好处呢,最明显的就是关系运算更符合编程语法了
在之前,想要表示 windows 64位系统
或者 是 linux
系统需要下面的语法
// +build windows,amd64 linux
原来的build tags ,
是 and
空格
是 or
,不符合常见编程语言的语法
从go1.17开始,同样的条件可以这样写了
//go:build (windows && amd64) || linux
这个表达式就比之前的明显多了
开始测试一下
先创建file.go
file_x64.go
main.go
三个文件
file.go
1//go:build windows && 386
2
3package main
4
5import "fmt"
6
7func Fun1() {
8 fmt.Println("I am windows 386")
9}
file_x64
1//go:build windows && amd64
2
3package main
4
5import "fmt"
6
7func Fun1() {
8 fmt.Println("I am windows amd64")
9}
main.go
1package main
2
3func main() {
4 Fun1()
5}
编译 32位程序
编译64位程序
全都符合预期
实际应用
说了这么多,tags在实际开发中有什么用处呢。 最主要的就是功能就是可以通过编译参数控制使用那些代码编译得到程序。比如在不同的平台可以有不同的函数实现。不同的版本有不同的实现。
举个栗子
一般log都会有不同的级别,必须开发中可以通过多打印一些数据,方便调试。但是程序上线后,为了性能考虑会关闭一些低级别的log,只保留 error 和 waning 级别的log。
虽然现在大多数log库都有log级别,但是如果不需要打印的log,但是还是调用了函数,其实还是会有一部分性能开销的,比如函数调用开销,参数传递开销等。为了进一步压榨性能,可以通过tags 在编译程序的时候,把低等级的log直接不编译到程序中。
回到第一个示例中,修改一下代码
file.go
1// +build !debug
2
3package main
4
5import "fmt"
6
7func LogDebug(info string) {
8 fmt.Println(info)
9}
file_debug.go
1// +build debug
2
3package main
4
5func LogDebug(info string) {
6}
main.go
1package main
2
3func main() {
4 LogDebug("aaaaaaaaaaaa")
5}
可以看到,在非debug版本中,模拟正常打印log,在debug版本中,log函数只有一个空的函数,没有实现。 先编译两个程序,然后通过反编译看看两次函数调用的区别
执行如下命令
1go build -tags debug -o debug.exe
2go build -o release.exe
3go tool objdump -s "main.main" ./debug.exe > ./debug.s
4go tool objdump -s "main.main" ./release.exe > ./release.s
分别得到debug版本和release版本的汇编代码
debug.s
1TEXT main.main(SB) D:/goProject/src/build_tag/main.go
2 main.go:3 0x49e750 65488b0c2528000000 MOVQ GS:0x28, CX
3 main.go:3 0x49e759 488b8900000000 MOVQ 0(CX), CX
4 main.go:3 0x49e760 483b6110 CMPQ 0x10(CX), SP
5 main.go:3 0x49e764 0f8687000000 JBE 0x49e7f1
6 main.go:3 0x49e76a 4883ec58 SUBQ $0x58, SP
7 main.go:3 0x49e76e 48896c2450 MOVQ BP, 0x50(SP)
8 main.go:3 0x49e773 488d6c2450 LEAQ 0x50(SP), BP
9 main.go:4 0x49e778 488d0542fd0200 LEAQ go.string.*+5001(SB), AX
10 file.go:8 0x49e77f 48890424 MOVQ AX, 0(SP)
11 file.go:8 0x49e783 48c74424080c000000 MOVQ $0xc, 0x8(SP)
12 file.go:8 0x49e78c e87fb1f6ff CALL runtime.convTstring(SB)
13 file.go:8 0x49e791 488b442410 MOVQ 0x10(SP), AX
14 file.go:8 0x49e796 0f57c0 XORPS X0, X0
15 file.go:8 0x49e799 0f11442440 MOVUPS X0, 0x40(SP)
16 file.go:8 0x49e79e 488d0d3be70000 LEAQ runtime.types+57056(SB), CX
17 file.go:8 0x49e7a5 48894c2440 MOVQ CX, 0x40(SP)
18 file.go:8 0x49e7aa 4889442448 MOVQ AX, 0x48(SP)
19 print.go:274 0x49e7af 488b0592a50d00 MOVQ os.Stdout(SB), AX
20 print.go:274 0x49e7b6 488d0da3c40400 LEAQ go.itab.*os.File,io.Writer(SB), CX
21 print.go:274 0x49e7bd 48890c24 MOVQ CX, 0(SP)
22 print.go:274 0x49e7c1 4889442408 MOVQ AX, 0x8(SP)
23 print.go:274 0x49e7c6 488d442440 LEAQ 0x40(SP), AX
24 print.go:274 0x49e7cb 4889442410 MOVQ AX, 0x10(SP)
25 print.go:274 0x49e7d0 48c744241801000000 MOVQ $0x1, 0x18(SP)
26 print.go:274 0x49e7d9 48c744242001000000 MOVQ $0x1, 0x20(SP)
27 print.go:274 0x49e7e2 e8e998ffff CALL fmt.Fprintln(SB)
28 file.go:8 0x49e7e7 488b6c2450 MOVQ 0x50(SP), BP
29 file.go:8 0x49e7ec 4883c458 ADDQ $0x58, SP
30 file.go:8 0x49e7f0 c3 RET
31 main.go:3 0x49e7f1 e87acffbff CALL runtime.morestack_noctxt(SB)
32 main.go:3 0x49e7f6 e955ffffff JMP main.main(SB)
可以看到在debug版本中,LogDebug
函数已经被编译器内联处理了。最终程序是调用了fmt.Println
函数。
release.s
1TEXT main.main(SB) D:/goProject/src/build_tag/main.go
2 main.go:4 0x45b630 c3 RET
3 :0 0x45b631 cc INT $0x3
4 :0 0x45b632 cc INT $0x3
5 :0 0x45b633 cc INT $0x3
6 :0 0x45b634 cc INT $0x3
7 :0 0x45b635 cc INT $0x3
8 :0 0x45b636 cc INT $0x3
9 :0 0x45b637 cc INT $0x3
10 :0 0x45b638 cc INT $0x3
11 :0 0x45b639 cc INT $0x3
12 :0 0x45b63a cc INT $0x3
13 :0 0x45b63b cc INT $0x3
14 :0 0x45b63c cc INT $0x3
15 :0 0x45b63d cc INT $0x3
16 :0 0x45b63e cc INT $0x3
17 :0 0x45b63f cc INT $0x3
相比之下,release版本的汇编代码就简单多了,因为编译器会进行内联处理,但是发现LogDebug
这个函数是一个空函数,所以就直接跳过编译了。
总结
- go也可以实现条件编译,但是不能像C++那样灵活,只能以文件为单位
- 在go1.17之前使用
// +build 条件
,从1.17开始可以使用//go:build 条件
- go预设了很多tags,也可以自定义tags
- 在编译时,使用 -tags 个自定义的tags赋值