这是我参与「第三届青训营 -后端场」笔记创作活动的的第二篇笔记
GO语言高质量编程与性能调优实战
编程原则:各种语言的语法和特性各不相同,但是高质量编程遵循的原则是相通的。
简单性
-
消除多余的复杂性,以简单清晰的逻辑编写代码
-
不理解的代码无法修复改进
可读性
-
代码是写给人看的,而不是机器
-
编写可维护代码的第一步是确保代码可读
生产力
-
团队整体工作效率非常重要
如何编写高质量的GO语言代码?
-
代码格式
-
注释
-
命名规范
-
控制流程
-
错误和异常处理
代码格式化:
推荐使用官方提供工具,gofmt,优点是能够自动格式化GO语言代码为官方统一风格。goimports也是GO语言官方提供的一个工具,能够自动增删依赖的包引用、将依赖包按照字母序排序并分类。
注释:注释应该做到什么?
-
注释应该解释代码作用
-
注释应该解释代码如何做的
-
注释应该解释代码实现的原因
-
注释应该解释一下代码什么情况会出错
小结:代码是最好的注释,注释应该提供代码未表达出的上下文信息。
命名规范:
-
简洁胜于冗长
-
缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写。
-
变量距离其被使用的地方越远,则需要携带越多的上下文信息
-
全局变量在其名字中需要更多的上下文信息,使得在不同地方可以轻易辨认出其含义。
-
函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的。
-
函数名尽量简短。
控制流程:
-
尽量保持正常代码路径为最小缩进
-
优先处理错误情况,尽早返回或继续循环来减少嵌套
-
线性原理,处理逻辑尽量走直线,避免复杂的嵌套分支
-
正常流程代码沿着屏幕向下移动
-
提升代码可维护性和可读性
-
故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理:
-
简单错误优先使用errors.New来创建匿名变量来直接表示代码错误
-
复杂的错误设置一个跟踪链,方便排查错误问题
-
不建议在业务中使用panic,当程序启动阶段发生无法逆转的错误时就需要在main函数中使用panic
小结:error尽可能提供简明的上下文信息链,方便定位问题。panic用于真正异常的情况。recover生效范围,在当前goroutine的被defer的函数中生效。
总结:虽然现在水平有限,很多东西只能听确不能深入了解,但还是学到了很多新的知识点,加油加油!