高质量编程

编程原则：

简单
可读
高效产出

编码规范

代码格式

可以使用gofmt自动格式化代码。

    gofmt  hello.go　　仅打印代码格式化后的结果
    gofmt   project　　格式化并重写project目录下所有 Go 源文件
    
-w 参数可以将执行的修改应用的源文件中。
    gofmt  -w   filename
    gofmt  -w  hello.go　　   会格式化该源文件的代码然后将格式化后的代码覆盖原始内容
    gofmt  -w  *.go     格式化并重写所有 Go 源文件

-r  参数可以对文件内容进行一些简单的替换
    go  -r  <原始内容>  ->  <替换内容>
    gofmt   -r   '(a) -> a'   –w   *.go     会将源文件中没有意义的括号去掉
    gofmt –r 'A.Func1(a,b) -> A.Func2(b,a)' –w *.go     会将源文件中符合条件的函数的参数调换位置

gofmt是一个独立的cli程序，而go中还有一个go fmt命令，go fmt命令是gofmt的简单封装。

usage: go fmt [-n] [-x] [packages]

Fmt runs the command 'gofmt -l -w' on the packages named
by the import paths. It prints the names of the files that are modified.
For more about gofmt, see 'go doc cmd/gofmt'.
For more about specifying packages, see 'go help packages'.
The -n flag prints commands that would be executed.
The -x flag prints commands as they are executed.
To run gofmt with specific options, run gofmt itself.

See also: go fix, go vet.

go fmt命令本身只有两个可选参数-n和-x，-n仅打印出内部要执行的go fmt的命令，-x命令既打印出go fmt命令又执行它，如果需要更细化的配置，需要直接执行gofmt命令。

注释

注释应该做什么：

解释代码作用
解释代码怎么做
解释代码为什么这样做
解释代码在什么情况下会出错

公共符号的注释必加：

包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何,对库中的任何函数都必须进行注释

其实本质上我们还是要把代码写好，逻辑写通，命名规范，代码是最好的注释。

命名规范

变量

规范要素：

尽可能简洁
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写，例如：
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest 或者xmlHTTPRequest
变量距离其被使用的地方越远，则需要携带越多的上下文信息，因为全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

案例：

for index := 0  ...
//优化后
for i := 0      ...

for循环只有个循环体的情况下，index比i冗余，不易理解。

函数

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的函数名尽量简短
当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
当名为foo 的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型

包

只由小写字母组成。不包含大写字母和下划线等字符
简短并包含一定的上下文信息。例如schema、task 等
不要与标准库同名。例如不要使用sync 或者strings

不使用常用变量名作为包名。例如使用bufio 而不是 buf
使用单数而不是复数。例如使用encoding而不是encodings
谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format 更加简短

控制流程

避免嵌套：

if ...{
    return 1
}else {
    return 2
}
直接优化为：
if ...{
    return 1
}
return 2

保持代码路径最小缩进：

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

原则：

线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中

错误以及异常处理

简单错误

简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
优先使用errors.New来创建匿名变量来直接表示简单错误
如果有格式化的需求，使用fmt.Errorf

错误的wrap、unwrap

错误的Wrap 实际上是提供了一个error嵌套另一个error 的能力，从而生成一个error的跟踪链
在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中

错误判定

判定一个错误是否为特定错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

在错误链上获取特定种类的错误，使用errors.As

defer语句

多个defer语句执行顺序：

func main( ) {
    if true {
        defer fmt.Printf( "1")  //1
    }else {
        defer fmt.Printf( "2")  //2
    }
    defer fmt .Printf( "3")     //3
}
1先进入栈，随后3进入栈，然后按照后进先出的顺序执行：
结果是31