Uber Go 風格指南（譯）

博客地址：note.mogutou.xyz/articles/20…

Uber Go 風格指南

• 譯文：github.com/Allenxuxu/u…
• 原文：github.com/uber-go/gui…

簡介

風格是指規範代碼的共同約定。風格一詞實際上是有點用詞不當的，由於共同約定的範疇遠遠不止 gofmt 所作的源代碼格式化這些。

本指南旨在經過詳盡描述 Uber 在編寫 Go 代碼中的注意事項（規定）來解釋其中複雜之處。制定這些注意事項（規定）是爲了提升代碼可維護性同時也讓工程師們高效的使用 Go 的特性。

這份指南最初由 Prashant Varanasi 和 Simon Newton 編寫，目的是讓一些同事快速上手 Go 。多年來，已經根據其餘人的反饋不斷修改。

這份文檔記錄了咱們在 Uber 遵照的 Go 慣用準則。其中不少準則是 Go 的通用準則，其餘方面依賴於外部資源：

1. Effective Go
2. The Go common mistakes guide

全部的代碼都應該經過 golint 和 go vet 檢查。咱們建議您設置編輯器：

• 保存時自動運行 goimports
• 自動運行 golint 和 go vet 來檢查錯誤

您能夠在這找到關於編輯器設定 Go tools 的相關信息：

github.com/golang/go/w…

指南

指向接口（interface）的指針

你基本永遠不須要一個指向接口的指針。你應該直接將接口做爲值傳遞，由於接口的底層數據就是指針。

一個接口包含兩個字段：

1. 類型指針，指向某些特定類型信息的指針。
2. 數據指針。若是存儲數據是一個指針變量，那就直接存儲。若是存儲數據是一個值變量，那就存儲指向該值的指針。

若是你須要接口方法來修改這些底層數據，那你必須使用指針。

方法接收器和接口

具備值類型接收器的方法能夠被值類型和指針類型調用。

例如，

type S struct {
  data string
}

func (s S) Read() string {
  return s.data
}

func (s *S) Write(str string) {
  s.data = str
}

sVals := map[int]S{1: {"A"}}

// 值類型變量只能調用 Read 方法
sVals[1].Read()

// 沒法編譯經過:
// sVals[0].Write("test")

sPtrs := map[int]*S{1: {"A"}}

// 指針類型變量能夠調用 Read 和 Write 方法：
sPtrs[1].Read()
sPtrs[1].Write("test")
複製代碼

同理，即便方法是值類型接收器，接口也能夠經過指針來知足調用需求。

type F interface {
  f()
}

type S1 struct{}

func (s S1) f() {}

type S2 struct{}

func (s *S2) f() {}

s1Val := S1{}
s1Ptr := &S1{}
s2Val := S2{}
s2Ptr := &S2{}

var i F
i = s1Val
i = s1Ptr
i = s2Ptr

// 沒法編譯經過, 由於 s2Val 是一個值類型變量, 而且 f 方法不具備值類型接收器。
// i = s2Val
複製代碼

Effective Go 中關於 Pointers vs. Values 寫的很棒。

零值Mutexes是有效的

零值的 sync.Mutex 和 sync.RWMutex 是有效的，因此基本是不須要一個指向 Mutex 的指針的。

Bad	Good
mu := new(sync.Mutex) mu.Lock() 複製代碼	var mu sync.Mutex mu.Lock() 複製代碼

若是你但願經過指針操做結構體，mutex 能夠做爲其非指針結構體字段，或者最好直接嵌入結構體中。

type smap struct { sync.Mutex data map[string]string } func newSMap() *smap { return &smap{ data: make(map[string]string), } } func (m *smap) Get(k string) string { m.Lock() defer m.Unlock() return m.data[k] } 複製代碼	type SMap struct { mu sync.Mutex data map[string]string } func NewSMap() *SMap { return &SMap{ data: make(map[string]string), } } func (m *SMap) Get(k string) string { m.mu.Lock() defer m.mu.Unlock() return m.data[k] } 複製代碼
嵌入到非導出類型或者須要實現 Mutex 接口的類型。	對於導出類型，將 mutex 做爲私有成員變量。

Slices和Maps的邊界拷貝操做

切片和 map 包含一個指針來指向底層數據，因此當須要複製他們時須要特別注意。

接收Slices和Maps

請記住，若是存儲了對 slice 或 map 的引用，那麼用戶是能夠對其進行修改。

Bad	Good
func (d *Driver) SetTrips(trips []Trip) { d.trips = trips } trips := ... d1.SetTrips(trips) // 是想修改 d1.trips 嗎？ trips[0] = ... 複製代碼	func (d *Driver) SetTrips(trips []Trip) { d.trips = make([]Trip, len(trips)) copy(d.trips, trips) } trips := ... d1.SetTrips(trips) // 修改 trips[0] 而且不影響 d1.trips 。 trips[0] = ... 複製代碼

返回 Slices 和 Maps

同理，謹慎提防用戶修改暴露內部狀態的 slices 和 maps 。

Bad	Good
type Stats struct { sync.Mutex counters map[string]int } // Snapshot 返回當前狀態 func (s *Stats) Snapshot() map[string]int { s.Lock() defer s.Unlock() return s.counters } // snapshot 再也不受鎖保護了！ snapshot := stats.Snapshot() 複製代碼	type Stats struct { sync.Mutex counters map[string]int } func (s *Stats) Snapshot() map[string]int { s.Lock() defer s.Unlock() result := make(map[string]int, len(s.counters)) for k, v := range s.counters { result[k] = v } return result } // snapshot 是一分拷貝的內容了 snapshot := stats.Snapshot() 複製代碼

使用 defer 來作清理工做

使用 defer 來作資源的清理工做，例如文件的關閉和鎖的釋放。

Bad	Good
p.Lock() if p.count < 10 { p.Unlock() return p.count } p.count++ newCount := p.count p.Unlock() return newCount // 當有多處 return 時容易忘記釋放鎖 複製代碼	p.Lock() defer p.Unlock() if p.count < 10 { return p.count } p.count++ return p.count // 可讀性更高 複製代碼

defer 只有很是小的性能開銷，只有當你能證實你的函數執行時間在納秒級別時才能夠不使用它。使用 defer 對代碼可讀性的提升是很是值得的，由於使用 defer 的成本真的很是小。特別是在一些主要是作內存操做的長函數中，函數中的其餘計算操做遠比 defer 重要。

Channel 的大小設爲 1 仍是 None

通道的大小一般應該設爲 1 或者設爲無緩衝類型。默認狀況下，通道是無緩衝類型的，大小爲 0 。將通道大小設爲其餘任何數值都應該通過深思熟慮。認真考慮如何肯定其大小，是什麼阻止了工做中的通道被填滿並阻塞了寫入操做，以及何種狀況會發生這樣的現象。

Bad	Good
// 足以知足任何人！ c := make(chan int, 64) 複製代碼	// 大小 爲 1 c := make(chan int, 1) // or // 無緩衝 channel, 大小爲 0 c := make(chan int) 複製代碼

枚舉類型值從 1 開始

在 Go 中使用枚舉的標準方法是聲明一個自定義類型並經過 iota 關鍵字來聲明一個 const 組。可是因爲 Go 中變量的默認值都爲該類型的零值，因此枚舉變量的值應該從非零值開始。

Bad	Good
type Operation int const ( Add Operation = iota Subtract Multiply ) // Add=0, Subtract=1, Multiply=2 複製代碼	type Operation int const ( Add Operation = iota + 1 Subtract Multiply ) // Add=1, Subtract=2, Multiply=3 複製代碼

在某些狀況下，從零值開始也是能夠的。例如，當零值是咱們指望的默認行爲時。

type LogOutput int

const (
  LogToStdout LogOutput = iota
  LogToFile
  LogToRemote
)

// LogToStdout=0, LogToFile=1, LogToRemote=2
複製代碼

錯誤類型

有不少種方法來聲明 errors:

• errors.New 聲明簡單的靜態字符串錯誤信息
• fmt.Errorf 聲明格式化的字符串錯誤信息
• 爲自定義類型實現 Error() 方法
• 經過 "pkg/errors".Wrap 包裝錯誤類型

返回錯誤時，請考慮如下因素來做出最佳選擇：

• 這是一個不須要其餘額外信息的簡單錯誤嗎？若是是，使用error.New。
• 客戶須要檢測並處理此錯誤嗎？若是是，那應該自定義類型，並實現 Error() 方法。
• 是不是在傳遞一個下游函數返回的錯誤？若是是，請查看error 封裝部分。
• 其餘，使用 fmt.Errorf 。

若是客戶須要檢測錯誤，而且是經過 errors.New 建立的一個簡單的錯誤，請使用var 聲明這個錯誤類型。

Bad	Good
// package foo func Open() error { return errors.New("could not open") } // package bar func use() { if err := foo.Open(); err != nil { if err.Error() == "could not open" { // handle } else { panic("unknown error") } } } 複製代碼	// package foo var ErrCouldNotOpen = errors.New("could not open") func Open() error { return ErrCouldNotOpen } // package bar if err := foo.Open(); err != nil { if err == foo.ErrCouldNotOpen { // handle } else { panic("unknown error") } } 複製代碼

若是你有一個錯誤須要客戶端來檢測，而且你想向其添加更多信息（例如，它不是一個簡單的靜態字符串），那麼應該聲明一個自定義類型。

Bad	Good
func open(file string) error { return fmt.Errorf("file %q not found", file) } func use() { if err := open(); err != nil { if strings.Contains(err.Error(), "not found") { // handle } else { panic("unknown error") } } } 複製代碼	type errNotFound struct { file string } func (e errNotFound) Error() string { return fmt.Sprintf("file %q not found", e.file) } func open(file string) error { return errNotFound{file: file} } func use() { if err := open(); err != nil { if _, ok := err.(errNotFound); ok { // handle } else { panic("unknown error") } } } 複製代碼

直接將自定義的錯誤類型設爲導出須要特別當心，由於這意味着他們已經成爲包的公開 API 的一部分了。更好的方式是暴露一個匹配函數來檢測錯誤。

// package foo

type errNotFound struct {
  file string
}

func (e errNotFound) Error() string {
  return fmt.Sprintf("file %q not found", e.file)
}

func IsNotFoundError(err error) bool {
  _, ok := err.(errNotFound)
  return ok
}

func Open(file string) error {
  return errNotFound{file: file}
}

// package bar

if err := foo.Open("foo"); err != nil {
  if foo.IsNotFoundError(err) {
    // handle
  } else {
    panic("unknown error")
  }
}
複製代碼

Error 封裝

下面提供三種主要的方法來傳遞函數調用失敗返回的錯誤：

• 若是想要維護原始錯誤類型而且不須要添加額外的上下文信息，就直接返回原始錯誤。
• 使用 "pkg/errors".Wrap 來增長上下文信息，這樣返回的錯誤信息中就會包含更多的上下文信息，而且經過 "pkg/errors".Cause 能夠提取出原始錯誤信息。
• 若是調用方不須要檢測或處理特定的錯誤狀況，就直接使用 fmt.Errorf 。

狀況容許的話建議增長更多的上下文信息來代替諸如 "connection refused" 之類模糊的錯誤信息。返回 "failed to call service foo: connection refused" 用戶能夠知道更多有用的錯誤信息。

在將上下文信息添加到返回的錯誤時，請避免使用 "failed to" 之類的短語以保持信息簡潔，這些短語描述的狀態是顯而易見的，而且會隨着錯誤在堆棧中的傳遞而逐漸堆積：

Bad	Good
s, err := store.New() if err != nil { return fmt.Errorf( "failed to create new store: %s", err) } 複製代碼	s, err := store.New() if err != nil { return fmt.Errorf( "new store: %s", err) } 複製代碼
failed to x: failed to y: failed to create new store: the error 複製代碼	x: y: new store: the error 複製代碼

可是，若是這個錯誤信息是會被髮送到另外一個系統時，必須清楚的代表這是一個錯誤（例如，日誌中 err 標籤或者 Failed 前綴）。

另見 Don't just check errors, handle them gracefully。

處理類型斷言失敗

類型斷言的單返回值形式在遇到類型錯誤時會直接 panic 。所以，請始終使用 "comma ok" 慣用方法。

Bad	Good
t := i.(string) 複製代碼	t, ok := i.(string) if !ok { // handle the error gracefully } 複製代碼

不要 Panic

生產級的代碼必須避免 panics 。panics 是級聯故障的主要源頭。若是錯誤發生，函數應該返回錯誤而且容許調用者決定若是處理它。

Bad	Good
func foo(bar string) { if len(bar) == 0 { panic("bar must not be empty") } // ... } func main() { if len(os.Args) != 2 { fmt.Println("USAGE: foo <bar>") os.Exit(1) } foo(os.Args[1]) } 複製代碼	func foo(bar string) error { if len(bar) == 0 return errors.New("bar must not be empty") } // ... return nil } func main() { if len(os.Args) != 2 { fmt.Println("USAGE: foo <bar>") os.Exit(1) } if err := foo(os.Args[1]); err != nil { panic(err) } } 複製代碼

Panic/recover 並非錯誤處理策略。程序只有在遇到沒法處理的狀況下才能夠 panic ，例如，nil 引用。程序初始化時是一個例外狀況：程序啓動時遇到須要終止執行的錯誤可能會 painc 。

var _statusTemplate = template.Must(template.New("name").Parse("_statusHTML"))
複製代碼

即便是在測試中，也應優先選擇 t.Fatal 或 t.FailNow 而非 panic，以確保測試標記爲失敗。

Bad	Good
// func TestFoo(t *testing.T) f, err := ioutil.TempFile("", "test") if err != nil { panic("failed to set up test") } 複製代碼	// func TestFoo(t *testing.T) f, err := ioutil.TempFile("", "test") if err != nil { t.Fatal("failed to set up test") } 複製代碼

使用 go.uber.org/atomic

Go 的 sync/atomic 包僅僅提供針對原始類型（int32, int64, ...）的原子操做。所以，很容易忘記使用原子操做來讀寫變量。

go.uber.org/atomic 經過隱藏基礎類型，使這些操做類型安全。而且，它還提供一個方便的 atomic.Bool 類型。

Bad	Good
type foo struct { running int32 // atomic } func (f* foo) start() { if atomic.SwapInt32(&f.running, 1) == 1 { // already running… return } // start the Foo } func (f *foo) isRunning() bool { return f.running == 1 // race! } 複製代碼	type foo struct { running atomic.Bool } func (f *foo) start() { if f.running.Swap(true) { // already running… return } // start the Foo } func (f *foo) isRunning() bool { return f.running.Load() } 複製代碼

性能

性能方面的特定準則，僅適用於熱路徑。

strconv 性能優於 fmt

將原語轉換爲字符串或從字符串轉換時，strconv 速度比 fmt 更快。

Bad	Good
for i := 0; i < b.N; i++ { s := fmt.Sprint(rand.Int()) } 複製代碼	for i := 0; i < b.N; i++ { s := strconv.Itoa(rand.Int()) } 複製代碼
BenchmarkFmtSprint-4 143 ns/op 2 allocs/op 複製代碼	BenchmarkStrconv-4 64.2 ns/op 1 allocs/op 複製代碼

避免 string to byte 的轉換

不要反覆地從字符串字面量建立 byte 切片。相反，執行一次轉換後存儲結果供後續使用。

Bad	Good
for i := 0; i < b.N; i++ { w.Write([]byte("Hello world")) } 複製代碼	data := []byte("Hello world") for i := 0; i < b.N; i++ { w.Write(data) } 複製代碼
BenchmarkBad-4 50000000 22.2 ns/op 複製代碼	BenchmarkGood-4 500000000 3.25 ns/op 複製代碼

代碼風格

聲明分組

Go 支持將類似的聲明分組：

Bad	Good
import "a" import "b" 複製代碼	import ( "a" "b" ) 複製代碼

分組一樣適用於常量、變量和類型的聲明：

Bad	Good
const a = 1 const b = 2 var a = 1 var b = 2 type Area float64 type Volume float64 複製代碼	const ( a = 1 b = 2 ) var ( a = 1 b = 2 ) type ( Area float64 Volume float64 ) 複製代碼

僅將類似的聲明放在同一組。不相關的聲明不要放在同一個組內。

Bad	Good
type Operation int const ( Add Operation = iota + 1 Subtract Multiply ENV_VAR = "MY_ENV" ) 複製代碼	type Operation int const ( Add Operation = iota + 1 Subtract Multiply ) const ENV_VAR = "MY_ENV" 複製代碼

聲明分組能夠在任意位置使用。例如，能夠在函數內部使用。

Bad	Good
func f() string { var red = color.New(0xff0000) var green = color.New(0x00ff00) var blue = color.New(0x0000ff) ... } 複製代碼	func f() string { var ( red = color.New(0xff0000) green = color.New(0x00ff00) blue = color.New(0x0000ff) ) ... } 複製代碼

Import 組內順序

import 有兩類導入組：

• 標準庫
• 其餘

goimports 默認的分組以下：

Bad	Good
import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) 複製代碼	import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) 複製代碼

包名

當爲包命名時，請注意以下事項：

• 字符所有小寫，沒有大寫或者下劃線
• 在大多數狀況下引入包不須要去重命名
• 簡單明瞭，命名須要可以在被導入的地方準確識別
• 不要使用複數。例如，net/url, 而不是 net/urls
• 不要使用「common」，「util」，「shared」或「lib」之類的。這些都是很差的，表達信息不明的名稱

另見 Package Names 和 Style guideline for Go packages

函數命名

咱們遵循 Go 社區關於使用的 MixedCaps for function names。有一種狀況例外，對相關的測試用例進行分組時，函數名可能包含下劃線，如: TestMyFunction_WhatIsBeingTested。

包導入別名

若是包的名稱與導入路徑的最後一個元素不匹配，那必須使用導入別名。

import (
  "net/http"

  client "example.com/client-go"
  trace "example.com/trace/v2"
)
複製代碼

在其餘狀況下，除非導入的包名之間有直接衝突，不然應避免使用導入別名。

Bad	Good
import ( "fmt" "os" nettrace "golang.net/x/trace" ) 複製代碼	import ( "fmt" "os" "runtime/trace" nettrace "golang.net/x/trace" ) 複製代碼

函數分組與排布順序

• 函數應該粗略的按照調用順序來排布
• 同一文件中的函數應該按照接收器的類型來分組排布

因此，公開的函數應排布在文件首，並在 struct、const 和 var 定義以後。

newXYZ()/ NewXYZ() 之類的函數應該排布在聲明類型以後，具備接收器的其他方法以前。

由於函數是按接收器類別分組的，因此普通工具函數應排布在文件末尾。

Bad	Good
func (s *something) Cost() { return calcCost(s.weights) } type something struct{ ... } func calcCost(n int[]) int {...} func (s *something) Stop() {...} func newSomething() *something { return &something{} } 複製代碼	type something struct{ ... } func newSomething() *something { return &something{} } func (s *something) Cost() { return calcCost(s.weights) } func (s *something) Stop() {...} func calcCost(n int[]) int {...} 複製代碼

減小嵌套

代碼應該經過儘量地先處理錯誤狀況/特殊狀況，而且及早返回或繼續下一循環來減小嵌套。儘可能減小嵌套於多個級別的代碼數量。

Bad	Good
for _, v := range data { if v.F1 == 1 { v = process(v) if err := v.Call(); err == nil { v.Send() } else { return err } } else { log.Printf("Invalid v: %v", v) } } 複製代碼	for _, v := range data { if v.F1 != 1 { log.Printf("Invalid v: %v", v) continue } v = process(v) if err := v.Call(); err != nil { return err } v.Send() } 複製代碼

沒必要要的 else

若是一個變量在 if 的兩個分支中都設置了，那應該使用單個 if 。

Bad	Good
var a int if b { a = 100 } else { a = 10 } 複製代碼	a := 10 if b { a = 100 } 複製代碼

全局變量聲明

在頂層使用標準 var 關鍵字聲明變量時，不要顯式指定類型，除非它與表達式的返回類型不一樣。

Bad	Good
var _s string = F() func F() string { return "A" } 複製代碼	var _s = F() // F 已經明確聲明返回一個字符串類型，咱們沒有必要顯式指定 _s 的類型 func F() string { return "A" } 複製代碼

若是表達式的返回類型與所需的類型不徹底匹配，請顯示指定類型。

type myError struct{}

func (myError) Error() string { return "error" }

func F() myError { return myError{} }

var _e error = F()
// F 返回一個 myError 類型的實例，可是咱們要 error 類型
複製代碼

非導出的全局變量或者常量以 _ 開頭

非導出的全局變量和常量前面加上前綴 _，以明確表示它們是全局符號。

例外：未導出的錯誤類型變量，應以 err 開頭。

解釋：頂級（全局）變量和常量具備包範圍做用域。使用通用名稱命名，可能在其餘文件中不經意間地使用一個錯誤值。

Bad	Good
// foo.go const ( defaultPort = 8080 defaultUser = "user" ) // bar.go func Bar() { defaultPort := 9090 ... fmt.Println("Default port", defaultPort) // We will not see a compile error if the first line of // Bar() is deleted. } 複製代碼	// foo.go const ( _defaultPort = 8080 _defaultUser = "user" ) 複製代碼

結構體中的嵌入類型

嵌入式類型（例如 mutex ）應該放置在結構體字段列表的頂部，而且必須以空行與常規字段隔開。

Bad	Good
type Client struct { version int http.Client } 複製代碼	type Client struct { http.Client version int } 複製代碼

使用字段名來初始化結構

初始化結構體時，必須指定字段名稱。go vet 強制執行。

Bad	Good
k := User{"John", "Doe", true} 複製代碼	k := User{ FirstName: "John", LastName: "Doe", Admin: true, } 複製代碼

例外：在測試文件中，若是結構體只有3個或更少的字段，則能夠省略字段名稱。

tests := []struct{
}{
  op Operation
  want string
}{
  {Add, "add"},
  {Subtract, "subtract"},
}
複製代碼

局部變量聲明

若是聲明局部變量時須要明確設值，應使用短變量聲明形式（:=）。

Bad	Good
var s = "foo" 複製代碼	s := "foo" 複製代碼

可是，在某些狀況下，使用 var 關鍵字聲明變量，默認的初始化值會更清晰。例如，聲明空切片。

Bad	Good
func f(list []int) { filtered := []int{} for _, v := range list { if v > 10 { filtered = append(filtered, v) } } } 複製代碼	func f(list []int) { var filtered []int for _, v := range list { if v > 10 { filtered = append(filtered, v) } } } 複製代碼

nil是一個有效的slice

nil 是一個有效的長度爲 0 的 slice，這意味着：

• 不該明確返回長度爲零的切片，而應該直接返回 nil 。

  Bad	Good
  if x == "" { return []int{} } 複製代碼	if x == "" { return nil } 複製代碼

• 若要檢查切片是否爲空，始終使用 len(s) == 0 ，不要與 nil 比較來檢查。

  Bad	Good
  func isEmpty(s []string) bool { return s == nil } 複製代碼	func isEmpty(s []string) bool { return len(s) == 0 } 複製代碼

• 零值切片（經過 var 聲明的切片）可直接使用，無需調用 make 建立。

  Bad	Good
  nums := []int{} // or, nums := make([]int) if add1 { nums = append(nums, 1) } if add2 { nums = append(nums, 2) } 複製代碼	var nums []int if add1 { nums = append(nums, 1) } if add2 { nums = append(nums, 2) } 複製代碼

縮小變量做用域

若是有可能，儘可能縮小變量做用範圍，除非這樣與減小嵌套的規則衝突。

Bad	Good
err := ioutil.WriteFile(name, data, 0644) if err != nil { return err } 複製代碼	if err := ioutil.WriteFile(name, data, 0644); err != nil { return err } 複製代碼

若是須要在 if 以外使用函數調用的結果，則不該嘗試縮小範圍。

Bad	Good
if data, err := ioutil.ReadFile(name); err == nil { err = cfg.Decode(data) if err != nil { return err } fmt.Println(cfg) return nil } else { return err } 複製代碼	data, err := ioutil.ReadFile(name) if err != nil { return err } if err := cfg.Decode(data); err != nil { return err } fmt.Println(cfg) return nil 複製代碼

避免裸參數

函數調用中的裸參數可能會下降代碼可讀性。因此當參數名稱的含義不明顯時，請爲參數添加 C 樣式的註釋（/* … */）。

Bad	Good
// func printInfo(name string, isLocal, done bool) printInfo("foo", true, true) 複製代碼	// func printInfo(name string, isLocal, done bool) printInfo("foo", true /* isLocal */, true /* done */) 複製代碼

上面更好的做法是將 bool 類型替換爲自定義類型，從而使代碼更易讀且類型安全。未來須要拓展時，該參數也能夠不止兩個狀態（true/false）。

type Region int

const (
  UnknownRegion Region = iota
  Local
)

type Status int

const (
  StatusReady = iota + 1
  StatusDone
  // 也許未來咱們會有 StatusInProgress。
)

func printInfo(name string, region Region, status Status) 複製代碼

使用原始字符串字面值，避免使用轉義

Go 支持原始字符串字面值，能夠多行幷包含引號。使用它能夠避免使用肉眼閱讀較爲困難的手工轉義的字符串。

Bad	Good
wantError := "unknown name:\"test\"" 複製代碼	wantError := `unknown error:"test"` 複製代碼

初始化結構體引用

在初始化結構引用時，使用 &T{} 而非 new(T)，以使其與結構體初始化方式保持一致。

Bad	Good
sval := T{Name: "foo"} // 定義方式不一致 sptr := new(T) sptr.Name = "bar" 複製代碼	sval := T{Name: "foo"} sptr := &T{Name: "bar"} 複製代碼

格式化字符串放在 Printf 外部

若是爲 Printf-style 函數聲明格式化字符串，將格式化字符串放在函數外面 ，並將其設置爲 const 常量。

這有助於 go vet 對格式字符串進行靜態分析。

Bad	Good
msg := "unexpected values %v, %v\n" fmt.Printf(msg, 1, 2) 複製代碼	const msg = "unexpected values %v, %v\n" fmt.Printf(msg, 1, 2) 複製代碼

爲 Printf 樣式函數命名

聲明 Printf-style 函數時，請確保 go vet 能夠檢查它的格式化字符串。

這意味着應儘量使用預約義的 Printf-style 函數名稱。go vet 默認會檢查它們。更多相關信息，請參見 Printf系列。

若是不能使用預約義的名稱，請以 f 結尾：Wrapf，而非 Wrap。由於 go vet 能夠指定檢查特定的 Printf 樣式名稱，但名稱必須以 f 結尾。

$ go vet -printfuncs=wrapf,statusf
...
複製代碼

另見 go vet: Printf family check

模式

測試表

在覈心測試邏輯重複時，將表驅動測試與子測試一塊兒使用，以免重複代碼。

Bad

Good

// func TestSplitHostPort(t *testing.T) host, port, err := net.SplitHostPort("192.0.2.0:8000") require.NoError(t, err) assert.Equal(t, "192.0.2.0", host) assert.Equal(t, "8000", port) host, port, err = net.SplitHostPort("192.0.2.0:http") require.NoError(t, err) assert.Equal(t, "192.0.2.0", host) assert.Equal(t, "http", port) host, port, err = net.SplitHostPort(":8000") require.NoError(t, err) assert.Equal(t, "", host) assert.Equal(t, "8000", port) host, port, err = net.SplitHostPort("1:8") require.NoError(t, err) assert.Equal(t, "1", host) assert.Equal(t, "8", port) 複製代碼

// func TestSplitHostPort(t *testing.T) tests := []struct{ give string wantHost string wantPort string }{ { give: "192.0.2.0:8000", wantHost: "192.0.2.0", wantPort: "8000", }, { give: "192.0.2.0:http", wantHost: "192.0.2.0", wantPort: "http", }, { give: ":8000", wantHost: "", wantPort: "8000", }, { give: "1:8", wantHost: "1", wantPort: "8", }, } for _, tt := range tests { t.Run(tt.give, func(t *testing.T) { host, port, err := net.SplitHostPort(tt.give) require.NoError(t, err) assert.Equal(t, tt.wantHost, host) assert.Equal(t, tt.wantPort, port) }) } 複製代碼

測試表使得向錯誤消息注入上下文信息，減小重複的邏輯，添加新的測試用例變得更加容易。

咱們遵循這樣的約定：將結構體切片稱爲 tests。 每一個測試用例稱爲 tt 。此外，咱們鼓勵使用 give 和 want 前綴說明每一個測試用例的輸入和輸出值。

tests := []struct{
  give     string
  wantHost string
  wantPort string
}{
  // ...
}

for _, tt := range tests {
  // ...
}
複製代碼

功能選項

功能選項是一種模式，聲明一個不透明 Option 類型，該類型記錄某些內部結構體的信息。您的函數接受這些不定數量的選項參數，並將選項參數上的信息做用於內部結構上。

此模式可用於擴展構造函數和實現其餘公共 API 中的可選參數，特別是這些參數已經有三個或者超過三個的狀況下。

Bad

Good

// package db func Connect( addr string, timeout time.Duration, caching bool, ) (*Connection, error) { // ... } // Timeout and caching must always be provided, // even if the user wants to use the default. db.Connect(addr, db.DefaultTimeout, db.DefaultCaching) db.Connect(addr, newTimeout, db.DefaultCaching) db.Connect(addr, db.DefaultTimeout, false /* caching */) db.Connect(addr, newTimeout, false /* caching */) 複製代碼

type options struct { timeout time.Duration caching bool } // Option overrides behavior of Connect. type Option interface { apply(*options) } type optionFunc func(*options) func (f optionFunc) apply(o *options) { f(o) } func WithTimeout(t time.Duration) Option { return optionFunc(func(o *options) { o.timeout = t }) } func WithCaching(cache bool) Option { return optionFunc(func(o *options) { o.caching = cache }) } // Connect creates a connection. func Connect( addr string, opts ...Option, ) (*Connection, error) { options := options{ timeout: defaultTimeout, caching: defaultCaching, } for _, o := range opts { o.apply(&options) } // ... } // Options must be provided only if needed. db.Connect(addr) db.Connect(addr, db.WithTimeout(newTimeout)) db.Connect(addr, db.WithCaching(false)) db.Connect( addr, db.WithCaching(false), db.WithTimeout(newTimeout), ) 複製代碼

另見，

• Self-referential functions and the design of options
• Functional options for friendly APIs