目录 [−]
- 注释
- 声明slice
- 关于字符串大小写
- 处理error而不是panic或者忽略
- 一些名称
- package级的Error变量
- 空字符串检查
- 非空slice检查
- 省略不必要的变量
- 直接使用bool值
- byte/string slice相等性比较
- 检查是否包含子字符串
- 使用类型转换而不是struct字面值
- 复制slice
- 不要在for中使用多此一举的true
- 尽量缩短if
- append slice
- 简化range
- 正则表达式中使用raw字符串避免转义字符
- 简化只包含单个case的select
- slice的索引
- 使用time.Since
- 使用strings.TrimPrefix/strings.TrimSuffix 掐头去尾
- 使用工具检查你的代码
- 参考文档
在阅读本文之前,我先推荐你阅读官方的 Effective Go文档,或者是中文翻译版: 高效Go编程,它提供了很多编写标准而高效的Go代码指导,本文不会再重复介绍这些内容。
最地道的Go代码就是Go的标准库的代码,你有空的时候可以多看看Google的工程师是如何实现的。
本文仅作为一个参考,如果你有好的建议和意见,欢迎添加评论。
注释
可以通过 /* …… */
或者 // ……
增加注释, //
之后应该加一个空格。
如果你想在每个文件中的头部加上注释,需要在版权注释和 Package前面加一个空行,否则版权注释会作为Package的注释。
|
|
注释应该用一个完整的句子,注释的第一个单词应该是要注释的指示符,以便在godoc中容易查找。
注释应该以一个句点.
结束。
声明slice
声明空的slice应该使用下面的格式:
|
|
而不是这种格式:
|
|
前者声明了一个nil
slice而后者是一个长度为0的非nil的slice。
关于字符串大小写
错误字符串不应该大写。
应该写成:
|
|
而不是写成:
|
|
这是因为这些字符串可能和其它字符串相连接,组合后的字符串如果中间有大写字母开头的单词很突兀,除非这些首字母大写单词是固定使用的单词。
缩写词必须保持一致,比如都大写URL
或者小写url
。比如HTTP
、ID
等。
例如sendOAuth
或者oauthSend
。
常量一般声明为MaxLength
,而不是以下划线分隔MAX_LENGTH
或者MAXLENGTH
。
也就是Go语言一般使用MixedCaps
或者mixedCaps
命名的方式区分包含多个单词的名称。
处理error而不是panic或者忽略
为了编写强壮的代码,不用使用_
忽略错误,而是要处理每一个错误,尽管代码写起来可能有些繁琐。
尽量不要使用panic。
一些名称
有些单词可能有多种写法,在项目中应该保持一致,比如Golang采用的写法:
|
|
而不是
|
|
包名应该用单数的形式,比如util
、model
,而不是utils
、models
。
Receiver 的名称应该缩写,一般使用一个或者两个字符作为Receiver的名称,如
|
|
如果方法中没有使用receiver,还可以省略receiver name,这样更清晰的表明方法中没有使用它:
|
|
package级的Error变量
通常会把自定义的Error放在package级别中,统一进行维护:
|
|
并且变量以Err
开头。
空字符串检查
不要使用下面的方式检查空字符串:
|
|
而是使用下面的方式
|
|
下面的方法更是语法不对:
|
|
非空slice检查
不要使用下面的方式检查空的slice:
|
|
直接比较长度即可:
|
|
同样的道理也适用 map
和channel
。
省略不必要的变量
比如
|
|
可以简写为
|
|
有时候你看到的一些第三方的类提供了类似的方法:
|
|
MustFoo一般提供了一个不带error返回的类型。
直接使用bool值
对于bool类型的变量var b bool
,直接使用它作为判断条件,而不是使用它和true/false进行比较
|
|
而不是
|
|
byte/string slice相等性比较
不要使用
|
|
而是:
|
|
检查是否包含子字符串
不要使用 strings.IndexRune(s1, 'x') > -1
及其类似的方法IndexAny
、Index
检查字符串包含,
而是使用strings.ContainsRune
、strings.ContainsAny
、strings.Contains
来检查。
使用类型转换而不是struct字面值
对于两个类型:
|
|
可以使用类型转换将类型t1的变量转换成类型t2的变量,而不是像下面的代码进行转换
|
|
应该使用类型转换,因为这两个struct底层的数据结构是一致的。
|
|
复制slice
不要使用下面的复制slice的方式:
|
|
而是使用内建的copy
函数:
|
|
不要在for中使用多此一举的true
不要这样:
|
|
而是要这样:
|
|
尽量缩短if
下面的代码:
|
|
可以用return x
代替。
同样下面的代码也可以使用return err
代替:
|
|
|
|
应该写成:
|
|
也就是减少if的分支/缩进。
append slice
不要这样:
|
|
而是要这样
|
|
简化range
|
|
可以简化为
|
|
对slice
和channel
也适用。
正则表达式中使用raw
字符串避免转义字符
在使用正则表达式时,不要:
|
|
而是直接使用raw字符串,可以避免大量的\
出现:
|
|
简化只包含单个case的select
|
|
直接写成<-ch
即可。send也一样。
|
|
直接改成 for-range
即可。
这种简化只适用包含单个case的情况。
slice的索引
有时可以忽略slice的第一个索引或者第二个索引:
|
|
可以写成s[:]
使用time.Since
下面的代码经常会用到:
|
|
可以简写为:
|
|
使用strings.TrimPrefix/strings.TrimSuffix 掐头去尾
不要自己判断字符串是否以XXX开头或者结尾,然后自己再去掉XXX,而是使用现成的strings.TrimPrefix/strings.TrimSuffix
。
|
|
可以简化为
|
|
使用工具检查你的代码
以上的很多优化规则都可以通过工具检查,下面列出了一些有用的工具:
- go fmt
- go vet
- gosimple
- keyify
- staticcheck
- unused
- golint
- misspell
- goimports
- errcheck
- aligncheck
- structcheck
- varcheck
参考文档
- https://golang.org/doc/effective_go.html
- https://github.com/golang/go/wiki/CodeReviewComments
- https://dmitri.shuralyov.com/idiomatic-go
- https://talks.golang.org/2014/readability.slide#1
- https://github.com/dominikh/go-tools/tree/master/simple
- https://github.com/dominikh/go-tools/tree/master/cmd/structlayout-optimize
- https://go-zh.org
- https://docs.google.com/presentation/d/1OT-dMNbiwOPeaivQOldok2hUUNMTvSC0GJ67JohLt5U/pub?start=false&loop=false&delayms=3000&slide=id.g18b1f95882_1_135
- https://github.com/d-smith/go-training/blob/master/idiomatic-go.md
- https://github.com/opennota/check
- http://golang-sizeof.tips
- https://github.com/mibk/dupl