Uber是世界領(lǐng)先的生活出行服務(wù)提供商，也是Go語言的早期adopter，根據(jù)Uber工程博客的內(nèi)容，大致可以判斷出Go語言在Uber內(nèi)部扮演了十分重要的角色。Uber內(nèi)部的Go語言工程實(shí)踐也是碩果累累，有大量Go實(shí)現(xiàn)的內(nèi)部工具被Uber開源到github上，諸如被Gopher圈熟知的zap、jaeger等。2018年年末Uber將內(nèi)部的Go風(fēng)格規(guī)范開源到github，經(jīng)過一年的積累和更新，該規(guī)范已經(jīng)初具規(guī)模，并受到廣大Gopher的關(guān)注。本文是該規(guī)范的中文版本，并”夾帶“了部分筆者的點(diǎn)評，希望對國內(nèi)Gopher有所幫助。

注：該版本基于commit 3baa2bd翻譯，后續(xù)不會(huì)持續(xù)更新。

一. 介紹

樣式(style)是支配我們代碼的慣例。術(shù)語“樣式”有點(diǎn)用詞不當(dāng)，因?yàn)檫@些約定涵蓋的范圍不限于由gofmt替我們處理的源文件格式。

本指南的目的是通過詳細(xì)描述在Uber編寫Go代碼的注意事項(xiàng)來管理這種復(fù)雜性。這些規(guī)則的存在是為了使代碼庫易于管理，同時(shí)仍然允許工程師更有效地使用Go語言功能。

該指南最初由Prashant Varanasi和Simon Newton編寫，目的是使一些同事能快速使用Go。多年來，該指南已根據(jù)其他人的反饋進(jìn)行了修改。

本文檔記錄了我們在Uber遵循的Go代碼中的慣用約定。其中許多是Go的通用準(zhǔn)則，而其他擴(kuò)展準(zhǔn)則依賴于下面外部的指南：

Effective Go
The Go common mistakes guide

所有代碼都應(yīng)該通過golint和go vet的檢查并無錯(cuò)誤。我們建議您將編輯器設(shè)置為：

保存時(shí)運(yùn)行g(shù)oimports
運(yùn)行g(shù)olint和go vet檢查源碼

您可以在以下Go編輯器工具支持頁面中找到更為詳細(xì)的信息：https : //github.com/golang/go/wiki/IDEsAndTextEditorPlugins

二. 指導(dǎo)原則

指向interface的指針

您幾乎不需要指向接口類型的指針。您應(yīng)該將接口作為值進(jìn)行傳遞，在這樣的傳遞過程中，實(shí)質(zhì)上傳遞的底層數(shù)據(jù)仍然可以是指針。

接口實(shí)質(zhì)上在底層用兩個(gè)字段表示：

一個(gè)指向某些特定類型信息的指針。您可以將其視為“類型”。
數(shù)據(jù)指針。如果存儲(chǔ)的數(shù)據(jù)是指針，則直接存儲(chǔ)。如果存儲(chǔ)的數(shù)據(jù)是一個(gè)值，則存儲(chǔ)指向該值的指針。

如果要接口方法修改底層數(shù)據(jù)，則必須用指向目標(biāo)對象的指針賦值給接口類型變量(譯注：感覺原指南中這里表達(dá)過于簡略，不是很清晰，因此在翻譯時(shí)增加了自己的一些詮釋)。

接收器(receiver)與接口

使用值接收器的方法既可以通過值調(diào)用，也可以通過指針調(diào)用。

例如:

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"}}
// 你只能通過值調(diào)用Read
sVals[1].Read()
// 下面無法通過編譯：
// sVals[1].Write("test")
sPtrs := map[int]*S{1: {"A"}}
// 通過指針既可以調(diào)用Read，也可以調(diào)用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
// 下面代碼無法通過編譯。因?yàn)閟2Val是一個(gè)值，而S2的f方法中沒有使用值接收器
// i = s2Val

《Effective Go》中有一段關(guān)于"pointers vs values"的精彩講解。

譯注：關(guān)于Go類型的method集合的問題，在我之前的文章《關(guān)于Go，你可能不注意的7件事》中有詳盡說明。

零值Mutex是有效的

sync.Mutex和sync.RWMutex是有效的。因此你幾乎不需要一個(gè)指向mutex的指針。

Bad:

mu := new(sync.Mutex)
mu.Lock()

vs.

Good:

var mu sync.Mutex
mu.Lock()

如果你使用結(jié)構(gòu)體指針，mutex可以非指針形式作為結(jié)構(gòu)體的組成字段，或者更好的方式是直接嵌入到結(jié)構(gòu)體中。

如果是私有結(jié)構(gòu)體類型或是要實(shí)現(xiàn)Mutex接口的類型，我們可以使用嵌入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]
}

對于導(dǎo)出類型，請使用私有鎖：

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]
}

在邊界處拷貝Slices和Maps

slices和maps包含了指向底層數(shù)據(jù)的指針，因此在需要復(fù)制它們時(shí)要特別注意。

接收Slices和Maps

請記住，當(dāng)map或slice作為函數(shù)參數(shù)傳入時(shí)，如果您存儲(chǔ)了對它們的引用，則用戶可以對其進(jìn)行修改。

Bad

func (d *Driver) SetTrips(trips []Trip) {
 d.trips = trips
}
trips := ...
d1.SetTrips(trips)
// 你是要修改d1.trips嗎？
trips[0] = ...

vs.

Good

func (d *Driver) SetTrips(trips []Trip) {
 d.trips = make([]Trip, len(trips))
 copy(d.trips, trips)
}
trips := ...
d1.SetTrips(trips)
// 這里我們修改trips[0]，但不會(huì)影響到d1.trips
trips[0] = ...

返回slices或maps

同樣，請注意用戶對暴露內(nèi)部狀態(tài)的map或slice的修改。

Bad

type Stats struct {
 sync.Mutex
 counters map[string]int
}
// Snapshot返回當(dāng)前狀態(tài)
func (s *Stats) Snapshot() map[string]int {
 s.Lock()
 defer s.Unlock()
 return s.counters
}
// snapshot不再受到鎖的保護(hù)
snapshot := stats.Snapshot()

vs.

Good

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現(xiàn)在是一個(gè)拷貝
snapshot := stats.Snapshot()

使用defer做清理

使用defer清理資源，諸如文件和鎖。

Bad

p.Lock()
if p.count < 10 {
 p.Unlock()
 return p.count
}
p.count++
newCount := p.count
p.Unlock()
return newCount
// 當(dāng)有多個(gè)return分支時(shí)，很容易遺忘unlock

vs.

Good

p.Lock()
defer p.Unlock()
if p.count < 10 {
 return p.count
}
p.count++
return p.count
// 更可讀

Defer的開銷非常小，只有在您可以證明函數(shù)執(zhí)行時(shí)間處于納秒級的程度時(shí)，才應(yīng)避免這樣做。使用defer提升可讀性是值得的，因?yàn)槭褂盟鼈兊某杀疚⒉蛔愕?。尤其適用于那些不僅僅是簡單內(nèi)存訪問的較大的方法，在這些方法中其他計(jì)算的資源消耗遠(yuǎn)超過defer。

Channel的size要么是1，要么是無緩沖的

channel通常size應(yīng)為1或是無緩沖的。默認(rèn)情況下，channel是無緩沖的，其size為零。任何其他尺寸都必須經(jīng)過嚴(yán)格的審查?？紤]如何確定大小，是什么阻止了channel在負(fù)載下被填滿并阻止寫入，以及發(fā)生這種情況時(shí)發(fā)生了什么。

Bad

// 應(yīng)該足以滿足任何人
c := make(chan int, 64)

vs.

Good

// 大小：1
c := make(chan int, 1) // 或
// 無緩沖channel，大小為0
c := make(chan int)

枚舉從1開始

在Go中引入枚舉的標(biāo)準(zhǔn)方法是聲明一個(gè)自定義類型和一個(gè)使用了iota的const組。由于變量的默認(rèn)值為0，因此通常應(yīng)以非零值開頭枚舉。

Bad

type Operation int
const (
 Add Operation = iota
 Subtract
 Multiply
)
// Add=0, Subtract=1, Multiply=2

vs.

Good

type Operation int
const (
 Add Operation = iota + 1
 Subtract
 Multiply
)
// Add=1, Subtract=2, Multiply=3

在某些情況下，使用零值是有意義的(枚舉從零開始)，例如，當(dāng)零值是理想的默認(rèn)行為時(shí)。

type LogOutput int
const (
 LogToStdout LogOutput = iota
 LogToFile
 LogToRemote
)
// LogToStdout=0, LogToFile=1, LogToRemote=2

錯(cuò)誤類型

Go中有多種聲明錯(cuò)誤（Error)的選項(xiàng)：

errors.New 對于簡單靜態(tài)字符串的錯(cuò)誤
fmt.Errorf 用于格式化的錯(cuò)誤字符串
實(shí)現(xiàn)Error()方法的自定義類型
使用 "pkg/errors".Wrap的wrApped error

返回錯(cuò)誤時(shí)，請考慮以下因素以確定最佳選擇：

這是一個(gè)不需要額外信息的簡單錯(cuò)誤嗎？如果是這樣，errors.New 就足夠了。
客戶需要檢測并處理此錯(cuò)誤嗎？如果是這樣，則應(yīng)使用自定義類型并實(shí)現(xiàn)該Error()方法。
您是否正在傳播下游函數(shù)返回的錯(cuò)誤？如果是這樣，請查看本文后面有關(guān)錯(cuò)誤包裝(Error Wrap)部分的內(nèi)容
否則，fmt.Errorf就可以。

如果客戶端需要檢測錯(cuò)誤，并且您已使用創(chuàng)建了一個(gè)簡單的錯(cuò)誤errors.New，請使用一個(gè)錯(cuò)誤變量(sentinel error )。

Bad

// 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")
 }
 }
}

vs.

Good

// 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")
 }
}

如果您有可能需要客戶端檢測的錯(cuò)誤，并且想向其中添加更多信息（例如，它不是靜態(tài)字符串），則應(yīng)使用自定義類型。

Bad

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")
 }
 }
}

vs.

Good

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")
 }
 }
}

直接導(dǎo)出自定義錯(cuò)誤類型時(shí)要小心，因?yàn)樗鼈円殉蔀槌绦虬睞PI的一部分。最好公開匹配器功能以檢查錯(cuò)誤。

// 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")
 }
}

錯(cuò)誤包裝(Error Wrapping)

一個(gè)(函數(shù)/方法)調(diào)用失敗時(shí)，有三種主要的錯(cuò)誤傳播方式：

如果沒有要添加的其他上下文，并且您想要維護(hù)原始錯(cuò)誤類型，則返回原始錯(cuò)誤。
添加上下文，使用"pkg/errors".Wrap以便錯(cuò)誤消息提供更多上下文，"pkg/errors".Cause可用于提取原始錯(cuò)誤。
使用fmt.Errorf，如果調(diào)用者不需要檢測或處理的特定錯(cuò)誤情況。

建議在可能的地方添加上下文，以使您獲得諸如“調(diào)用服務(wù)foo：連接被拒絕”之類的更有用的錯(cuò)誤，而不是諸如“連接被拒絕”之類的模糊錯(cuò)誤。

在將上下文添加到返回的錯(cuò)誤時(shí)，請避免使用“ failed to”之類的短語來保持上下文簡潔，這些短語會(huì)陳述明顯的內(nèi)容，并隨著錯(cuò)誤在堆棧中的滲透而逐漸堆積：

Bad

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

vs.

Good

s, err := store.New()
if err != nil {
 return fmt.Errorf(
 "new store: %s", err)
}
x: y: new store: the error

但是，一旦將錯(cuò)誤發(fā)送到另一個(gè)系統(tǒng)，就應(yīng)該明確消息是錯(cuò)誤消息（例如使用err標(biāo)記，或在日志中以"Failed"為前綴）。

另請參見Don't just check errors, handle them gracefully.

處理類型斷言失敗

類型斷言的單個(gè)返回值形式針對不正確的類型將產(chǎn)生panic。因此，請始終使用“comma ok”的慣用法。

Bad

t := i.(string)

vs.

Good

t, ok := i.(string)
if !ok {
 // 優(yōu)雅地處理錯(cuò)誤
}

不要panic

在生產(chǎn)環(huán)境中運(yùn)行的代碼必須避免出現(xiàn)panic。panic是級聯(lián)失敗的主要根源。如果發(fā)生錯(cuò)誤，該函數(shù)必須返回錯(cuò)誤，并允許調(diào)用方?jīng)Q定如何處理它。

Bad

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])
}

vs.

Good

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不是錯(cuò)誤處理策略。僅當(dāng)發(fā)生不可恢復(fù)的事情（例如:nil引用）時(shí)，程序才必須panic。程序初始化是一個(gè)例外：程序啟動(dòng)時(shí)應(yīng)使程序中止的不良情況可能會(huì)引起panic。

var _statusTemplate = template.Must(template.New("name").Parse("_statushtml"))

即便是在test中，也優(yōu)先使用t.Fatal或t.FailNow來標(biāo)記test是失敗的，而不是panic。

Bad

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

vs.

Good

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

使用go.uber.org/atomic

使用sync/atomic包的原子操作對原始類型（int32，int64等）進(jìn)行操作(譯注：指atomic包的方法名中均使用原始類型名，如SwapInt32等)，因此很容易忘記使用原子操作來讀取或修改變量。

go.uber.org/atomic通過隱藏基礎(chǔ)類型為這些操作增加了類型安全性。此外，它包括一個(gè)方便的atomic.Bool類型。

Bad

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!
}

vs.

Good

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()
}

三. 性能

性能方面的特定準(zhǔn)則，適用于熱路徑。

優(yōu)先使用strconv而不是fmt

將原語轉(zhuǎn)換為字符串或從字符串轉(zhuǎn)換時(shí)，strconv速度比fmt快。

Bad

for i := 0; i < b.N; i++ {
 s := fmt.Sprint(rand.Int())
}
BenchmarkFmtSprint-4 143 ns/op 2 allocs/op

vs.

Good

for i := 0; i < b.N; i++ {
 s := strconv.Itoa(rand.Int())
}
BenchmarkStrconv-4 64.2 ns/op 1 allocs/op

避免字符串到字節(jié)的轉(zhuǎn)換

不要反復(fù)從固定字符串創(chuàng)建字節(jié)slice。相反，請執(zhí)行一次轉(zhuǎn)換并捕獲結(jié)果。

Bad

for i := 0; i < b.N; i++ {
 w.Write([]byte("Hello world"))
}
BenchmarkBad-4 50000000 22.2 ns/op

vs.

Good

data := []byte("Hello world")
for i := 0; i < b.N; i++ {
 w.Write(data)
}
BenchmarkGood-4 500000000 3.25 ns/op

四. 樣式

相似的聲明放在一組

Go語言支持將相似的聲明放在一個(gè)組內(nèi)：

Bad

import "a"
import "b"

vs.

Good

import (
 "a"
 "b"
)

這同樣適用于常量、變量和類型聲明：

Bad

const a = 1
const b = 2
var a = 1
var b = 2
type Area float64
type Volume float64

vs.

Good

const (
 a = 1
 b = 2
)
var (
 a = 1
 b = 2
)
type (
 Area float64
 Volume float64
)

僅將相關(guān)的聲明放在一組。不要將不相關(guān)的聲明放在一組。

Bad

type Operation int
const (
 Add Operation = iota + 1
 Subtract
 Multiply
 ENV_VAR = "MY_ENV"
)

vs.

Good

type Operation int
const (
 Add Operation = iota + 1
 Subtract
 Multiply
)
const ENV_VAR = "MY_ENV"

分組使用的位置沒有限制，例如：你可以在函數(shù)內(nèi)部使用它們：

Bad

func f() string {
 var red = color.New(0xff0000)
 var green = color.New(0x00ff00)
 var blue = color.New(0x0000ff)
 ...
}

vs.

Good

func f() string {
 var (
 red = color.New(0xff0000)
 green = color.New(0x00ff00)
 blue = color.New(0x0000ff)
 )
 ...
}

import組內(nèi)的包導(dǎo)入順序

應(yīng)該有兩類導(dǎo)入組：

標(biāo)準(zhǔn)庫
其他一切

默認(rèn)情況下，這是goimports應(yīng)用的分組。

Bad

import (
 "fmt"
 "os"
 "go.uber.org/atomic"
 "golang.org/x/sync/errgroup"
)

vs.

Good

import (
 "fmt"
 "os"
 "go.uber.org/atomic"
 "golang.org/x/sync/errgroup"
)

包名

當(dāng)命名包時(shí)，請按下面規(guī)則選擇一個(gè)名稱：

全部小寫。沒有大寫或下劃線。
大多數(shù)使用命名導(dǎo)入的情況下，不需要重命名。
簡短而簡潔。請記住，在每個(gè)使用的地方都完整標(biāo)識了該名稱。
不用復(fù)數(shù)。例如net/url，而不是net/urls。
不是“common”，“util”，“shared”或“lib”。這些是不好的，信息量不足的名稱。

另請參閱Go包名稱和Go包樣式指南。

函數(shù)名

我們遵循Go社區(qū)關(guān)于使用MixedCaps作為函數(shù)名的約定。有一個(gè)例外，為了對相關(guān)的測試用例進(jìn)行分組，函數(shù)名可能包含下劃線，如: TestMyFunction_WhatIsBeingTested。

包導(dǎo)入別名

如果程序包名稱與導(dǎo)入路徑的最后一個(gè)元素不匹配，則必須使用導(dǎo)入別名。

import (
 "net/http"
 client "example.com/client-go"
 trace "example.com/trace/v2"
)

在所有其他情況下，除非導(dǎo)入之間有直接沖突，否則應(yīng)避免導(dǎo)入別名。

Bad

import (
 "fmt"
 "os"
 nettrace "golang.net/x/trace"
)

vs.

Good

import (
 "fmt"
 "os"
 "runtime/trace"
 nettrace "golang.net/x/trace"
)

函數(shù)分組與順序

函數(shù)應(yīng)按粗略的調(diào)用順序排序。
同一文件中的函數(shù)應(yīng)按接收者分組。

因此，導(dǎo)出的函數(shù)應(yīng)先出現(xiàn)在文件中，放在struct、const和var定義的后面。

在定義類型之后，但在接收者的其余方法之前，可能會(huì)出現(xiàn)一個(gè)newXYZ()/ NewXYZ()。

由于函數(shù)是按接收者分組的，因此普通工具函數(shù)應(yīng)在文件末尾出現(xiàn)。

Bad

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{}
}

vs.

Good

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 {...}

減少嵌套

代碼應(yīng)通過盡可能先處理錯(cuò)誤情況/特殊情況并盡早返回或繼續(xù)循環(huán)來減少嵌套。減少嵌套多個(gè)級別的代碼的代碼量。

Bad

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)
 }
}

vs.

Good

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的兩個(gè)分支中都設(shè)置了變量，則可以將其替換為單個(gè)if。

Bad

var a int
if b {
 a = 100
} else {
 a = 10
}

vs.

Good

a := 10
if b {
 a = 100
}

頂層變量聲明

在頂層，使用標(biāo)準(zhǔn)var關(guān)鍵字。請勿指定類型，除非它與表達(dá)式的類型不同。

Bad

var _s string = F()
func F() string { return "A" }

vs.

Good

var _s = F()
// 由于F已經(jīng)明確了返回一個(gè)字符串類型，因此我們沒有必要顯式指定_s的類型
func F() string { return "A" }

如果表達(dá)式的類型與所需的類型不完全匹配，請指定類型。

type myError struct{}
func (myError) Error() string { return "error" }
func F() myError { return myError{} }
var _e error = F()
// F返回一個(gè)myError類型的實(shí)例，但是我們要error類型

對于未導(dǎo)出的頂層常量和變量，使用_作為前綴

譯注：這個(gè)是Uber內(nèi)部的慣用法，目前看并不普適。

在未導(dǎo)出的頂級vars和consts，前面加上前綴_，以使它們在使用時(shí)明確表示它們是全局符號。

例外：未導(dǎo)出的錯(cuò)誤值，應(yīng)以err開頭。

基本依據(jù)：頂級變量和常量具有包范圍作用域。使用通用名稱可能很容易在其他文件中意外使用錯(cuò)誤的值。

Bad

// 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.
}

vs.

Good

// foo.go
const (
 _defaultPort = 8080
 _defaultUser = "user"
)

結(jié)構(gòu)體中的嵌入

嵌入式類型（例如mutex）應(yīng)位于結(jié)構(gòu)體內(nèi)的字段列表的頂部，并且必須有一個(gè)空行將嵌入式字段與常規(guī)字段分隔開。

Bad

type Client struct {
 version int
 http.Client
}

vs.

Good

type Client struct {
 http.Client
 version int
}

使用字段名初始化結(jié)構(gòu)體

初始化結(jié)構(gòu)體時(shí)，幾乎始終應(yīng)該指定字段名稱?，F(xiàn)在由go vet強(qiáng)制執(zhí)行。

Bad

k := User{"John", "Doe", true}

vs.

Good

k := User{
 FirstName: "John",
 LastName: "Doe",
 Admin: true,
}

例外：如果有3個(gè)或更少的字段，則可以在測試表中省略字段名稱。

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

本地變量聲明

如果將變量明確設(shè)置為某個(gè)值，則應(yīng)使用短變量聲明形式（:=）。

Bad

var s = "foo"

vs.

Good

s := "foo"

但是，在某些情況下，var 使用關(guān)鍵字時(shí)默認(rèn)值會(huì)更清晰。例如，聲明空切片。

Bad

func f(list []int) {
 filtered := []int{}
 for _, v := range list {
 if v > 10 {
 filtered = append(filtered, v)
 }
 }
}

vs.

Good

func f(list []int) {
 var filtered []int
 for _, v := range list {
 if v > 10 {
 filtered = append(filtered, v)
 }
 }
}

nil是一個(gè)有效的slice

nil是一個(gè)有效的長度為0的slice，這意味著：

您不應(yīng)明確返回長度為零的切片。返回nil 來代替。

Bad

if x == "" {
 return []int{}
}

vs.

Good

if x == "" {
 return nil
}

要檢查切片是否為空，請始終使用len(s) == 0。不要檢查 nil。

Bad

func isEmpty(s []string) bool {
 return s == nil
}

vs.

Good

func isEmpty(s []string) bool {
 return len(s) == 0
}

零值切片可立即使用，無需調(diào)用make創(chuàng)建。

Bad

nums := []int{}
// or, nums := make([]int)
if add1 {
 nums = append(nums, 1)
}
if add2 {
 nums = append(nums, 2)
}

vs.

Good

var nums []int
if add1 {
 nums = append(nums, 1)
}
if add2 {
 nums = append(nums, 2)
}

縮小變量作用域

如果有可能，盡量縮小變量作用范圍。除非它與減少嵌套的規(guī)則沖突。

Bad

err := ioutil.WriteFile(name, data, 0644)
if err != nil {
 return err
}

vs.

Good

if err := ioutil.WriteFile(name, data, 0644); err != nil {
 return err
}

如果需要在if之外使用函數(shù)調(diào)用的結(jié)果，則不應(yīng)嘗試縮小范圍。

Bad

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
}

vs.

Good

data, err := ioutil.ReadFile(name)
if err != nil {
 return err
}
if err := cfg.Decode(data); err != nil {
 return err
}
fmt.Println(cfg)
return nil

避免裸參數(shù)

函數(shù)調(diào)用中的裸參數(shù)可能會(huì)損害可讀性。當(dāng)參數(shù)名稱的含義不明顯時(shí)，請為參數(shù)添加C樣式注釋（/* … */）。

Bad

// func printInfo(name string, isLocal, done bool)
printInfo("foo", true, true)

vs.

Good

// func printInfo(name string, isLocal, done bool)
printInfo("foo", true /* isLocal */, true /* done */)

更好的作法是，將裸bool類型替換為自定義類型，以獲得更易讀和類型安全的代碼。將來，該參數(shù)不僅允許兩個(gè)狀態(tài)（true/false）。

type Region int
const (
 UnknownRegion Region = iota
 Local
)
type Status int
const (
 StatusReady = iota + 1
 StatusDone
 // Maybe we will have a StatusInProgress in the future.
)
func printInfo(name string, region Region, status Status)

使用原始字符串字面值，避免轉(zhuǎn)義

Go支持原始字符串字面值，可以跨越多行并包含引號。使用這些字符串可以避免更難閱讀的手工轉(zhuǎn)義的字符串。

Bad

wantError := "unknown name:"test""

vs.

Good

wantError := `unknown error:"test"`

初始化結(jié)構(gòu)體引用

在初始化結(jié)構(gòu)引用時(shí)，請使用&T{}代替new(T)，以使其與結(jié)構(gòu)體初始化一致。

Bad

sval := T{Name: "foo"}
// 不一致
sptr := new(T)
sptr.Name = "bar"

vs.

Good

sval := T{Name: "foo"}
sptr := &T{Name: "bar"}

格式化字符串放在Printf外部

如果你為Printf-style函數(shù)聲明格式字符串，請將格式化字符串放在外面，并將其設(shè)置為const常量。

這有助于go vet對格式字符串執(zhí)行靜態(tài)分析。

Bad

msg := "unexpected values %v, %vn"
fmt.Printf(msg, 1, 2)

vs.

Good

const msg = "unexpected values %v, %vn"
fmt.Printf(msg, 1, 2)

命名Printf樣式的函數(shù)

聲明Printf-style函數(shù)時(shí)，請確保go vet可以檢測到它并檢查格式字符串。

這意味著您應(yīng)盡可能使用預(yù)定義的Printf-style函數(shù)名稱。go vet將默認(rèn)檢查這些。有關(guān)更多信息，請參見Printf系列。

如果不能使用預(yù)定義的名稱，請以f結(jié)束選擇的名稱：Wrapf，而不是Wrap。go vet可以要求檢查特定的Printf樣式名稱，但名稱必須以f結(jié)尾。

另請參閱"go vet：Printf家族檢查"。

五. 模式

測試表

在核心測試邏輯重復(fù)時(shí)，將表驅(qū)動(dòng)測試與子測試一起使用，以避免重復(fù)代碼。

Bad

// 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)

vs.

Good

// 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)
 })
}

測試表使向錯(cuò)誤消息添加上下文，減少重復(fù)的邏輯以及添加新的測試用例變得更加容易。

我們遵循這樣的約定：將結(jié)構(gòu)體切片稱為tests。每個(gè)測試用例稱為tt。此外，我們鼓勵(lì)使用give和want前綴說明每個(gè)測試用例的輸入和輸出值。

tests := []struct{
 give string
 wantHost string
 wantPort string
}{
 // ...
}
for _, tt := range tests {
 // ...
}

功能選項(xiàng)

功能選項(xiàng)是一種模式，您可以在其中聲明一個(gè)不透明Option類型，該類型在某些內(nèi)部結(jié)構(gòu)中記錄信息。您接受這些選項(xiàng)的可變編號，并根據(jù)內(nèi)部結(jié)構(gòu)上的選項(xiàng)記錄的全部信息采取行動(dòng)。

將此模式用于您需要擴(kuò)展的構(gòu)造函數(shù)和其他公共API中的可選參數(shù)，尤其是在這些功能上已經(jīng)具有三個(gè)或更多參數(shù)的情況下。

Bad

// 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 */)

vs.

Good

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),
)

還可以參考下面資料：