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

入门 Go 语言-高质量编程与性能调优(一)

如何编写更简洁清晰的代码
常用Go语言程序优化手段
熟悉Go程序性能分析工具
了解工程中性能优化的原则和流程

高质量编程

高质量编程简介

什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

各种边界条件是否考虑完备
异常情况处理，稳定性保证
易读易维护

编程原则实际应用场景千变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的简单性

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

可读性

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

生产力

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

编码规范

如何编写高质量的Go代码

代码格式
注释
- 注释应该做的
  - 注释应该解释代码作用
    - 适合注释公共符号
  - 注释应该解释代码如何做的
    - 适合注释实现过程
  - 注释应该解释代码实现的原因
    - 适合解释代码的外部因素
    - 提供额外上下文
  - 注释应该解释代码什么情况会出错
    - 适合解释代码的限制条件
命名规范控制流程

variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  - 例如使用ServeHTTP而不是ServeHttp
  - 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  - 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T 并不是Foo)，可以在函数名中加入类型信息
package
- 只由小写字母组成。不包含大写字母和下划线等字符。
- 短并包含一定的上下文信息。例如schema、task 等
- 不要与标准库同名。例如不要使用sync或者strings
- 以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用encoding 而不是 encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format 更加简短
小结
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
错误和异常处理

公共符号始终要注释

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

推荐使用gofmt自动格式化代码 gofmt

Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格常见IDE都支持方便的配置 goimports
也是Go语言官方提供的工具实际等于gofmt 加上依赖包管理自动增删依赖的包引用、将依赖包按字母序排序并分类

编码规范-控制流程

避免嵌套，保持正常流程清晰
尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中

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

简单错误

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

func defaultCheckRedirect(req *http.Request, via []*http.Request) error {
   if len(via) > 10 {
      return errors.New("stopped after 10 redirects")
   }
   return nil
}

错误判定

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

data,err=lockedfile.Read(targ)
if errors.Is(err,fs.ErrNotExist){
   return []byte{},nil
}
return data,err

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

if _, err := os.Open( "non-existing" ) ; err != nil {
   var pathError *fs.PathError
   if errors.As(err, &pathError){
      fmt.Println( "Failed at path: " ,pathError.Path)
   }else {
      fmt.Println(err)
   }
}

panic

不建议在业务代码中使用panic
调用函数不包含recover 会造成程序崩溃
若问题可以被屏蔽或解决，建议使用error代替 panic
当程序启动阶段发生不可逆转的错误时,可以在 init或 main函数中使用panic

func main( ) {
   ctx,cancel := context.WithCancel( context.Background( ) )
   client,err := sarama.NewConsumerGroup( strings.Split(brokers,", " ),group,config)
   if err != nil {
   log.Panicf( "Error creating consumer group client: %v" , err)
   }
}
func Panicf( format string,v ...interface{}) {
   s := fmt.Sprintf( format,v...)
   std.Output(2,s)
   panic( s )
}

recover

recover 只能在被defer的函数中使用
嵌套无法生效
只在当前goroutine生效
defer的语句是后进先出

func (s *ss)  Token(skipSpace bool,f func(rune2 rune) bool) (tok []byte,err error){
   defer func() {
      if e:=recover();e!=nil{
         err=se.err
      }else {
         panic(e)
      }
   }()
   //...
}

recover

如果需要更多的上下文信息，可以recover后在 log 中记录当前的调用栈

func (t *treeFS) Open( name string) ( f fs.File,err error ){
   defer func() {
      if e := recover( ); e != nil {
         f = nil
         err = fmt.Errorf( "gitfs panic: %v\n%s",e,debug.Stack( ))
      }
   }()
//...
}

小结

error尽可能提供简明的上下文信息链，方便定位问题
panic用于真正异常的情况
recover生效范围，在当前goroutine的被defer的函数中生效

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

入门 Go 语言-高质量编程与性能调优(一)

高质量编程

高质量编程简介

编码规范

编码规范-控制流程

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