首页 > 应用开发 > > Uber 把公司内部的《Go 语言风格指南》开源了
程序员书库(ID:CodingBook) 猿妹综合编译
项目地址:https://github.com/uber-go/guide/blob/master/style.md
Uber 近日开放了其公司内部使用的《Go 语言风格指南》。
根据Uber的介绍,《Go 语言风格指南》是支配Uber代码的惯例,这些惯例不仅涵盖源文件格式,而且由gofmt代替处理。(gofmt工具可以帮助开发者格式化他们的代码到统一的风格。)
本指南通过详细介绍了Uber在编写Go代码时的注意事项,从而使代码库更加易于管理,帮助开发者们更好的使用Go的语言特性
该指南最初由Prashant Varanasi和Simon Newton编写,目的是使一些同事快速使用Go。多年来,已根据其他人的反馈进行了多次的修改。
其中许多约定是 Go 的通用准则,而其它准则则参考了外部资源:
Effective Go
The Go common mistakes guide
所用的代码在运行 golint 和 go vet 之后不会有报错。建议将编辑器设置为:
保存时运行 goimports
运行 golint 和 go vet 来检查错误
下面以接口和指针为例
你几乎不需要指向接口的指针,你应该把接口当作值传递,它的基础数据仍然可以当成一个指针。
一个接口是两个字段:
1、指向特定类型信息的指针。你可以认为这是 "type."。
2、数据指针,如果存储的数据是指针,则直接存储。如果数据存储的是值,则存储指向此值的指针。
如果要接口方法修改基础数据,则必须使用指针。
接收器和接口
具有值接收器的方法可以被指针和值调用。例如:
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"}}
// You can only call Read using a value
sVals[1].Read()
// This will not compile:
// sVals[1].Write("test")
sPtrs := map[int]*S{1: {"A"}}
// You can call both Read and Write using a pointer
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
// The following doesn't compile, since s2Val is a value, and there is no value receiver for f.
// i = s2Val
Effective Go对Pointers vs. Values分析的不错
目前,guide在Github上标星2.9K,获得246个Fork(Github地址:https://github.com/uber-go/guide/blob/master/style.md)
来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/835/viewspace-3138196/ ,如需转载,请注明出处,否则将追究法律责任。