因为最近在编写安全扫描仪，为了更好更高效的完成代码的编写，笔者认为有必要学习官方建议，但官方似乎很难保存英文内容，所以搜索整理出来Effective Go以中文版为参考。
整理合并以下内容；
https://go.dev/doc/effective_go
https://www.kancloud.cn/kancloud/effective/72199
https://github.com/gqcn/effective-go-zh-en
介绍
Go 是一种全新的语言。尽管它从既有的语言中借鉴了许多理念，但其与众不同的特性， 使得使用 Go 编程本质上不同于其他语言。将现有的 C 或 Java 程序直译为 Go 程序不尽如人意 —— 毕竟 Java 程序是用 Java 而非 Go。 另一方面，若从 Go 从分析问题的角度来看，你可以编写同样可行但非常不同的程序。 换句话说，要想将 Go 如果程序写得好，就必须了解它的特点和风格。了解命名，格式化， 程序结构等既定规则也很重要，这样你写的程序就更容易被其他程序员理解。
本文档如何编写清晰、地道？ Go 代码提供了一些技能。它是语言规范， Go 语言之旅和 如何使用 Go 编程 因此，我们建议您先阅读这些文档。
示例
Go 包的源码 它不仅是核心库，也是学习如何使用它 Go 语言示例源代码。 此外，其中一些包还包含独立的可执行示例，您可以直接执行 golang.org 它们在网站上运行，比如 这个例子 。如果你对如何解决某些问题或如何实现某些问题有任何疑问， 也可以从中获得相关的答案、思路和后台实现。
格式化
格式化问题总是有争议的，但没有统一的结论。虽然人们可以适应不同的编码风格， 但是放弃这个适应过程不是更好吗？如果每个人都遵循相同的编码风格，在这类问题上浪费的时间就会更少。 问题是如何在没有冗长语言风格规范的情况下实现这个想法。
在 Go 我们另辟蹊径，让机器处理大部分格式化问题。gofmt 程序(也可用 go fmt，它将以包为处理对象，而不是源文件) Go 程序按标准风格缩进， 对齐，在需要时保留注释并重新格式化。如果您想知道如何处理一些新的代码布局，请尝试操作 gofmt；如果结果仍然不令人满意，请重新组织您的程序（或提交相关程序） gofmt 的 Bug），而不必为此纠结。
例如，你不需要花时间注释结构中的字段，gofmt 为你服务。 若有下列声明：
type T struct {
name string // name of the object value int // its value } gofmt 将其按列对齐为：
type T struct {
name string // name of the object value int // its value } 所有标准包 Go 已经使用了所有代码 gofmt 格式化过了。
还有一些关于格式化的细节，
我们使用制表符（tab）缩进，gofmt 默认情况下也使用它。在你认为有必要的时候使用空间。
Go 行长没有限制，不要担心打孔纸不够长。如果行太长，也可以折叠并插入适当的行 tab 缩进。
比起 C 和 Java，Go 所需括号较少：控制结构（if、for 和 switch）语法上不需要圆括号。此外，操作符优先级处理变得更加简单，因此
x<<8 y<<16 它表达了空格符所传达的。
代码注释
Go 语言支持 C 风格块注释 /* */ 和 C 行注的风格 //。 行注释比较常用，而块注释主要用作包注释，当然也可以在禁用大代码时使用。
godoc 既是程序，也是程序 Web 服务器，是的 Go 处理源代码，提取包中的文档内容。 出现在顶级声明之前，与声明之间没有空行注释，将与声明一起提取，作为本条目的说明文件。 这些注释的类型和风格决定了 godoc 生成的文档质量。
每个包都应该包含一段，也就是说，放在包子句前的块注释。对于包含多个文件的包， 包注释只需出现在其中任何一份文件中即可。包注释应整体介绍包，并提供包的相关信息。 它将出现在 godoc 在页面的顶部，并为后续内容建立详细的文档。
/* regexp 包为正则表达式实现了一个简单的库。 图书馆接受的正则表达式语法是： regexp: concatenation { '|' concatenation } concatenation: { closure } closure: term [ '*' | ' ' | '?' ] term: '^' '$' '.' character '[' [ '^' ] character-ranges ']' '(' regexp ')' */ package regexp 假如一个包比较简单，包注释也可以比较简单。
// path 包实现了一些常用的工具， // 便于操作用反斜杠分隔的路径. 注释不需要额外的格式化，比如用星号突出。产生的输出甚至可能无法显示为等宽字体， 因此不要依赖于空格对齐，godoc 会像 gofmt 处理好这一切。 注释是不会被分析的纯文本，所以就像 HTML 或其它类似 _这样_ 按 因此，它们不应用于输出。godoc 调整， 用等宽字体显示等宽字体显示，以适应相应的程序片段。 fmt 这种很好的效果用于包的注释。
godoc 是否会重新格式化注释取决于上下文，因此必须确保它们看起来清晰易辨： 使用正确的拼写、标点符号、句子结构和折叠长行。
在包中，任何顶级声明前的注释都将作为声明。 在程序中，应注明每个可导出的名称（首字母大写）。
文档注释最好是完整的句子，以适应各种自动化显示。 第一句话要从被声明的东西开始，是单句的摘要。
// Compile 用于分析正则表达式并返回span // 功，则 Regexp 对象就可用于匹配所针对的文本。 func Compile(str string) (*Regexp, error) {
若注释总是以名称开头，go doc 命令的输出就能通过 grep 变得更加有用。假如你记不住 Compile 这个名称，而又在找正则表达式的解析函数（『解析』意味着关键词为 parse）， 那就可以运行
$ go doc -all regexp | grep -i parse
若包中的所有文档注释都以 This function... 开头，grep 就无法帮你记住此名称。 但由于每个包的文档注释都以其名称开头，你就能看到这样的内容，它能显示你正在寻找的词语。
$ go doc -all regexp | grep -i parse
Compile parses a regular expression and returns, if successful, a Regexp
MustCompile is like Compile but panics if the expression cannot be parsed.
parsed. It simplifies safe initialization of global variables holding
$
Go 的声明语法允许成组声明。单个文档注释应介绍一组相关的常量或变量。 由于是整体声明，这种注释往往较为笼统。
// 表达式解析失败后返回错误代码
var (
ErrInternal = errors.New("regexp: internal error")
ErrUnmatchedLpar = errors.New("regexp: unmatched '('")
ErrUnmatchedRpar = errors.New("regexp: unmatched ')'")
...
)
即便是对于私有名称，也可通过成组声明来表明各项间的关系，例如某一组由互斥体保护的变量。
var (
countLock sync.Mutex
inputCount uint32
outputCount uint32
errorCount uint32
)
命名规则
正如命名在其它语言中的地位，它在 Go 中同样重要。有时它们甚至会影响语义： 例如，某个名称在包外是否可见，就取决于其首个字符是否为大写字母。 因此有必要花点时间来讨论 Go 程序中的命名约定。
包名
当一个包被导入后，包名就会成了内容的访问器。在以下代码
import "bytes"
之后，被导入的包就能通过 bytes.Buffer 来引用了。 若所有人都以相同的名称来引用其内容将大有裨益， 这也就意味着包应当有个恰当的名称：其名称应该简洁明了而易于理解。按照惯例， 包应当以小写的单个单词来命名，且不应使用下划线或驼峰记法。err 的命名就是出于简短考虑的，因为任何使用该包的人都会键入该名称。 不必担心的冲突。包名就是导入时所需的唯一默认名称， 它并不需要在所有源码中保持唯一，即便在少数发生冲突的情况下， 也可为导入的包选择一个别名来局部使用。 无论如何，通过文件名来判定使用的包，都是不会产生混淆的。
另一个约定就是包名应为其源码目录的基本名称。在 src/encoding/base64 中的包应作为 "encoding/base64" 导入，其包名应为 base64， 而非 encoding_base64 或 encodingBase64。
包的导入者可通过包名来引用其内容，因此包中的可导出名称可以此来避免冲突。 （请勿使用 import . 记法，它可以简化必须在被测试包外运行的测试， 除此之外应尽量避免使用。）例如，bufio 包中的缓存读取器类型叫做 Reader 而非 BufReader，因为用户将它看做 bufio.Reader，这是个清楚而简洁的名称。 此外，由于被导入的项总是通过它们的包名来确定，因此 bufio.Reader 不会与 io.Reader 发生冲突。同样，用于创建 ring.Ring 的新实例的函数（这就是 Go 中的）一般会称之为 NewRing，但由于 Ring 是该包所导出的唯一类型，且该包也叫 ring，因此它可以只叫做 New，它跟在包的后面，就像 ring.New。使用包结构可以帮助你选择好的名称。
另一个简短的例子是 once.Do，once.Do(setup) 表述足够清晰， 使用 once.DoOrWaitUntilDone(setup) 完全就是画蛇添足。 长命名并不会使其更具可读性。一份有用的说明文档通常比额外的长名更有价值。
获取器
Go 并不对获取器（getter）和设置器（setter）提供自动支持。 你应当自己提供获取器和设置器，通常很值得这样做，但若要将 Get 放到获取器的名字中，既不符合习惯，也没有必要。若你有个名为 owner （小写，未导出）的字段，其获取器应当名为 Owner（大写，可导出）而非 GetOwner。大写字母即为可导出的这种规定为区分方法和字段提供了便利。 若要提供设置器方法，SetOwner 是个不错的选择。两个命名看起来都很合理：
owner := obj.Owner()
if owner != user {
obj.SetOwner(user)
}
接口命名
按照约定，只包含一个方法的接口应当以该方法的名称加上 - er 后缀来命名，如 Reader、Writer、 Formatter、CloseNotifier 等。
诸如此类的命名有很多，遵循它们及其代表的函数名会让事情变得简单。 Read、Write、Close、Flush、 String 等都具有典型的签名和意义。为避免冲突，请不要用这些名称为你的方法命名， 除非你明确知道它们的签名和意义相同。反之，若你的类型实现了的方法， 与一个众所周知的类型的方法拥有相同的含义，那就使用相同的命名。 请将字符串转换方法命名为 String 而非 ToString。
驼峰 命名
最后，Go 中的约定是使用 MixedCaps 或 mixedCaps 而不是下划线来编写多个单词组成的命名。
分号
和 C 一样，Go 的正式语法使用分号来结束语句，和 C 不同的是，这些分号并不在源码中出现。 取而代之，词法分析器会使用一条简单的规则来自动插入分号，因此源码中基本就不用分号了。
规则是这样的：若在新行前的最后一个标记为标识符（包括 int 和 float64 这类的单词）、数值或字符串常量之类的基本字面或以下标记之一
break continue fallthrough return ++ -- ) }
则词法分析将始终在该标记后面插入分号。这点可以概括为： “如果新行前的标记为语句的末尾，则插入分号”。
分号也可在闭括号之前直接省略，因此像
go func() {
for {
dst <- <-src } }()
这样的语句无需分号。通常 Go 程序只在诸如 for 循环子句这样的地方使用分号， 以此来将初始化器、条件及增量元素分开。如果你在一行中写多个语句，也需要用分号隔开。
警告：无论如何，你都不应将一个控制结构（if、for、switch 或 select）的左大括号放在下一行。如果这样做，就会在大括号前面插入一个分号，这可能引起不需要的效果。 你应该这样写
if i < f() {
g()
}
而不是这样写
if i < f() // 错误！
{
// 错误！
g()
}
控制结构
Go 中的结构控制与 C 有许多相似之处，但其不同之处才是独到之处。 Go 不再使用 do 或 while 循环，只有一个更通用的 for；switch 要更灵活一点；if 和 switch 像 for 一样可接受可选的初始化语句； 此外，还有一个包含类型选择和多路通信复用器的新控制结构：select。 其语法也有些许不同：没有圆括号，而其主体必须始终使用大括号括住。
If
在 Go 中，一个简单的 if 语句看起来像这样：
if x > 0 {
return y
}
强制的大括号促使你将简单的 if 语句分成多行。特别是在主体中包含 return 或 break 等控制语句时，这种编码风格的好处一比便知。
由于 if 和 switch 可接受初始化语句， 因此用它们来设置局部变量十分常见。
if err := file.Chmod(0664); err != nil {
log.Print(err)
return err
}
在 Go 的库中，你会发现若 if 语句不会执行到下一条语句时，亦即其执行体 以 break、continue、goto 或 return 结束时，不必要的 else 会被省略。
f, err := os.Open(name)
if err != nil {
return err
}
codeUsing(f)
下例是一种常见的情况，代码必须防范一系列的错误条件。若控制流成功继续， 则说明程序已排除错误。由于出错时将以 return 结束， 之后的代码也就无需 else 了。
f, err := os.Open(name)
if err != nil {
return err
}
d, err := f.Stat()
if err != nil {
f.Close()
return err
}
codeUsing(f, d)
声明和分配
题外话：上一节中最后一个示例展示了短声明 := 如何使用。 调用了 os.Open 的声明为
f, err := os.Open(name)
该语句声明了两个变量 f 和 err。在几行之后，又通过：
d, err := f.Stat()
调用了 f.Stat。它看起来似乎是声明了 d 和 err。 注意，尽管两个语句中都出现了 err，但这种重复仍然是合法的：err 在第一条语句中被声明，但在第二条语句中只是被罢了。也就是说，调用 f.Stat 使用的是前面已经声明的 err，它只是被重新赋值了而已。
在满足下列条件时，已被声明的变量 v 可出现在:= 声明中：
- 本次声明与已声明的
v处于同一作用域中（若v已在外层作用域中声明过，则此次声明会创建一个新的变量 §）， - 在初始化中与其类型相应的值才能赋予
v，且 - 在此次声明中至少另有一个变量是新声明的。
这个特性简直就是纯粹的实用主义体现，它使得我们可以很方便地只使用一个 err 值，例如，在一个相当长的 if-else 语句链中， 你会发现它用得很频繁。
§ 值得一提的是，即便 Go 中的函数形参和返回值在词法上处于大括号之外， 但它们的作用域和该函数体仍然相同。
For
Go 的 for 循环类似于 C，但却不尽相同。它统一了 for 和 while，不再有 do-while 了。它有三种形式，但只有一种需要分号。
// 类似 C 语言中的 for 用法
for init; condition; post {
}
// 类似 C 语言中的 while 用法
for condition {
}
// 类似 C 语言中的 for(;;) 用法
for {
}
简短声明能让我们更容易在循环中声明下标变量：
sum := 0
for i := 0; i < 10; i++ {
sum += i
}
若你想遍历数组、切片、字符串或者映射，或从信道中读取消息， range 子句能够帮你轻松实现循环。
for key, value := range oldMap {
newMap[key] = value
}
若你只需要该遍历中的第一个项（键或下标），去掉第二个就行了：
for key := range m {
if key.expired() {
delete(m, key)
}
}
若你只需要该遍历中的第二个项（值），请使用，即下划线来丢弃第一个值：
sum := 0
for _, value := range array {
sum += value
}
空白标识符还有多种用法，它会在后面的小节中描述。
对于字符串，range 能够提供更多便利。它能通过解析 UTF-8， 将每个独立的 Unicode 码点分离出来。错误的编码将占用一个字节，并以符文 U+FFFD 来代替。 （名称 “符文” 和内建类型 rune 是 Go 对单个 Unicode 码点的成称谓。 详情见语言规范）。循环
for pos, char := range "日本\x80語" {
// \x80 在 UTF-8 编码中是一个非法字符
fmt.Printf("character %#U starts at byte position %d\n", char, pos)
}
打印结果：
character U+65E5 '日' starts at byte position 0
character U+672C '本' starts at byte position 3
character U+FFFD '�' starts at byte position 6
character U+8A9E '語' starts at byte position 7
最后，Go 没有逗号操作符，而 ++ 和 -- 为语句而非表达式。 因此，若你想要在 for 中使用多个变量，应采用平行赋值的方式 （因为它会拒绝 ++ 和 --）.
// Reverse a
for i, j := 0, len(a)-1; i < j; i, j = i+1, j-1 {
a[i], a[j] = a[j], a[i]
}
Switch
Go 的 switch 比 C 的更通用。其表达式无需为常量或整数，case 语句会自上而下逐一进行求值直到匹配为止。若 switch 后面没有表达式，它将匹配 true，因此，我们可以将 if-else-if-else 链写成一个 switch，这也更符合 Go 的风格。
func unhex(c byte) byte {
switch {
case '0' <= c && c <= '9':
return c - '0'
case 'a' <= c && c <= 'f':
return c - 'a' + 10
case 'A' <= c && c <= 'F':
return c - 'A' + 10
}
return 0
}
switch 并不会自动下溯，但 case 可通过逗号分隔来列举相同的处理条件。
func shouldEscape(c byte) bool {
switch c {
case ' ', '?', '&', '=', '#', '+', '%':
return true
}
return false
}
尽管它们在 Go 中的用法和其它类 C 语言差不多，但 break 语句可以使 switch 提前终止。不仅是 switch， 有时候也必须打破层层的循环。在 Go 中，我们只需将标签放置到循环外，然后 “蹦” 到那里即可。下面的例子展示了二者的用法。
Loop:
for n := 0; n < len(src); n += size {
switch {
case src[n] < sizeOne:
if validateOnly {
break
}
size = 1
update(src[n])
case src[n] < sizeTwo:
if n+1 >= len(src) {
err = errShortInput
break Loop
}
if validateOnly {
break
}
size = 2
update(src[n] + src[n+1]<<shift)
}
}
当然，continue 语句也能接受一个可选的标签，不过它只能在循环中使用。
作为这一节的结束，此程序通过使用两个 switch 语句对字节数组进行比较：
// 比较两个字节型切片，返回一个整数
// 按字典顺序.
// 如果a == b，结果为0；如果a < b，结果为-1；如果a > b，结果为+1
func Compare(a, b []byte) int {
for i := 0; i < len(a) && i < len(b); i++ {
switch {
case a[i] > b[i]:
return 1
case a[i] < b[i]:
return -1
}
}
switch {
case len(a) > len(b):
return 1
case len(a) < len(b):
return -1
}
return 0
}
类型选择
switch 也可用于判断接口变量的动态类型。如 通过圆括号中的关键字 type 使用类型断言语法。若 switch 在表达式中声明了一个变量，那么该变量的每个子句中都将有该变量对应的类型。在每一个 case 子句中，重复利用该变量名字也是惯常的做法，实际上这是在每一个 case 子句中，分别声明一个拥有相同名字，但类型不同的新变量。
var t interface{
}
t = functionOfSomeType()
switch t := t.(type) {
default:
fmt.Printf("unexpected type %T\n", t) // %T 打印任何类型的 t
case bool:
fmt.Printf("boolean %t\n", t) // t 是 bool 类型
case int:
fmt.Printf("integer %d\n", t) // t 是 int 类型
case *bool:
fmt.Printf("pointer to boolean %t\n", *t) // t 是 *bool 类型
case *int:
fmt.Printf("pointer to integer %d\n", *t) // t 是 *int 类型
}
函数
多返回值
Go 与众不同的特性之一就是函数和方法可返回多个值。这种形式可以改善 C 中一些笨拙的习惯： 将错误值返回（例如用 -1 表示 EOF）和修改通过地址传入的实参。
在 C 中，写入操作发生的错误会用一个负数标记，而错误码会隐藏在某个不确定的位置。 而在 Go 中，Write 会返回写入的字节数一个错误： “是的，您写入了一些字节，但并未全部写入，因为设备已满”。 在 os 包中，File.Write 的签名为：
func (file *File) Write(b []byte) (n int, err error)
正如文档所述，它返回写入的字节数，并在 n != len(b) 时返回一个非 nil 的 error 错误值。 这是一种常见的编码风格，更多示例见错误处理一节。
我们可以采用一种简单的方法。来避免为模拟引用参数而传入指针。 以下简单的函数可从字节数组中的特定位置获取其值，并返回该数值和下一个位置。
func nextInt(b []byte, i int) (int, int) {
for ; i < len(b) && !isDigit(b[i]); i++ {
}
x := 0
for ; i < len(b) && isDigit(b[i]); i++ {
x = x*10 + int(b[i]) - '0'
}
return x, i
}
你可以像下面这样，通过它扫描输入的切片 b 来获取数字。
for i := 0; i < len(b); {
x, i = nextInt(b, i)
fmt.Println(x)
}
命名结果参数
Go 函数的返回值或结果 “形参” 可被命名，并作为常规变量使用，就像传入的形参一样。 命名后，一旦该函数开始执行，它们就会被初始化为与其类型相应的零值； 若该函数执行了一条不带实参的 return 语句，则结果形参的当前值将被返回。
此名称不是强制性的，但它们能使代码更加简短清晰：它们就是文档。若我们命名了 nextInt 的结果，那么它返回的 int 就值如其意了。
func nextInt(b []byte, pos int) (value, nextPos int) {
由于被命名的结果已经初始化，且已经关联至无参数的返回，它们就能让代码简单而清晰。 下面的 io.ReadFull 就是个很好的例子：
func ReadFull(r Reader, buf []byte) (n int, err error) {
for len(buf) > 0 && err == nil {
var nr int
nr, err = r.Read(buf)
n += nr
buf = buf[nr:]
}
return
}
延迟 defer
Go 的 defer 语句用于预设一个函数调用（即函数）， 该函数会在执行 defer 的函数返回之前立即执行。它显得非比寻常， 但却是处理一些事情的有效方式，例如无论以何种路径返回，都必须释放资源的函数。 典型的例子就是解锁互斥和关闭文件。
// 内容返回文件的内容作为字符串。
func Contents(filename string) (string, error) {
f, err := os.Open(filename)
if err != nil {
return "", err
}
defer f.Close() // 我们结束后就关闭了f
var result []byte
buf := make([]byte, 100)
for {
n, err := f.Read(buf[0:])
result = append(result, buf[0:n]...) // append稍后讨论。
if err != nil {
if err == io.EOF {
break
}
return "", err // 如果我们回到这里，f就关闭了。
}
}
return string(result), nil // 如果我们回到这里，f就关闭了。
}
推迟诸如 Close 之类的函数调用有两点好处：第一， 它能确保你不会忘记关闭文件。如果你以后又为该函数添加了新的返回路径时， 这种情况往往就会发生。第二，它意味着 “关闭” 离 “打开” 很近， 这总比将它放在函数结尾处要清晰明了。
被推迟函数的实参（如果该函数为方法则还包括接收者）在执行时就会求值， 而不是在执行时才求值。这样不仅无需担心变量值在函数执行时被改变， 同时还意味着单个已推迟的调用可推迟多个函数的执行。下面是个简单的例子。
for i := 0; i