1. 程式人生 > 程式設計 >Uber Go 語言編碼規範

Uber Go 語言編碼規範

Uber Go 語言編碼規範

Uber 是一家美國矽谷的科技公司,也是 Go 語言的早期 adopter。其開源了很多 golang 專案,諸如被 Gopher 圈熟知的 zapjaeger 等。2018 年年末 Uber 將內部的 Go 風格規範 開源到 GitHub,經過一年的積累和更新,該規範已經初具規模,並受到廣大 Gopher 的關注。本文是該規範的中文版本。本版本會根據原版實時更新。

版本

  • 當前更新版本:2019-11-13 版本地址:commit:#71
  • 如果您發現任何更新、問題或改進,請隨時 fork 和 PR
  • Please feel free to fork and PR if you find any updates,issues or improvement.

目錄

介紹

樣式 (style) 是支配我們程式碼的慣例。術語樣式有點用詞不當,因為這些約定涵蓋的範圍不限於由 gofmt 替我們處理的原始檔格式。

本指南的目的是通過詳細描述在 Uber 編寫 Go 程式碼的注意事項來管理這種複雜性。這些規則的存在是為了使程式碼庫易於管理,同時仍然允許工程師更有效地使用 Go 語言功能。

該指南最初由 Prashant VaranasiSimon Newton 編寫,目的是使一些同事能快速使用 Go。多年來,該指南已根據其他人的反饋進行了修改。

本檔案記錄了我們在 Uber 遵循的 Go 程式碼中的慣用約定。其中許多是 Go 的通用準則,而其他擴充套件準則依賴於下面外部的指南:

  1. Effective Go
  2. The Go common mistakes guide

所有程式碼都應該通過golintgo vet的檢查並無錯誤。我們建議您將編輯器設定為:

  • 儲存時執行 goimports
  • 執行 golintgo vet 檢查錯誤

您可以在以下 Go 編輯器工具支援頁面中找到更為詳細的資訊: github.com/golang/go/w…

指導原則

指向 interface 的指標

您幾乎不需要指向介面型別的指標。您應該將介面作為值進行傳遞,在這樣的傳遞過程中,實質上傳遞的底層資料仍然可以是指標。

介面實質上在底層用兩個欄位表示:

  1. 一個指向某些特定型別資訊的指標。您可以將其視為"type"。
  2. 資料指標。如果儲存的資料是指標,則直接儲存。如果儲存的資料是一個值,則儲存指向該值的指標。

如果希望介面方法修改基礎資料,則必須使用指標傳遞。

接收器 (receiver) 與介面

使用值接收器的方法既可以通過值呼叫,也可以通過指標呼叫。

例如,

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[1].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 是一個值,而 S2 的 f 方法中沒有使用值接收器
//   i = s2Val
複製程式碼

Effective Go 中有一段關於 pointers vs. values 的精彩講解。

零值 Mutex 是有效的

零值 sync.Mutexsync.RWMutex 是有效的。所以指向 mutex 的指標基本是不必要的。

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

如果你使用結構體指標,mutex 可以非指標形式作為結構體的組成欄位,或者更好的方式是直接嵌入到結構體中。 如果是私有結構體型別或是要實現 Mutex 介面的型別,我們可以使用嵌入 mutex 的方法:

type smap struct {
  sync.Mutex // only for unexported types(僅適用於非匯出型別)

  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]
}
複製程式碼
為私有型別或需要實現互斥介面的型別嵌入。 對於匯出的型別,請使用專用欄位。

在邊界處拷貝 Slices 和 Maps

slices 和 maps 包含了指向底層資料的指標,因此在需要複製它們時要特別注意。

接收 Slices 和 Maps

請記住,當 map 或 slice 作為函式引數傳入時,如果您儲存了對它們的引用,則使用者可以對其進行修改。

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

同樣,請注意使用者對暴露內部狀態的 map 或 slice 的修改。

Bad Good
type Stats struct {
  mu sync.Mutex

  counters map[string]int
}

// Snapshot 返回當前狀態。
func (s *Stats) Snapshot() map[string]int {
  s.mu.Lock()
  defer s.mu.Unlock()

  return s.counters
}

// snapshot 不再受互斥鎖保護
// 因此對 snapshot 的任何訪問都將受到資料競爭的影響
// 影響 stats.counters
snapshot := stats.Snapshot()
複製程式碼
type Stats struct {
  mu sync.Mutex

  counters map[string]int
}

func (s *Stats) Snapshot() map[string]int {
  s.mu.Lock()
  defer s.mu.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 分支時,很容易遺忘 unlock
複製程式碼
p.Lock()
defer p.Unlock()

if p.count < 10 {
  return p.count
}

p.count++
return p.count

// 更可讀
複製程式碼

Defer 的開銷非常小,只有在您可以證明函式執行時間處於納秒級的程度時,才應避免這樣做。使用 defer 提升可讀性是值得的,因為使用它們的成本微不足道。尤其適用於那些不僅僅是簡單記憶體訪問的較大的方法,在這些方法中其他計算的資源消耗遠超過 defer

Channel 的 size 要麼是 1,要麼是無緩衝的

channel 通常 size 應為 1 或是無緩衝的。預設情況下,channel 是無緩衝的,其 size 為零。任何其他尺寸都必須經過嚴格的審查。考慮如何確定大小,是什麼阻止了 channel 在負載下被填滿並阻止寫入,以及發生這種情況時發生了什麼。

Bad Good
// 應該足以滿足任何情況!
c := make(chan int,64)
複製程式碼
// 大小:1
c := make(chan int,1) // 或者
// 無緩衝 channel,大小為 0
c := make(chan int)
複製程式碼

列舉從 1 開始

在 Go 中引入列舉的標準方法是宣告一個自定義型別和一個使用了 iota 的 const 組。由於變數的預設值為 0,因此通常應以非零值開頭列舉。

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
複製程式碼

錯誤型別

Go 中有多種宣告錯誤(Error) 的選項:

返回錯誤時,請考慮以下因素以確定最佳選擇:

  • 這是一個不需要額外資訊的簡單錯誤嗎?如果是這樣,errors.New 足夠了。

  • 客戶需要檢測並處理此錯誤嗎?如果是這樣,則應使用自定義型別並實現該 Error() 方法。

  • 您是否正在傳播下游函式返回的錯誤?如果是這樣,請檢視本文後面有關錯誤包裝 section on error wrapping 部分的內容。

  • 否則 fmt.Errorf 就可以了。

如果客戶端需要檢測錯誤,並且您已使用建立了一個簡單的錯誤 errors.New,請使用一個錯誤變數。

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

一個(函式/方法)呼叫失敗時,有三種主要的錯誤傳播方式:

  • 如果沒有要新增的其他上下文,並且您想要維護原始錯誤型別,則返回原始錯誤。

  • 新增上下文,使用 "pkg/errors".Wrap 以便錯誤訊息提供更多上下文,"pkg/errors".Cause 可用於提取原始錯誤。 Use fmt.Errorf if the callers do not need to detect or handle that specific error case.

  • 如果呼叫者不需要檢測或處理的特定錯誤情況,使用 fmt.Errorf

建議在可能的地方新增上下文,以使您獲得諸如“呼叫服務 foo:連線被拒絕”之類的更有用的錯誤,而不是諸如“連線被拒絕”之類的模糊錯誤。

在將上下文新增到返回的錯誤時,請避免使用“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. 不要只是檢查錯誤,要優雅地處理錯誤

處理型別斷言失敗

type assertion 的單個返回值形式針對不正確的型別將產生 panic。因此,請始終使用“comma ok”的慣用法。

Bad Good
t := i.(string)
複製程式碼
t,ok := i.(string)
if !ok {
  // 優雅地處理錯誤
}
複製程式碼

不要 panic

在生產環境中執行的程式碼必須避免出現 panic。panic 是 cascading failures 級聯失敗的主要根源 。如果發生錯誤,該函式必須返回錯誤,並允許呼叫方決定如何處理它。

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 不是錯誤處理策略。僅當發生不可恢復的事情(例如:nil 引用)時,程式才必須 panic。程式初始化是一個例外:程式啟動時應使程式中止的不良情況可能會引起 panic。

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,"test")
if err != nil {
  t.Fatal("failed to set up test")
}
複製程式碼

使用 go.uber.org/atomic

使用 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
複製程式碼

避免字串到位元組的轉換

不要反覆從固定字串建立位元組 slice。相反,請執行一次轉換並捕獲結果。

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
複製程式碼

儘量初始化時指定 Map 容量

在儘可能的情況下,在使用 make() 初始化的時候提供容量資訊

make(map[T1]T2,hint)
複製程式碼

make() 提供容量資訊(hint)嘗試在初始化時調整 map 大小, 這減少了在將元素新增到 map 時增長和分配的開銷。 注意,map 不能保證分配 hint 個容量。因此,即使提供了容量,新增元素仍然可以進行分配。

Bad Good
m := make(map[string]os.FileInfo)

files,_ := ioutil.ReadDir("./files")
for _,f := range files {
    m[f.Name()] = f
}
複製程式碼

files,_ := ioutil.ReadDir("./files")

m := make(map[string]os.FileInfo,len(files))
for _,f := range files {
    m[f.Name()] = f
}
複製程式碼

m 是在沒有大小提示的情況下建立的; 在執行時可能會有更多分配。

m 是有大小提示建立的;在執行時可能會有更少的分配。

規範

一致性

本文中概述的一些標準都是客觀性的評估,是根據場景、上下文、或者主觀性的判斷;

但是最重要的是,保持一致.

一致性的程式碼更容易維護、是更合理的、需要更少的學習成本、並且隨著新的約定出現或者出現錯誤後更容易遷移、更新、修復 bug

相反,一個單一的程式碼庫會導致維護成本開銷、不確定性和認知偏差。所有這些都會直接導致速度降低、 程式碼審查痛苦、而且增加 bug 數量

將這些標準應用於程式碼庫時,建議在 package(或更大)級別進行更改,子包級別的應用程式通過將多個樣式引入到同一程式碼中,違反了上述關注點。

相似的宣告放在一組

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 分組

匯入應該分為兩組:

  • 標準庫
  • 其他庫

預設情況下,這是 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 NamesGo 包樣式指南.

函式名

我們遵循 Go 社群關於使用 MixedCaps 作為函式名 的約定。有一個例外,為了對相關的測試用例進行分組,函式名可能包含下劃線,如: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 型別
複製程式碼

對於未匯出的頂層常量和變數,使用_作為字首

在未匯出的頂級varsconsts, 前面加上字首_,以使它們在使用時明確表示它們是全域性符號。

例外:未匯出的錯誤值,應以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)
    }
  }
}
複製程式碼

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,2)
    }
    複製程式碼

小變數作用域

如果有可能,儘量縮小變數作用範圍。除非它與 減少巢狀的規則衝突。

Bad Good
err := ioutil.WriteFile(name,data,0644)
if err != nil {
 return err
}
複製程式碼
if err := ioutil.WriteFile(name,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
複製程式碼

避免引數語義不明確(Avoid Naked Parameters)

函式呼叫中的意義不明確的引數可能會損害可讀性。當引數名稱的含義不明顯時,請為引數新增 C 樣式註釋 (/* ... */)

Bad Good
// func printInfo(name string,isLocal,done bool)

printInfo("foo",true,true)
複製程式碼
// func printInfo(name string,true /* isLocal */,true /* done */)
複製程式碼

對於上面的示例程式碼,還有一種更好的處理方式是將上面的 bool 型別換成自定義型別。將來,該引數可以支援不僅僅侷限於兩個狀態(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)
複製程式碼

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

Go 支援使用 原始字串字面值,也就是 " ` " 來表示原生字串,在需要轉義的場景下,我們應該儘量使用這種方案來替換。

可以跨越多行幷包含引號。使用這些字串可以避免更難閱讀的手工轉義的字串。

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

初始化 Struct 引用

在初始化結構引用時,請使用&T{}代替new(T),以使其與結構體初始化一致。

Bad Good
sval := T{Name: "foo"}

// inconsistent
sptr := new(T)
sptr.Name = "bar"
複製程式碼
sval := T{Name: "foo"}

sptr := &T{Name: "bar"}
複製程式碼

初始化 Maps

對於空 map 請使用 make(..) 初始化, 並且 map 是通過程式設計方式填充的。 這使得 map 初始化在表現上不同於宣告,並且它還可以方便地在 make 後新增大小提示。

Bad Good
var (
  // m1 讀寫安全;
  // m2 在寫入時會 panic
  m1 = map[T1]T2{}
  m2 map[T1]T2
)
複製程式碼
var (
  // m1 讀寫安全;
  // m2 在寫入時會 panic
  m1 = make(map[T1]T2)
  m2 map[T1]T2
)
複製程式碼

宣告和初始化看起來非常相似的。

宣告和初始化看起來差別非常大。

在儘可能的情況下,請在初始化時提供 map 容量大小,詳細請看 儘量初始化時指定 Map 容量

另外,如果 map 包含固定的元素列表,則使用 map literals(map 初始化列表) 初始化對映。

Bad Good
m := make(map[T1]T2,3)
m[k1] = v1
m[k2] = v2
m[k3] = v3
複製程式碼
m := map[T1]T2{
  k1: v1,k2: v2,k3: v3,}
複製程式碼

基本準則是:在初始化時使用 map 初始化列表 來新增一組固定的元素。否則使用 make (如果可以,請儘量指定 map 容量)。

字串 string format

如果你為Printf-style 函式宣告格式字串,請將格式化字串放在外面,並將其設定為const常量。

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

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

命名 Printf 樣式的函式

宣告Printf-style 函式時,請確保go vet可以檢測到它並檢查格式字串。

這意味著您應儘可能使用預定義的Printf-style 函式名稱。go vet將預設檢查這些。有關更多資訊,請參見 Printf 系列

如果不能使用預定義的名稱,請以 f 結束選擇的名稱:Wrapf,而不是Wrapgo vet可以要求檢查特定的 Printf 樣式名稱,但名稱必須以f結尾。

$ go vet -printfuncs=wrapf,statusf
複製程式碼

另請參閱 go vet: Printf family check.

程式設計模式

表驅動測試

當測試邏輯是重複的時候,通過 subtests 使用 table 驅動的方式編寫 case 程式碼看上去會更簡潔。

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,err = net.SplitHostPort("192.0.2.0:http")
require.NoError(t,"http",err = net.SplitHostPort(":8000")
require.NoError(t,"",err = net.SplitHostPort("1:8")
require.NoError(t,"1","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",wantPort: "http",{
    give:     ":8000",wantHost: "",{
    give:     "1:8",wantHost: "1",wantPort: "8",}

for _,tt := range tests {
  t.Run(tt.give,func(t *testing.T) {
    host,err := net.SplitHostPort(tt.give)
    require.NoError(t,err)
    assert.Equal(t,tt.wantHost,host)
    assert.Equal(t,tt.wantPort,port)
  })
}
複製程式碼

很明顯,使用 test table 的方式在程式碼邏輯擴充套件的時候,比如新增 test case,都會顯得更加的清晰。

我們遵循這樣的約定:將結構體切片稱為tests。 每個測試用例稱為tt。此外,我們鼓勵使用givewant字首說明每個測試用例的輸入和輸出值。

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,false /* caching */)
db.Connect(addr,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,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),)
複製程式碼

還可以參考下面資料:

本文由zshipu.com學習筆記或整理或轉載,如有侵權請聯絡,必改之。