[TOC]

介绍

本文更多的介绍代码管理和检查工具
而不是大篇幅风格文档,毕竟文档不如工具扫描有时效性和可行性

uber golang 代码规范 https://github.com/uber-go/guide
uber golang 代码规范中文 https://github.com/xxjwxc/uber_go_guide_cn

代码目录规范

GOPATH 设置规范

  • 建议只使用一个 GOPATH
  • 不建议使用多个 GOPATH,如果使用多个GOPATH,编译生效的 bin 目录是在第一个 GOPATH 下
建议保留 GOPATH 规则,便于维护代码
$ go env -w GO111MODULE='on'

工程根目录规范

$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 风格

golang代码文件命名规范

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

golang编码实现规范

  • 不要在init函数里做与变量初始化无关的工作
编程规范检查工具

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

静态检查工具

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

go vet

go vet-n-x

go tool vet

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

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

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

go tool vet 命令的标记

-all 进行全部检查。如果有其他检查标记被设置,则命令程序会将此值变为false。默认值为true。
-asmdecl 对汇编语言的源码文件进行检查。默认值为false。
-assign 检查赋值语句。默认值为false。
-atomic 检查代码中对代码包sync/atomic的使用是否正确。默认值为false。
-buildtags 检查编译标签的有效性。默认值为false。
-composites 检查复合结构实例的初始化代码。默认值为false。
-compositeWhiteList 是否使用复合结构检查的白名单。仅供测试使用。默认值为true。
-methods 检查那些拥有标准命名的方法的签名。默认值为false。
-printf 检查代码中对打印函数的使用是否正确。默认值为false。
-printfuncs 需要检查的代码中使用的打印函数的名称的列表,多个函数名称之间用英文半角逗号分隔。默认值为空字符串。
-rangeloops 检查代码中对在```range```语句块中迭代赋值的变量的使用是否正确。默认值为false。
-structtags 检查结构体类型的字段的标签的格式是否标准。默认值为false。
-unreachable 查找并报告不可到达的代码。默认值为false。

race condition 竞争检查

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

panic: runtime error: invalid memory address or nil pointer dereference
  • 检查方法
# 任意代码,构建时加入参数`-race`
go build -race

风格检查

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

golint

安装方法

go get -v github.com/golang/lint
go install github.com/golang/lint

使用

golint [dir or file]

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