Go1.17 新特性：新版構(gòu)建約束

大家好，我是 polarisxu。

Go 1.17 下個月就要正式發(fā)布了。很多人要問泛型了吧，泛型已經(jīng)很明確了，Go1.18 會有。今天給大家介紹 Go1.17 的一個新特性：構(gòu)建約束 — Build Constraints。

確切來說，這個特性相關(guān)的工作在 1.16 時就加入，但處于過度階段，1.17 在各方面都更完善，更完整的支持，是時候了解它了。

01 什么是構(gòu)建約束

構(gòu)建約束（build constraint），也叫做構(gòu)建標(biāo)記（build tag），是在 Go 源文件最開始的注釋行，比如：

// +build linux

看到這個，相信很多人都不陌生，因為這是 Go 一開始就有的特性，在 Go 源碼中有很多這樣的注釋行。上面注釋行的意思，這個文件只在 Linux 系統(tǒng)會包含在包中，其他系統(tǒng)會忽略這個文件。

幾個注意點(diǎn)：

• 約束可以出現(xiàn)在任何源文件中，比如 .go、.s 等；
• 必須在文件頂部附近，它的前面只能有空行或其他注釋行；可見包子句也在約束之后；
• 約束可以有多行；
• 為了區(qū)別約束和包文檔，在約束之后必須有空行；

針對某個構(gòu)建約束，可使用的詞如下：

• 特定操作系統(tǒng)，對應(yīng) runtime.GOOS 的可用值，比如 linux、windows 等；
• 特定的架構(gòu)，對應(yīng) runtime.GOARCH 的可用值，比如 386、amd64 等；
• 使用的編譯器，比如 gc、gccgo；
• 支持 cgo 命令時，可以使用 cgo；
• Go 的主要發(fā)布版本，比如 go1.17、go1.16 等；（測試版本和 fixbug 版本不支持）
• 自定義的 tag，編譯時通過 -tags 傳遞的值；
• 可以加入任意值，一般用 ignore 來忽略構(gòu)建；

此外，文件名可以通過 GOOS 和 GOARCH 來做構(gòu)建約束。

02 舊版構(gòu)建約束

從上面看到，構(gòu)建約束的語法是 // +build 這種形式，如果多個條件組合，通過空格、逗號或多行構(gòu)建約束表示。比如：

// +build linux,386

你知道什么意思嗎？表示在 linux AND 386。逗號表示 AND，空格表示 OR。那看一個復(fù)雜的：

// +build linux,386 darwin,!cgo

是不是有點(diǎn)懵？我也有點(diǎn)懵！它表示的意思是：(linux AND 386) OR (darwin AND (NOT cgo)) 。

有些時候，多個約束分成多行書寫，會更易讀些：

// +build linux darwin
// +build amd64

這相當(dāng)于：(linux OR darwin) AND amd64 。

是不是很復(fù)雜，很難記憶？

正因為太復(fù)雜，很容易出錯。而且，Go 中有不少注釋是有特殊意義的，也為了一致性考慮，因此有了新版的構(gòu)建約束。

03 新版構(gòu)建約束

在 Go 源碼中，經(jīng)常會見到類似下面開頭的注釋：

//go:link

新版的構(gòu)建約束，也使用了 //go: 開頭：

//go:build

注意 // 和 go 之間不能有空格。

同時新版語法使用布爾表達(dá)式，而不是逗號、空格等。布爾表達(dá)式，會更清晰易懂，出錯可能性大大降低。

比如舊語法：

// +build linux,386

對應(yīng)的新語法：

//go:build linux && 386

構(gòu)建標(biāo)記的基礎(chǔ)語法與其當(dāng)前形式?jīng)]有變化，但是構(gòu)建標(biāo)記的組合現(xiàn)在是用 Go 的 || 、 && 和 ! 運(yùn)算符和括號。（請注意，構(gòu)建標(biāo)記并不總是有效的 Go 表達(dá)式，即使它們共享操作符，因為標(biāo)記并不總是有效的標(biāo)識符。例如：”go1.1"。)

新語法可以使用 Go spec 的 EBNF 標(biāo)記來表示：

BuildLine      = "http://go:build" Expr
Expr           = OrExpr
OrExpr         = AndExpr   { "||" AndExpr }
AndExpr        = UnaryExpr { "&&" UnaryExpr }
UnaryExpr      = "!" UnaryExpr | "(" Expr ")" | tag
tag            = tag_letter { tag_letter }
tag_letter     = unicode_letter | unicode_digit | "_" | "."

采用新語法后，一個文件只能有一行構(gòu)建語句，而不是像舊版那樣有多行。這樣可以避免多行的關(guān)系到底是什么的問題。

Go1.17 中，gofmt 工具會自動根據(jù)舊版語法生成對應(yīng)的新版語法，為了兼容性，兩者都會保留。比如原來是這樣的：

// +build !windows,!plan9

執(zhí)行 Go1.17 的 gofmt 后，變成了這樣：

//go:build !windows && !plan9
// +build !windows,!plan9

如果文件中已經(jīng)有了這兩種約束形式，gofmt 會根據(jù) //go:buid 自動覆蓋 // +build 的形式，確保兩者表示的意思一致。如果只有新版語法，不會自動生成舊版的，這時，你需要注意，它不兼容舊版本了。

另外，Vet 工具現(xiàn)在能夠檢測出兩種語法的不一致。所以，建議大家在編輯器中保存文件時自動執(zhí)行 gofmt。

早在 Go1.16 時就新增了一個包：go/build/constraint，專門處理新版構(gòu)建約束。

關(guān)于新版約束的設(shè)計文檔請移步：https://go.googlesource.com/proposal/+/master/design/draft-gobuild.md。

04 總結(jié)

新版本的構(gòu)建約束可讀性更強(qiáng)，更容易書寫，不容易出錯。有興趣的可以自己針對構(gòu)建約束，同時書寫兩種形式，體會下新版的好處。

最后提醒一點(diǎn)，新版約束中，一定要注意 // 和 go 之間不能有空格！