编码时如何确定项目结构、代码风格与标识符命名,Go语言提供了官方的或社区实用的答案,使Go语言的风格不只是某人的最爱,而是Go全体程序员的最爱。
项目结构
最小的项目结构是:
- a.go # 一个源文件
- b.go # 另一个源文件
- LICENSE
- go.mod # 第三方依赖库声明
常见的目录有:
cmd:存放需构建以执行的源文件
pkg:存放依赖的库文件
internal:存放内部依赖但不想被外部依赖的文件
代码风格
官方的代码风格插件减少了开发者对代码风格的讨论,一致的代码风格使人们对阅读他人代码产生熟悉感,提高了维护代码的效率,有利于多人协作的规模化开发。
常见IDE集成了一些代码风格插件:
gofmt:代码格式化
goimport:检查代码依赖的包是否被调用,增删依赖
命名风格
go实行简单且一致的命名规范。官方建议包括:
1. 包名以小写字母串联,包导入路径的最后一个路径即为包名,如:
github.com/mycomp/net/log
2. 变量命名不用体现其类型,驼峰命名,且越短越好。在越远的地方使用变量,则命名越长;在越近的地方使用,则越短越好,使用常见短变量以提高可读性,如:
for i, v := range s { ... } // 好,命名大家都知道大概意思
for index, value := range myString { ... } // 不好,命名不够短
3. 接口提供了解耦能力,定义小接口,通过接口组合的方式构建程序,如:
type Writer interface {
Write(p []byte) (n int, err error)
}
type Reader interface {
Read(p []byte) (n int, err error)
}
type ReadWriteCloser interface {
Reader
Writer
}