第4条 使用Go语言原生编程思维来写Go代码
经过十几年的演进和发展,Go语言在全世界范围内已经拥有了百万级别的拥趸,在这些开发者当中,有一部分新入行的编程语言初学者,而更多的是从其他编程语言阵营转过来的开发者。由于Go语言上手容易,在转Go的初期大家很快就掌握了Go的语法。但在编写一些Go代码之后,很多人感觉自己写的Go代码很别扭,并且总是尝试在Go语言中寻找自己熟悉的上一门语言中的语法元素。自己的Go代码风格似乎与Go标准库、主流Go开源项目的代码在思考角度和使用方式上存在不小差异,并且每每看到Go核心开发团队的代码时总有一种醍醐灌顶的感觉。出现这种情况的主要原因是大脑中上一门编程语言的思维方式在“作祟”。
醍醐灌顶到没有,别扭确实存在。当然这需要一段时间来适应,说下这段时间最难接受的点吧。 1、文件的单一职责做不好,一个文件里有多个结构体,想知道某个结构体有哪些方法,需要借助IDE 2、命名使用单字母,特定场景能理解,例如循环里的i,遍历map的k,v,但是很多单字母不是这种常见场景里的。代码整洁之道里说命名要见名知意,宁愿用长命名也不用无法表达清楚的短命名,这点go背道而驰。此书里说有时需要短命名加注释,而代码整洁之道里说注释就不应该存在,如果要用注释,说明写的代码无法准确清晰的表达意思。
4.1 语言与思维——来自大师的观点
在人类自然语言学界有一个很著名的假说——“萨丕尔-沃夫假说”,这个假说的内容是这样的:“语言影响或决定人类的思维方式。”
奇妙的是,在编程语言界,有位大师级人物也有着与“萨丕尔-沃夫假说”异曲同工的观点和认知,他就是首届图灵奖得主、著名计算机科学家艾伦·佩利(Alan J. Perlis),他从另外一个角度提出:“不能影响到你的编程思维方式的编程语言不值得学习和使用。”
4.2 现实中的“投影”
Go版本程序实现了一个并发素数筛,它采用的是goroutine的并发组合。程序从素数2开始,依次为每个素数建立一个goroutine,用于作为筛除该素数的倍数。ch指向当前最新输出素数所位于的筛子goroutine的源channel。这段代码来自Rob Pike的一次关于并发的分享[1]。Go版本程序的执行过程可以用图4-2立体地展现出来。
看来利用并发解决问题的思维需加强
代码语言:javascript复制func Generate(ch chan<- int) {
for i := 2; ; i {
ch <- i
}
}
func Filter(in <-chan int, out chan<- int, prime int) {
for {
i := <-in
if i%prime != 0 {
out <- i
fmt.Printf("prime=%d,i=%dn", prime, i)
}
}
println("Filter over")
}
func main() {
ch := make(chan int)
go Generate(ch)
for i := 0; i < 10; i {
prime := <-ch
print(prime, "n")
ch1 := make(chan int)
go Filter(ch, ch1, prime)
ch = ch1
}
}
Go版本程序实现了一个并发素数筛,它采用的是goroutine的并发组合。程序从素数2开始,依次为每个素数建立一个goroutine,用于作为筛除该素数的倍数。ch指向当前最新输出素数所位于的筛子goroutine的源channel。这段代码来自Rob Pike的一次关于并发的分享[1]。Go版本程序的执行过程可以用图4-2立体地展现出来。
这个程序没看明白,调试下程序看看
明白这个代码了,主要有两点需要注意,1、无缓冲队列的chan必须取和放是同时发生,所以创建的goroutine不会无限制的跑。2、创建的chan,依次是:过滤了2的倍数的chan,过滤了2、3的倍数的chan,过滤了2、3、5的倍数的chan
4.3 Go语言原生编程思维
C的命令式思维、Haskell的函数式思维和Go的并发思维。
我们的目标是编写出高质量的Go代码,这就需要我们在学习语言的同时,不断学习Go语言原生的编程思维,时刻用Go编程思维考虑Go代码的设计和实现,这是通往高质量Go代码的必经之路。
特别是要善用并发去解决问题
学习Go,就要用Go的原生编程思维而不是用其他语言的思维方式写Go代码。
第二部分 项目结构、代码风格与标识符命名
第5条 使用得到公认且广泛使用的项目结构
在Go语言中,项目结构十分重要,因为它决定了项目内部包的布局及包依赖关系是否合理,同时还会影响到外部项目对该项目中包的依赖与引用。
1、内部层级 2、打包后给外部使用时,并不是开放所有代码,可以通过目录控制
5.1 Go项目的项目结构
5.2 Go语言典型项目结构
cmd目录:存放项目要构建的可执行文件对应的main包的源文件。如果有多个可执行文件需要构建,则将每个可执行文件的main包单独放在一个子目录中,比如图中的app1、app2。cmd目录下的各app的main包将整个项目的依赖连接在一起,并且通常来说,main包应该很简洁。我们会在main包中做一些命令行参数解析、资源初始化、日志设施初始化、数据库连接初始化等工作,之后就会将程序的执行权限交给更高级的执行控制对象。有一些Go项目将cmd这个名字改为app,但其功用并没有变。
pkg目录:存放项目自身要使用并且同样也是可执行文件对应main包要依赖的库文件。该目录下的包可以被外部项目引用,算是项目导出包的一个聚合。有些项目将pkg这个名字改为lib,但该目录的用途不变。由于Go语言项目自身在1.4版本中去掉了pkg这一层目录,因此有一些项目直接将包平铺到项目根路径下,但笔者认为对于一些规模稍大的项目,过多的包会让项目顶层目录不再简洁,显得很拥挤,因此个人建议对于复杂的Go项目保留pkg目录。
Makefile:这里的Makefile是项目构建工具所用脚本的“代表”,它可以代表任何第三方构建工具所用的脚本。Go并没有内置如make、bazel等级别的项目构建工具,对于一些规模稍大的项目而言,项目构建工具似乎不可缺少。在Go典型项目中,项目构建工具的脚本一般放在项目顶层目录下,比如这里的Makefile;对于构建脚本较多的项目,也可以建立build目录,并将构建脚本的规则属性文件、子构建脚本放入其中。
go.mod和go.sum:Go语言包依赖管理使用的配置文件。Go 1.11版本引入Go module机制,Go 1.16版本中,Go module成为默认的依赖包管理和构建机制。因此对于新的Go项目,建议基于Go module进行包依赖管理。对于没有使用Go module进行包管理的项目(可能主要是一些使用Go 1.11以前版本的Go项目),这里可以换为dep的Gopkg.toml和Gopkg.lock,或者glide的glide.yaml和glide.lock等。
vendor目录(可选):vendor是Go 1.5版本引入的用于在项目本地缓存特定版本依赖包的机制。在引入Go module机制之前,基于vendor可以实现可重现的构建(reproducible build),保证基于同一源码构建出的可执行程序是等价的。Go module本身就可以实现可重现的构建而不需要vendor,当然Go module机制也保留了vendor目录(通过go mod vendor可以生成vendor下的依赖包;通过go build -mod=vendor可以实现基于vendor的构建),因此这里将vendor目录视为一个可选目录。一般我们仅保留项目根目录下的vendor目录,否则会造成不必要的依赖选择的复杂性。
Go 1.4发布时,Go语言项目自身去掉了src下的pkg这一层目录,这个结构上的改变对那些以只构建库为目的的Go库类型项目结构有一定的影响。我们来看一个典型的Go语言库类型项目的结构布局,见图5-2。
图5-2 Go语言库项目结构我们看到库类型项目结构与Go项目的最小标准布局也是兼容的,但比以构建二进制可执行文件为目的的Go项目要简单一些。去除了cmd和pkg两个子目录:由于仅构建库,没必要保留存放二进制文件main包源文件的cmd目录;由于Go库项目的初衷一般都是对外部(开源或组织内部公开)暴露API,因此也没有必要将其单独聚合到pkg目录下面了。vendor不再是可选目录:对于库类型项目而言,不推荐在项目中放置vendor目录去缓存库自身的第三方依赖,库项目仅通过go.mod(或其他包依赖管理工具的manifest文件)明确表述出该项目依赖的模块或包以及版本要求即可。
无论是上面哪种类型的Go项目,对于不想暴露给外部引用,仅限项目内部使用的包,在项目结构上可以通过Go 1.4版本中引入的internal包机制来实现。
在Go语言早期,很多项目将所有源文件都放在位于项目根目录下的根包中,这个方法也适合一些小规模项目。
第6条 提交前使用gofmt格式化源码
自从现代编程语言出现以来,针对每种编程语言的代码风格的争论就不曾停止过,直到Go语言的出现,人们才惊奇地发现Go社区似乎很少有针对Go语言代码风格的争论。
6.1 gofmt:Go语言在解决规模化问题上的最佳实践
在一致的代码风格下,Go开发人员阅读和维护他人代码时不再感到陌生,效率也变得更高了
这一点确实很重要,在Java项目中,不同的人写的风格有很大差异,导致阅读、维护就很烦,不是说看不懂、改不了,而是影响心情