介绍 
说到不如做到

代码目录规范

GOPATH 设置规范

建议保留 GOPATH 规则，便于维护代码
  • 建议只使用一个 GOPATH
  • 不建议使用多个 GOPATH，如果使用多个GOPATH，编译生效的 bin 目录是在第一个 GOPATH 下

golang 在 1.11 以后，弱化了 GOPATH 规则，已有代码(很多库肯定是在1.11之前建立的)肯定符合这个规则

go mod 工具链在 GOPATH 代码下，需要额外打开环境变量配置 GO111MODULE=on go 1.13 以后可以设置兼容

工程根目录规范

golang工程结构很重要，决定了代码是否可以共享和维护

$GOPATH/src/
必须这样放置
${GOPATH}/src/${GIT_HOST}/{$GIT_USER}|${GIT_GROUP}/${PROJ_ROOT}
GIT_HOSTGIT_USERGIT_GROUPPROJ_ROOT
github.com/sinlov/go-cli-fast-temp$GOPATH/src/
-全小写无分割符的 c 风格

工程子包名规范

代码包名全小写无分割符的 c 风格git 全路径来定义新的包名

golang代码文件命名规范

驼峰命名描述工具作用全小写，描述单一模型全小写，描述业务合辑_test.go

golang编码实现规范

  • 不要在 init 函数里做与变量初始化无关的工作
  • 不要在 业务代码里面写 test 或者其他非输出的代码

更多规范建议看

编程规范检查工具

golang 生态链本身提供很多代码规范的工具，不用额外制定规范

静态检查工具

静态检查工具在 CI/CD 链中集成，即时发现即时补救

go vet

go vet-n-x

go tool vet

go tool vet 命令的作用是检查Go语言源代码并且报告可疑的代码编写问题

比如，在调用Printf函数时没有传入格式化字符串，以及某些不标准的方法签名，等等

该命令使用试探性的手法检查错误，因此并不能保证报告的问题确实需要解决。它确实能够找到一些编译器没有捕捉到的错误。

go tool vet 命令的标记

race condition 竞争检查

资源竞争检查，并发时遇到的问题，会导致并发能力下降, 长时间运行一般会出现这个错误

  • 检查方法

风格检查

不建议制定风格检查文档，又冗长，又无法实施

golint

安装方法

使用

golint 检查范围就非常广了，也很严格，可以配合 vscode 的 go 插件，或者 goland 的 golint 来检查代码风格