分享
  1. 首页
  2. 文章

编写地道的Go代码

smallnest · · 2662 次点击 · · 开始浏览
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

目录 [−]

  1. 注释
  2. 声明slice
  3. 关于字符串大小写
  4. 处理error而不是panic或者忽略
  5. 尽量减少代码缩进
  6. 一些名称
  7. package级的Error变量
  8. 空字符串检查
  9. 非空slice检查
  10. 省略不必要的变量
  11. 直接使用bool值
  12. byte/string slice相等性比较
  13. 检查是否包含子字符串
  14. 使用类型转换而不是struct字面值
  15. 复制slice
  16. 不要在for中使用多此一举的true
  17. 尽量缩短if
  18. 简化range
  19. 正则表达式中使用raw字符串避免转义字符
  20. 简化只包含单个case的select
  21. slice的索引
  22. 使用time.Since
  23. 使用strings.TrimPrefix/strings.TrimSuffix 掐头去尾
  24. 使用工具检查你的代码
  25. 参考文档

在阅读本文之前,我先推荐你阅读官方的 Effective Go文档,或者是中文翻译版: 高效Go编程,它提供了很多编写标准而高效的Go代码指导,本文不会再重复介绍这些内容。

最地道的Go代码就是Go的标准库的代码,你有空的时候可以多看看Google的工程师是如何实现的。

本文仅作为一个参考,如果你有好的建议和意见,欢迎添加评论。

注释

可以通过 /* ...... */ 或者 // ......增加注释, //之后应该加一个空格。

如果你想在每个文件中的头部加上注释,需要在版权注释和 Package前面加一个空行,否则版权注释会作为Package的注释。 

1
2
3
4
5
6
7
8
9
10
11
12
13
// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
/*
Package net provides a portable interface for network I/O, including
TCP/IP, UDP, domain name resolution, and Unix domain sockets.
......
*/
package net
......

注释应该用一个完整的句子,注释的第一个单词应该是要注释的指示符,以便在godoc中容易查找。

注释应该以一个句点.结束。

声明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 not MaxLength or MAX_LENGTH.

常量一般声明为MaxLength,而不是以下划线分隔MAX_LENGTH或者MAXLENGTH。

也就是Go语言一般使用MixedCaps或者mixedCaps命名的方式区分包含多个单词的名称。

处理error而不是panic或者忽略

为了编写强壮的代码,不用使用_忽略错误,而是要处理每一个错误,尽管代码写起来可能有些繁琐。

尽量不要使用panic。

尽量减少代码缩进

一些名称

有些单词可能有多种写法,在项目中应该保持一致,比如Golang采用的写法:

1
2
3
4
// marshaling
// unmarshaling
// canceling
// cancelation

而不是

1
2
3
4
// marshalling
// unmarshalling
// cancelling
// cancellation

包名应该用单数的形式,比如util、model,而不是utils、models。

Receiver 的名称应该缩写,一般使用一个或者两个字符作为Receiver的名称,如

1
2
3
func (f foo) method() {
	...
}

如果方法中没有使用receiver,还可以省略receiver name,这样更清晰的表明方法中没有使用它:

1
2
3
func (foo) method() {
	...
}

package级的Error变量

通常会把自定义的Error放在package级别中,统一进行维护:

1
2
3
4
5
6
7
8
9
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开头。

空字符串检查

不要使用下面的方式检查空字符串:

1
2
3
if len(s) == 0 {
	...
}

而是使用下面的方式 

1
2
3
if s == "" {
	...
}

下面的方法更是语法不对:

1
2
3
if s == nil || s == "" {
	...
}

非空slice检查

不要使用下面的方式检查空的slice:

1
2
3
if s != nil && len(s) > 0 {
 ...
}

直接比较长度即可:

1
2
3
if len(s) > 0 {
 ...
}

同样的道理也适用 map和channel。

省略不必要的变量

比如

1
var whitespaceRegex, _ = regexp.Compile("\\s+")

可以简写为

1
var whitespaceRegex = regexp.MustCompile(`\s+`)

有时候你看到的一些第三方的类提供了类似的方法:

1
2
func Foo(...) (...,error)
func MustFoo(...) (...)

MustFoo一般提供了一个不带error返回的类型。

直接使用bool值

对于bool类型的变量var b bool,直接使用它作为判断条件,而不是使用它和true/false进行比较

1
2
3
4
5
6
7
8
if b {
 ...
}
if !b {
 ...
}

而不是

1
2
3
4
5
6
7
if b == true {
 ...
}
if b == false {
 ...
}

byte/string slice相等性比较

不要使用

1
2
3
4
5
 var s1 []byte
 var s2 []byte
 ...
bytes.Compare(s1, s2) == 0
bytes.Compare(s1, s2) != 0

而是:

1
2
3
4
5
 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字面值

对于两个类型:

1
2
3
4
5
6
7
8
9
type t1 struct {
	a int
	b int
}
type t2 struct {
	a int
	b int
}

可以使用类型转换将类型t1的变量转换成类型t2的变量,而不是像下面的代码进行转换

1
2
v1 := t1{1, 2}
_ = t2{v1.a, v1.b}

应该使用类型转换,因为这两个struct底层的数据结构是一致的。

1
_ = t2(v1)

复制slice

不要使用下面的复制slice的方式:

1
2
3
4
5
6
7
8
var b1, b2 []byte
	for i, v := range b1 { 
		b2[i] = v
	}
	for i := range b1 { 
		b2[i] = b1[i]
	}

而是使用内建的copy函数:

1
copy(b2, b1)

不要在for中使用多此一举的true

不要这样:

1
2
for true {
}

而是要这样:

1
2
for {
}

尽量缩短if

下面的代码:

1
2
3
4
5
 x := true
if x {
	return true
}
return false

可以用return x代替。

同样下面的代码也可以使用return err代替:

1
2
3
4
5
6
7
8
func fn1() error {
	var err error
	if err != nil {
		return err
	}
	return nil
}
1
2
3
4
5
6
7
8
9
10
11
func fn1() bool{
 ...
 b := fn()
	if b {
		... 
 return true
	} else {
 return false
 }
}

应该写成:

1
2
3
4
5
6
7
8
9
10
11
12
func fn1() bool{
 ...
 b := fn()
 if !b {
 return false
 }
	... 
 return true
}

也就是减少if的分支/缩进。

###
不要这样:

1
2
3
4
 var a, b []int
for _, v := range a {
	b = append(b, v)
}

而是要这样

1
2
var a, b []int
b = append(b, a...)

简化range

1
2
3
4
5
6
 var m map[string]int
 for _ = range m { 
}
for _, _ = range m {
}

可以简化为

1
2
3
for range m {
}

对slice和channel也适用。

正则表达式中使用raw字符串避免转义字符

在使用正则表达式时,不要:

1
2
regexp.MustCompile("\\.") 
regexp.Compile("\\.")

而是直接使用raw字符串,可以避免大量的\出现:

1
2
regexp.MustCompile(`\.`) 
regexp.Compile(`\.`)

简化只包含单个case的select

1
2
3
select {
	case <-ch:
}

直接写成<-ch即可。send也一样。

1
2
3
4
5
6
 for { 
	select {
	case x := <-ch:
		_ = x
	}
}

直接改成 for-range即可。

这种简化只适用包含单个case的情况。

slice的索引

有时可以忽略slice的第一个索引或者第二个索引:

1
2
3
var s []int
_ = s[:len(s)]
_ = s[0:len(s)]

可以写成s[:]

使用time.Since

下面的代码经常会用到:

1
_ = time.Now().Sub(t1)

可以简写为:

1
_ = time.Since(t1)

使用strings.TrimPrefix/strings.TrimSuffix 掐头去尾

不要自己判断字符串是否以XXX开头或者结尾,然后自己再去掉XXX,而是使用现成的strings.TrimPrefix/strings.TrimSuffix。

1
2
3
4
5
6
 var s1 = "a string value"
 var s2 = "a "
 var s3 string
if strings.HasPrefix(s1, s2) { 
	s3 = s1[len(s2):]
}

可以简化为

1
2
3
var s1 = "a string value"
var s2 = "a "
var s3 = strings.TrimPrefix(s1, s2)

使用工具检查你的代码

以上的很多优化规则都可以通过工具检查,下面列出了一些有用的工具:

  1. go fmt
  2. go vet
  3. gosimple
  4. keyify
  5. staticcheck
  6. unused
  7. golint
  8. misspell
  9. goimports
  10. errcheck

参考文档

  1. https://golang.org/doc/effective_go.html
  2. https://github.com/golang/go/wiki/CodeReviewComments
  3. https://dmitri.shuralyov.com/idiomatic-go
  4. https://talks.golang.org/2014/readability.slide#1
  5. https://github.com/dominikh/go-tools/tree/master/simple
  6. https://github.com/dominikh/go-tools/tree/master/cmd/structlayout-optimize
  7. https://go-zh.org
  8. https://docs.google.com/presentation/d/1OT-dMNbiwOPeaivQOldok2hUUNMTvSC0GJ67JohLt5U/pub?start=false&loop=false&delayms=3000&slide=id.g18b1f95882_1_135
  9. https://github.com/d-smith/go-training/blob/master/idiomatic-go.md

有疑问加站长微信联系(非本文作者)

本文来自:鸟窝

感谢作者:smallnest

查看原文:编写地道的Go代码

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

关注微信
2662 次点击
暂无回复
添加一条新回复 (您需要 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传

用户登录

没有账号?注册
或
(追記) (追記ここまで)

今日阅读排行

    加载中
(追記) (追記ここまで)

一周阅读排行

    加载中

关注我

  • 扫码关注领全套学习资料 关注微信公众号
  • 加入 QQ 群:
    • 192706294(已满)
    • 731990104(已满)
    • 798786647(已满)
    • 729884609(已满)
    • 977810755(已满)
    • 815126783(已满)
    • 812540095(已满)
    • 1006366459(已满)
    • 692541889

  • 关注微信公众号
  • 加入微信群:liuxiaoyan-s,备注入群
  • 也欢迎加入知识星球 Go粉丝们(免费)

给该专栏投稿 写篇新文章

每篇文章有总共有 5 次投稿机会

收入到我管理的专栏 新建专栏