golang条件编译

开篇

golang中没有相似C语言中条件编译的写法,好比在C代码中可使用以下语法作一些条件编译,结合宏定义来使用能够实现诸如按需编译release和debug版本代码的需求linux

#ifndef
#define
...

#end

可是golang支持两种条件编译方式golang

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

编译标签( build tag)

在源代码里添加标注,一般称之为编译标签( build tag),编译标签是在尽可能靠近源代码文件顶部的地方用注释的方式添加windows

go build在构建一个包的时候会读取这个包里的每一个源文件而且分析编译便签,这些标签决定了这个源文件是否参与本次编译架构

编译标签添加的规则(附上原文):app

  1. a build tag is evaluated as the OR of space-separated options
  2. each option evaluates as the AND of its comma-separated terms
  3. each term is an alphanumeric word or, preceded by !, its negation

1). 编译标签由空格分隔的编译选项(options)以"或"的逻辑关系组成ui

2). 每一个编译选项由逗号分隔的条件项以逻辑"与"的关系组成this

3). 每一个条件项的名字用字母+数字表示,在前面加!表示否认的意思lua

例子(编译标签要放在源文件顶部)spa

// +build darwin freebsd netbsd openbsd

这个将会让这个源文件只能在支持kqueue的BSD系统里编译debug

一个源文件里能够有多个编译标签,多个编译标签之间是逻辑"与"的关系

// +build linux darwin
// +build 386

这个将限制此源文件只能在 linux/386或者darwin/386平台下编译.
除了添加系统相关的tag,还能够自由添加自定义tag达到其它目的。
编译方法:
只须要在go build指令后用-tags指定编译条件便可

go build -tags mytag1 mytag2

注意:刚开始使用编译标签常常会犯下面这个错误

// +build !linux
package mypkg // wrong

这个例子里的编译标签和包的声明之间没有用空行隔开,这样编译标签会被当作包声明的注释而不是编译标签从而被忽略掉

下面这个是正确的标签的书写方式,标签的结尾添加一个空行这样标签就不会当作其余声明的注释

// +build !linux

package mypkg // correct

用go vet命令也能够检测到这个缺乏空行的错误,初期能够用这个命令来避免缺乏空行的错误

% go vet mypkg
mypkg.go:1: +build comment appears too late in file
exit status 1

做为参考,下面的例子将licence声明,编译标签和包声明放在一块儿,请你们注意分辨

% head headspin.go

// Copyright 2013 Way out enterprises. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// +build someos someotheros thirdos,!amd64

// Package headspin implements calculates numbers so large
// they will make your head spin.
package headspin

文件后缀

这个方法经过改变文件名的后缀来提供条件编译,这种方案比编译标签要简单,go/build能够在不读取源文件的状况下就能够决定哪些文件不须要参与编译。文件命名约定能够在go/build 包里找到详细的说明,简单来讲若是你的源文件包含后缀:_GOOS.go,那么这个源文件只会在这个平台下编译,_GOARCH.go也是如此。这两个后缀能够结合在一块儿使用,可是要注意顺序:_GOOS_GOARCH.go, 不能反过来用:_GOARCH_GOOS.go.
例子以下:

mypkg_freebsd_arm.go // only builds on freebsd/arm systems
mypkg_plan9.go       // only builds on plan9

编译标签和文件后缀的选择

编译标签和文件后缀的功能上有重叠,例如一个文件名:mypkg_linux.go包含了// +build linux将会出现冗余

一般状况下,若是源文件与平台或者cpu架构彻底匹配,那么用文件后缀,例如:

mypkg_linux.go         // only builds on linux systems
mypkg_windows_amd64.go // only builds on windows 64bit platforms

相反,若是知足如下任何条件,那么使用编译标签:

  • 这个源文件能够在超过一个平台或者超过一个cpu架构下可使用
  • 须要去除指定平台
  • 有一些自定义的编译条件
相关文章
相关标签/搜索