高质量编码简介及编码规范| 青训营笔记

111 阅读2分钟

课程介绍

  • 高质量编程
    • 高质量编程简介
    • 编码规范
    • 性能优化建议
  • 性能调优实战
    • 性能调优简介
    • 性能分析工具pprof实战
    • 性能调优案例

高质量编程

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

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

编程原则

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

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

可读性

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

生产力

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

编码规范

如何编写高质量的Go代码

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

编码规范 - 代码格式

image.png

编码规范 - 注解

image.png

编码规范 - 命名规范

image.png

image.png

image.png

小结

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

编码规范 - 控制流程

image.png

image.png

image.png

小结

  • 线性原理,处理逻辑尽量走直线,避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中

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

简单错误

  • 简单的错误指的是Wrap和Unwrap
  • 错误的Wrap实际上是提供了一个error嵌套另一个error的能力,从而生成一个error的跟踪链
  • 在fmt.Error中是使用:%w关键字来将一个错误关联至错误链中