GO語言最佳實踐
宣告slice
宣告空的slice應該使用下面的格式:1 var t []string
而不是這種格式:1 t := []string{}
前者聲明瞭一個nil slice而後者是一個長度為0的非nil的slice。
關於字串大小寫
錯誤字串不應該大寫。
應該寫成:1 fmt.Errorf("failed to write data")
而不是寫成:1 fmt.Errorf("Failed to write data")
這是因為這些字串可能和其它字串相連線,組合後的字串如果中間有大寫字母開頭的單詞很突兀,除非這些首字母大寫單詞是固定使用的單詞。
縮寫詞必須保持一致,比如都大寫URL或者小寫url。比如HTTP、ID等。
例如sendOAuth或者oauthSend。
常量一般宣告為MaxLength,而不是以下劃線分隔MAX_LENGTH或者MAXLENGTH。
也就是Go語言一般使用MixedCaps或者mixedCaps命名的方式區分包含多個單詞的名稱。
處理error而不是panic或者忽略
為了編寫強壯的程式碼,不用使用_忽略錯誤,而是要處理每一個錯誤,儘管程式碼寫起來可能有些繁瑣。
儘量不要使用panic。
一些名稱
有些單詞可能有多種寫法,在專案中應該保持一致,比如Golang採用的寫法:
// marshaling
// unmarshaling
// canceling
// cancelation
而不是
// marshalling
// unmarshalling
// cancelling
// cancellation
包名應該用單數的形式,比如util、model,而不是utils、models。
Receiver 的名稱應該縮寫,一般使用一個或者兩個字元作為Receiver的名稱,如
func (f foo) method() {
...
}
如果方法中沒有使用receiver,還可以省略receiver name,這樣更清晰的表明方法中沒有使用它:
func (foo) method() {
...
}
package級的Error變數
通常會把自定義的Error放在package級別中,統一進行維護:
var ( ErrCacheMiss = errors.New("memcache: cache miss") ErrCASConflict = errors.New("memcache: compare-and-swap conflict") ErrNotStored = errors.New("memcache: item not stored") ErrServerError = errors.New("memcache: server error") ErrNoStats = errors.New("memcache: no statistics available") ErrMalformedKey = errors.New("malformed: key is too long or contains invalid characters") ErrNoServers = errors.New("memcache: no servers configured or available") )
並且變數以Err開頭。
空字串檢查
不要使用下面的方式檢查空字串:
if len(s) == 0 {
...
}
而是使用下面的方式
if s == "" {
...
}
下面的方法更是語法不對:
if s == nil || s == "" {
...
}
非空slice檢查
不要使用下面的方式檢查空的slice:
if s != nil && len(s) > 0 {
...
}
直接比較長度即可:
if len(s) > 0 {
...
}
同樣的道理也適用 map和channel。
省略不必要的變數
比如1 var whitespaceRegex, _ = regexp.Compile("\\s+")
可以簡寫為1 var whitespaceRegex = regexp.MustCompile(
\s+)
有時候你看到的一些第三方的類提供了類似的方法:
func Foo(...) (...,error)
func MustFoo(...) (...)
MustFoo一般提供了一個不帶error返回的型別。
直接使用bool值
對於bool型別的變數var b bool,直接使用它作為判斷條件,而不是使用它和true/false進行比較
if b {
...
}
if !b {
...
}
而不是
if b == true {
...
}
if b == false {
...
}
byte/string slice相等性比較
不要使用
var s1 []byte
var s2 []byte
...
bytes.Compare(s1, s2) == 0
bytes.Compare(s1, s2) != 0
而是:
var s1 []byte
var s2 []byte
...
bytes.Equal(s1, s2) == 0
bytes.Equal(s1, s2) != 0
檢查是否包含子字串
不要使用 strings.IndexRune(s1, 'x') > -1
及其類似的方法IndexAny、Index檢查字串包含,
而是使用strings.ContainsRune、strings.ContainsAny、strings.Contains
來檢查。
使用型別轉換而不是struct字面值
對於兩個型別:
type t1 struct {
a int
b int
}
type t2 struct {
a int
b int
}
可以使用型別轉換將型別t1的變數轉換成型別t2的變數,而不是像下面的程式碼進行轉換
v1 := t1{1, 2}
_ = t2{v1.a, v1.b}
應該使用型別轉換,因為這兩個struct底層的資料結構是一致的。 _ = t2(v1)
複製slice
不要使用下面的複製slice的方式:
var b1, b2 []byte
for i, v := range b1 {
b2[i] = v
}
for i := range b1 {
b2[i] = b1[i]
}
而是使用內建的copy函式:copy(b2, b1)
不要在for中使用多此一舉的true
不要這樣:for true {}
而是要這樣:for {}
儘量縮短if
下面的程式碼:
x := true
if x {
return true
}
return false
可以用return x代替。
同樣下面的程式碼也可以使用return err代替:
func fn1() error {
var err error
if err != nil {
return err
}
return nil
}
func fn1() bool{
...
b := fn()
if b {
...
return true
} else {
return false
}
}
應該寫成:
func fn1() bool{
...
b := fn()if !b {
return false
}
...
return true
}
也就是減少if的分支/縮排。
append slice
不要這樣:
var a, b []int
for _, v := range a {
b = append(b, v)
}
而是要這樣
var a, b []int
b = append(b, a...)
簡化range
var m map[string]int
for _ = range m {
}
for _, _ = range m {
}
可以簡化為
for range m {
}
對slice和channel也適用。
正則表示式中使用raw字串避免轉義字元
在使用正則表示式時,不要:
regexp.MustCompile("\\.")
regexp.Compile("\\.")
而是直接使用raw字串,可以避免大量的\出現:
regexp.MustCompile(`\.`)
regexp.Compile(`\.`)
簡化只包含單個case的select
select {
case <-ch:
}
直接寫成<-ch即可。send也一樣。
for {
select {
case x := <-ch:
_ = x
}
}
直接改成 for-range即可。
這種簡化只適用包含單個case的情況。
slice的索引
有時可以忽略slice的第一個索引或者第二個索引:
var s []int
_ = s[:len(s)]
_ = s[0:len(s)]
可以寫成s[:]
使用time.Since
下面的程式碼經常會用到:
_ = time.Now().Sub(t1)
可以簡寫為:
_ = time.Since(t1)
使用strings.TrimPrefix/strings.TrimSuffix 掐頭去尾
不要自己判斷字串是否以XXX開頭或者結尾,然後自己再去掉XXX,而是使用現成的strings.TrimPrefix/strings.TrimSuffix。
var s1 = "a string value"
var s2 = "a "
var s3 string
if strings.HasPrefix(s1, s2) {
s3 = s1[len(s2):]
}
可以簡化為
var s1 = "a string value"
var s2 = "a "
var s3 = strings.TrimPrefix(s1, s2)