这是我参与「第五届青训营」伴学笔记创作活动的第3天

主要记录课程的重点和课上所讲项目的每一步以及我的思考

1.高质量编程

1.1简介

高质量指的是编写的代码能够达到正确可靠、简洁清晰的目标。

编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是想通的。要满足以下三点：

简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进

可读性

代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读

生产力

团队整体工作效率非常重要

1.2编码规范

编写高质量的Go代码涉及代码格式，注释，命名规范，控制流程，错误和异常处理。

1.2.1编码规范-代码格式

gofmt是Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格。goimports也是Go语言官网提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用，将依赖包按字母序排序并分类。在Goland中，应该都是默认启用的。

1.2.2编码规范-注释

注释应该做到以下四点

（1）解释代码作用

适合注释公共符号

//Open open the named file for reading.IF successful,methods on
//the returned file can be used for reading; the associated file
//descriptor has mode O_RDONLY.
//If there is an error, it will be of type *PathError
func Open(name string) (*File,error) {
     return OpenFile(name, O_RDONLY,0)
}

(2)解释代码如何做的

适合注释实现过程

//Add the Referer header from the most recent
//request URL to the new one, if it's not https->http:
if ref := refererForURL(reqs[len(reqs)-1].URL,req.URL);ref !=""{
    ref.Header.Set("Referer",ref)
}

(3)解释代码实现的原因

适合解释代码的外部因素
提供额外上下文

switch resp.StatusCode {
//...
case 307,308:
     redirectMethod = reqMethod
     shouldRedirect = true
     includeBody = true
     
     if ireq.GetBody == nil && ireq.outgoingLength() != 0 {
        //We had a request body,and 307/308 require
        //re-sending it,but GetBody is not defined. So just
        //return this response to the user instead of an
        //error,like we did in Go 1.7 and earlier.
        shouldRedirect = false
      }
 }

(4)解释代码什么情况会出错

适合解释代码的限制条件

1.2.3编码规范-命名规范

变量

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

函数

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

包

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

1.2.4编码规范-控制流程

避免嵌套，保持正常流程清晰

//Bad
if foo{
    return x
} else {
    return nil
}

//Good
if foo {
    return x
}
return nil

尽量保持正常代码路径为最小缩进

1.2.5编码规范-错误和异常处理

简单错误

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

错误判定

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

1.3性能优化建议

性能优化的前提是满足正确可靠、简介清晰等质量因素
性能优化是综合评估，有时候时间效率和空间效率可能对立

2.总结

在掌握了基本的编程能力以后，就要想办法去提升高质量编程以及如何性能调优。

3.引用

该文章部分内容来自于以下课程或网页：

字节内部课：Go语言入门-高质量编程与性能调优实战

Go语言入门-高质量编程与性能调优实战 | 青训营笔记