Golang代码规范
Golang代码规范
参考 https://golang.org/doc/effective_go.html
[TOC]
项目目录结构规范
项目的目录结构尽量做到简明、层次清楚。
文件名命名规范
用小写，尽量见名思义，看见文件名就可以知道这个文件下的大概内容，对于源代码里的文件，文件名要很好的代表了一个模块实现的功能。
命名规范
包名
包名用小写,使用短命名,尽量和标准库不要冲突
接口名
单个函数的接口名以”er”作为后缀，如Reader,Writer
接口的实现则去掉“er”
两个函数的接口名综合两个函数名
三个以上函数的接口名，类似于结构体名
变量
全局变量：采用驼峰命名法，仅限在包内的全局变量，包外引用需要写接口，提供调用 局部变量：驼峰式，小写字母开头
常量
常量：大写，采用下划线
import 规范
import在多行的情况下，goimports会自动帮你格式化，在一个文件里面引入了一个package，建议采用如下格式：
如果你的包引入了三种类型的包，标准库包，程序内部包，第三方包，建议采用如下方式进行组织你的包：
在项目中不要使用相对路径引入包：
// 这是不好的导入
// 这是正确的做法
函数名
函数名采用驼峰命名法，尽量不要使用下划线
错误处理
error作为函数的值返回,必须尽快对error进行处理
采用独立的错误流进行处理
不要采用这种方式
而要采用下面的方式
如果返回值需要初始化，则采用下面的方式
Panic
在逻辑处理中禁用panic
在main包中只有当实在不可运行的情况采用panic，例如文件无法打开，数据库无法连接导致程序无法 正常运行，但是对于其他的package对外的接口不能有panic，只能在包内采用。 建议在main包中使用log.Fatal来记录错误，这样就可以由log来结束程序。
Recover
recover用于捕获runtime的异常，禁止滥用recover，在开发测试阶段尽量不要用recover，recover一般放在你认为会有不可预期的异常的地方。
Defer
defer在函数return之前执行，对于一些资源的回收用defer是好的，但也禁止滥用defer，defer是需要消耗性能的,所以频繁调用的函数尽量不要使用defer。
控制结构
if
if接受初始化语句，约定如下方式建立局部变量
for
采用短声明建立局部变量
range
如果只需要第一项（key），就丢弃第二个：
如果只需要第二项，则把第一项置为下划线
return
尽早return：一旦有错误发生，马上返回
方法的接收器
名称 一般采用strcut的第一个字母且为小写，而不是this，me或者self
如果接收者是map,slice或者chan，不要用指针传递
如果需要对slice进行修改，通过返回值的方式重新赋值
如果接收者是含有sync.Mutex或者类似同步字段的结构体，必须使用指针传递避免复制
如果接收者是大的结构体或者数组，使用指针传递会更有效率。
注释
- 所有的 public 方法和变量都要添加注释
- 注释格式为：name describeContent