这是我参与「第三届青训营 -后端场」笔记创作活动的的第1篇笔记
课程目录
01.高质量编程
高质量编程介绍:
编码规范:
- 代码格式:
- 可以使用gofmt自动格式化代码
- 注释:
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
- 命名规范
- 变量简洁胜于冗长
- 变量缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写
- 变量距离其被使用的地方越远,则需要携带越多的上下文信息
- 函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的
- 函数名尽量简短当名为foo的包某个函数返回类型Foo时,可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息
当为包命名时
- 控制流程 编写代码时应做到尽量保持正常代码路径为最小缩进
优先处理错误情况/特殊情况,尽早返回或继续循环来减少嵌套
例如:
- 最常见的正常流程的路径被嵌套在两个if 条件内
- 成功的退出条件是return nil,必须仔细匹配大括号来发现
- 函数最后一行返回一个错误,需要追溯到匹配的左括号,才能了解何时会触发错误
- 如果后续正常流程需要增加一步操作,调用新的函数,则又会增加一层嵌套 总之:线性原理,处理逻辑尽量走直线,避免复杂的嵌套分支正常流程代码沿着屏幕向下移动 提升代码可维护性和可读性 故障问题大多出现在复杂的条件语句和循环语句中
- 异常处理
- 简单错误 简单的错误指的是仅出现一次的错误,且在其他地方不需要捕获该错误
优先使用errors.New来创建匿名变量来直接表示简单错误
如果有格式化的需求,使用fmt.Errorf
- 错误的Wrap和 Unwrap 错误的Wrap实际上是提供了一个error嵌套另一个error的能力,从而生成一个error的跟踪链
在fmt.Errorf中使用: %w关键字来将一个错误关联至错误链中
- 错误判定 在错误链上获取特定种类的错误,使用errors.As
还可以panic,recover语句来处理错误
总之: error尽可能提供简明的上下文信息链,方便定位问题 panic 用于真正异常的情况。 recover生效范围,在当前goroutine的被defer的函数生效
性能优化建议:
- 使用Go语言提供的支持基准性能测试的Benchmark工具
- 使用slice和map时预分配内存
- 使用string.Builder拼接字符串
- 可以使用空结构体节省内存
- 使用atomic包来保护逻辑,承载数据 总之:避免常见的性能陷阱可以保证大部分程序的性能。普通应用代码,不要一味地追求程序的性能。越高级的性能优化手段越容易出现问题。 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能。
02.性能调优实战
性能调优介绍:
性能调优实战:
使用pprof进行性能分析可以看下面这篇博客 [golang pprof 实战 | Wolfogre's Blog]