高质量编程与性能调优（一）|zo的笔记|青训营笔记

麟一01
133 阅读7分钟

这是我参与「第五届青训营 」笔记创作活动的第2天。注：笔记大部分图片内容及代码段为青训营课程视频提供，仅交流，不得做个人使用

一、本节主要内容

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

二、本节详细知识点

1、高质量编程

高质量编程简介
编码规范
性能优化建议

2、性能调优实战

性能调优简介
性能分析工具pprof实战
性能调优案例

高质量编程

什么是高质量？

编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。——张雷讲师

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

编程原则

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

简单性：
消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进
可读性：
代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读
生产力：
团队整体工作效率非常重要

——Go语言开发者 Dave Cheney

编码规范

如何编写高质量Go代码

代码格式
注释
命名规范
控制流程
错误和异常处理
编码规范-代码格式

推荐使用gofmt自动格式化工具

gofmt
Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
常见IDE都支持方便的配置

-

goimports
也是 Go语言官方提供的工具
实际等于gofmt加上依赖包管理
自动增删依赖的包引用、将依赖包按字母序排序并分类

-Goland内置 image.png

编码规范-注释
  • 注释应该做的
注释应该解释代码作用
注释应该解释代码如何做的
注释应该解释代码实现的原因
注释应该解释代码什么情况会出错

image.png

若函数名可以直观体现函数功能，如下可省略注释 image.png

简单的逻辑勿须注释 image.png

  • 注释应该解释代码实现的原因 适合解释代码实现之外的外部因素 | 可提供额外上下文 image.png

  • 注释应该解释代码什么情况会出错 适合解释代码的限制条件 image.png github.com/golang/go/b…

  • 公共符号始终要注释 Go仓库中的某一代码块 image.png 对于公共符号都有注释说明尽管LimitedReader.Readz 本身没有注释，但它紧跟LimitedReader 结构的声明，明确了它的作用。

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

例：公共函数说明 image.png github.com/golang/go/b…

有一个例外，不需要注释实现接口的方法。如 image.png 注释最重要的是提供额外的上下文信息。没有帮助的不需保留。

  • 小结 代码是最好的注释 | 注释应该提供代码未表达出的上下文信息
编码规范-命名规范
  • variable 变量的命名
——简洁胜于冗长
——缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
例如使用ServeHTTP而不是Senvehttp 使用XMLHTTPRequest或者xmIHTTPRequest 
——变量距离其被使用的地方越远，则需要携带越多的上下文信息
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辩认出其含义

image.png i和index的作用域范围仅限于for循环内部时index的额外长几乎没有增加对于程序的理解

image.png 将deadline 替换成t降低了变量名的信息量。t常代指任意时间，deadline指截止时间有特定的含义

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

image.png 函数存在于HTTP包时，不需要再带有HTTP命名部分

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

以下规则尽量满足，以标准库包名为例

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

核心目标是降低阅读理解代码的成本； 重点考虑上下文信息，设计简洁清晰的名称

image.png

#####编码规范-控制流程

  • 避免嵌套，保持正常流程清晰 如果两个分支中都包含retumn语句，则可以去除冗余的else image.png

  • 尽量保持正常代码路径为最小缩进 优先处理错误情况//特殊情况，尽早返回或继续循环来减少嵌套

image.png

image.png 最常见的正常流程的路径被嵌套在两个if条件内。成功的退出条件是return nil，必须仔细匹配大括号来发现。函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误。如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

image.png

  • 小结
线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中
编码规范-错误和异常处理
  • 简单错误
简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
优先使用 errors.New来创建名变量来直接表示简单错误
如果有格式化的需求，使用fmt.Errorf

image.png

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

image.png

image.png github.com/golang/go/b…

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

image.png github.com/golang/go/b…

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

image.png github.com/golang/go/b…

  • panic
不建议在业务代码中使用panic 
调用函数不包含 recover 会造成程序崩溃
若问题可以被屏蔽或解决，建议使用error代替panic

当程序启动阶段发生不可逆转的错误时可以在init或main函数中使用panic image.png 上图主要功能是基础启动。若失败后续将无意义，所以尽早暴露有意义。

  • recover
recover 只能在被defer的函数中使用
嵌套无法生效
只在当前goroutine 生效
defer的语句是后进先出(当我们写多个defer时，要注意defer的执行顺序）

image.png

如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈 image.png htps://github.com/golang/website/blob/master/intemal/gitfs/fs.go#228

  • 小结 error尽可能提供简明的上下文信息链，方便定位问题

panic用于真正异常的情况

recover 生效范围，在当前goroutine的被defer的函数中生效

编码规范回顾联系

哪种命名更好？

image.png time.NowTime()冗余

image.png time.ParseDuration()信息更完整

程序的输出是什么？

image.png

提示：
defer语句会在函数返回前调用
多个defer语句是后进先出

31

avatar
文章
阅读
粉丝