在格式化 Go 代碼的時候,經常會用到 gofmt 和 goimports 兩個工具,不過他們之間到底有何區別呢?
In addition to fixing imports, goimports also formats your code in the same style as gofmt so it can be used as a replacement for your editor’s gofmt-on-save hook.
根據 goimports 文檔的一段說明,goimports 除了修正 import 代碼塊外,和 gofmt 沒其他區別。至於 import 代碼塊修正,舉個栗子來說明下。
例子
1package main
2
3import "stringsx"
4
5import "fmt"
6
7import "os"
8
9func Title(s string) {
10 fmt.Println(strings.Title(s))
11}
12
13func main() {
14 Title("hello world")
15}
這裡我特意將每個 import 順序亂序,並相隔一行,其中 stringsx 是錯誤的包名,os 是沒有使用到的包。
我們的期望應該是可以將 import 的包進行排序,去掉未使用的包,並且可以修正錯誤的包名。
gofmt
首先看下 gofmt 的格式化結果:
1package main
2
3import "stringsx"
4
5import "fmt"
6
7import "os"
8
9func Title(s string) {
10 fmt.Println(strings.Title(s))
11}
12
13func main() {
14 Title("hello world")
15}
goimports
安裝:
go get golang.org/x/tools/cmd/goimports
接著對比 goimports 結果:
1package main
2
3import (
4 "fmt"
5 "strings"
6)
7
8func Title(s string) {
9 fmt.Println(strings.Title(s))
10}
11
12func main() {
13 Title("hello world")
14}
結論
相對 gofmt,goimports 可以對 import 的包進行排序,去除未使用的包,並修正錯誤的包名。簡而言之,goimports 比 gofmt 更好用,對於強迫症必不可缺。
題外話
goimports 排序後,內置包和非內置包會有一空行相隔:
1import (
2 "errors"
3 ...
4
5 "github.com/foo/bar"
6 ...
7)