go语言规范指南

1. 写完代码都必须格式化，保证代码优雅: gofmt goimports
2. 编译前先执行代码静态分析: go vet pathxxx/ 可以检测出如下的常见错误：

//Print-format 打印格式错误
var str string
fmt.Printf("str:%d", str)
//Boolean 可疑布尔值
var i int
fmt.Println(i==0 && i==1)
//Range 闭包变量问题
words := []string{"f","b"}
for _, w := words {
    go func() {
        fmt.Println(w)
    }()
}
//位移问题
fmt.Println(i>>32)
//提前结束，后续代码不可达
return

3. 竞态检测: go build –race (测试环境编译时加上 -race 选项，生产环境必须去掉，因为race限制最多goroutine数量为8192个)
4. package 名字:包名与目录保持一致，尽量有意义，简短，不和标准库冲突， 全小写，不要有下划线
5. 每行长度约定: 一行不要太长，超过请使用换行展示，尽量保持格式优雅；单个文件也不要太大，最好不要超过500行
6. 错误处理机制:使用多返回值 error， 不要使用 c 风格，返回错误码，错误 信息放在输入参数，特别是封装 cgo 的函数
   7，多返回值最多返回三个，超过三个请使用 struct
7. 请求路径携带标准库 context 上下文:一个请求内的所有处理逻辑都必须带上 context，并且以函数第一个参数传入，context 可以取消，超时，传值
8. 注意 slice 引用问题：使用 copy 防止数据篡改，防止无法 GC 而导致内存泄漏
9. new 新对象采用多行，更加一目了然

p := &StructName{

    field1: 1,

    field2: "aaaa",
}

11. 变量名采用驼峰法，不要有下划线，不要全部大写
12. 时刻提醒自己 goroutine 的生命周期，注意同步 channel，防止 goroutine 堵 住，释放不了，出现内存泄漏
13. 注意关闭 channel 问题，不能 close 两次，不能向 closed 的 chan 写入数据
14. 不可在 goroutine 内部做耗时的纯逻辑计算工作，如死循环，cgo 同步函数，cgo系统调用
15. 自定义类型的 String 方法死循环问题，不可在 String 方法内使用 fmt 打印自 己

type MyInt int

func (m MyInt) String() string {

     return fmt.Sprint(m) //BUG:死循环
}

func (m MyInt) String() string {

    return fmt.Sprint(int(m)) //这是安全的,因为我们内部进行了类型转换
}

16. 注释规范：每个包，可导出 struct，函数，常量，变量，都必须要有注释， 格式是紧挨着的上一行，这样写:

// Package pkgname xxxx
// FuncName xxxx
// TODO xxxx
// BUG xxxx

每一个对外服务的接口都要注释接口功能、调用方，每个后端调用都要注释后台功能、负责人，这样方便联调对接以及后续交接维护

17. 在逻辑处理中禁用 panic，除非你知道你在做什么
18. 不要忽略 error，每个 error 都必须处理，实在不用处理，就打印 error。有 错误尽早返回
    不要这样写:

if err != nil {

    // error handling

} else {

    // normal code

}

而应该是:

if err != nil {

    // error handling

    return // or continue, etc.
}

// normal code

19. 常用的首字母缩写名词，使用全小写或者全大写，如 UIN URL HTTP ID IP OK
20. Receiver:：用一两个字符，能够表示出类型，不要使用 me self this
21. 参数传递:
    – 对于少量数据，不要传递指针
    – 对于大量数据的 struct 可以考虑使用指针
    – 传入参数是 map，slice，chan，interface，string 不要传递指针
22. 每个基础库都必须有实际可运行的例子, 基础库的接口都要有单元测试用例
23. 尽量少用命名多返回值，如果要用，必须显示 return结果，因为作用域问题容易出bug，例如：

func test1() (a int, e error) {
    return 1, errors.New("test1")
}

func test2() (a int, e error) {
    a, e = 10, nil
    for {
        aa, e := test1()    //  注意：这里的 e 是新的变量
        if aa == 1 || e != nil {
           break
        }
    }
    return    // 这里返回的e不是预期错误，而是nil
}

24. ctx是当前请求上下文，在请求退出时会cancel掉，在自己另起的goroutine里面不要使用同一个ctx请求后端
25. http服务在超时以及客户端主动断开连接的时候会有另外的goroutine写context，业务代码里面不能直接打印整个ctx，如 fmt.Printf("%+v", ctx)， 否则会导致服务crash
26. 不要在for循环里面使用defer，defer只有在函数退出时才会执行
27. udp请求使用net.DialUDP时，内部会调用connect，只能接收来自对端的回包，这对于非原路径回包的场景下会有问题
28. 禁止在业务代码里面调用cgo
29. panic捕获只能到goroutine最顶层，每个自己启动的goroutine，必须在入口处就捕获panic，并打印出详细的堆栈信息
30. golang的内置类型slice，map，chan都是引用，初次使用前，都必须先用make分配好对象，不然会有空指针异常
31. 使用map时需要注意：map初次使用，必须用make初始化；map是引用，不用担心赋值内存拷贝；并发操作时，需要加锁；range遍历时顺序不确定，不可依赖；不能使用slice，map和func作为key
32. mysql scan过程中，不允许执行其他sql语句，否则会导致数据集错乱