这是我参与「第三届青训营-后端场」笔记创作活动的的第6篇笔记.

1、高质量编程简介

高质量代码：正确可靠，简介清晰.

条件

各种边界条件是否考虑完备？

异常情况处理，稳定性保证

易读性维护

2、编程原则简介

• 简单性

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

• 可读性

  • 代码可读，见名知意

• 生产力

  • 能提升团队整体工作效率

3、代码编写规范

• 代码风格

  • 推荐使用gofmt,这是官方提供的。
  • 也可以使用goimport（也是官方提供）=gofmt+依赖包管理

• 注释

  • 解释作用
  • 表明实现原因
  • 错误异常处理标识

• 命名规范

  • 核心目标：降低阅读成本，重点考虑上下文，设计简洁清晰的名称。

  • Go语言中的函数名、变量名、常量名、类型名、语句标号和包名等所有的命名，都遵循一个简单的命名规则：一个名字必须以一个字母（Unicode字母）或下划线开头，后面可以跟任意数量的字母、数字或下划线。大写字母和小写字母是不同的：heapSort和Heapsort是两个不同的名字。

  • Go语言中类似if和switch的关键字有25个(均为小写)。关键字不能用于自定义名字，只能在特定语法结构中使用。

    • break       default        func         interface        select
      case        defer           go            map               struct
      chan        else            goto           package          switch
      const        fallthrough     if             range            type
      continue     for              import        return            var
      

  • 此外，还有大约30多个预定义的名字，比如int和true等，主要对应内建的常量、类型和函数。

    • 内建常量: 
          true false iota nil
      内建类型: 
              int int8 int16 int32 int64
              uint uint8 uint16 uint32 uint64 uintptr
              float32 float64 complex128 complex64
              bool byte rune string error
      内建函数: 
              make len cap new append copy close delete
              complex real imag
              panic recover
      

• 控制流程

  • 避免嵌套，保持正常流程清晰

  • 尽量保持正常代码路径为最小缩进

    • 优先处理错误/特殊情况,尽早返回或继续循环来减少嵌套

  • 提升代码可维护性、可读性

• 错误和异常处理

  • 简单错误

    • 只出现一次的错误
    • 优先使用error.New创建匿名变量来表示错误
    • 如果有格式化要求，使用fmt.Error

  • 错误的Wrap和Unwrap

    • Wrap：error嵌套的错误跟踪链
    • fmt.Errorf中使用：%w关键字来表示一个错误关联至错误跟踪链中

  • 错误判定

    • 特定错误：error.Is

  • panic

    • 不可逆转错误时在init或main函数中使用panic

  • recover

    • 只在defer函数中使用
    • defer是后进先出