第六届字节跳动青训营后端第三课 高质量编程与性能调优｜ 豆包MarsCode AI 刷题

用户73702348410
59 阅读7分钟

高质量代码

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

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

简介

编程原则

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

  1. 简单性

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

  2. 可读性

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

  3. 生产力

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

如何编写高质量的Go代码

代码格式

推荐使用gofmt、goimports等工具自动格式化代码、自动增删依赖包

注释

代码是最好的注释，注释应该提供代码未表达出的上下文信息

  1. 注释应该解释代码的作用，适合注释公共符号

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

  2. 注释应该解释代码是如何做的，适合注释实现过程

  3. 注释应该解释代码实现的原因，适合解释代码的外部因素，并提供额外上下文

  4. 注释应该解释代码什么情况会出错，适合解释代码的限制条件

命名规范

降低阅读和理解代码的成本。重点考虑上下文信息，设计简洁清晰的名称

变量（variable） ：

  1. 简洁胜于冗长

  2. 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

    • 例如使用 ServeHTTP 而不是 ServeHttp
    • 使用 XMLHTTPRequest 或者 xmlHTTPRequest

  3. 变量距离其被使用地方越远，则需要携带越多上下文信息

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方考研轻易辨认出其含义

函数（function） ：

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

包（package） ：

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

非强制的：

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

控制流程

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

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

    • 如果两个分支中都包含 return 语句，则可以去除冗余的 else

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

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

错误和异常处理

error 尽可能提供简明的上下文信息链，方便定位问题；panic 用于真正异常无法运行的情况；recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

  1. 简单错误

    • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
    • 优先使用 errors.New 来创建匿名变量直接表示简单错误
    • 如果有格式化的需求，使用 fmt.Error

  2. 错误的 Wrap 和 Unwrap

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

  3. 错误判定

    • 判定一个错误是否为特定错误，使用 error.Is
    • 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
    • 在错误链上获取特定种类的错误，使用 error.As

  4. panic

    • 不建议在业务代码中使用 panic
    • 调用函数不包含 recover 会造成程序崩溃
    • 若问题可以被屏蔽或解决，建议使用 error 代替 panic
    • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic

  5. recover

    • recover 只能在被 defer 的函数中使用
    • 嵌套无法生效
    • 只在当前 goroutine 生效
    • defer 的语句是后进先出（栈）
    • 如果需要更多的上下文信息，可以 recover 后在log 中记录当前的调用栈

性能优化

简介

  • 性能优化的前提是满足正确可靠、简洁清晰等质量因素
  • 性能优化是综合评估，有时候时间效率和空间效率可能对立
  • 针对 Go 语言特性，介绍 Go相关的性能优化建议

性能优化建议

避免常见的性能陷阱可以保证大部分程序的性能；普通应用代码，不要一味地追求程序地性能；越高级的性能优化手段越容易出现问题；在满足正确可靠、简洁清晰的质量要求前提下提高程序性能

Benchmark

  • 性能需要实际数据衡量
  • Go语言提供了支持基准性能测试的 benchmark 工具

image.png

Slice

切片本质是一个数组片段的描述，包括数组指针，片段的长度，片段的容量（不改变内存分配情况下的最大长度）；切片操作并不复制切片指向的元素；创建一个新的切片会复用原来切片的底层数组

  1. 预分配内存

    • 尽可能在使用 make() 初始化切片时提供容量信息

  2. 陷阱：大内存未释放

    • 在已有切片基础上创建切片，不会创建新的底层数组

    • 场景：

      • 原切片较大，代码在原切片的基础上新建小切片
      • 原底层数组在内存中有引用，得不到释放

    • 可使用 copy 替代 re-slice

Map

不断向 map 中添加元素的操作会触发 map 的扩容；提前分配好空间可以减少内存拷贝和 Rehash 的消耗；建议根据实际需求提前预估好需要的空间

  1. 预分配内存

    • 尽可能在使用 make() 初始化切片时提供容量信息

字符串处理

字符串在 Go 语言中是不可变类型，占用内存大小是固定的；使用 + 每次都会重新分配内存；strings.Builder，bytes.Buffer 底层都是 []byte 数组；内存扩容策略，不需要每次拼接重新分配内存

  1. 使用 strings.Builder，避免使用 + 符号拼接新字符串

    • bytes。Buffer 转化为字符串时重新申请了一块空间
    • strings.Builder 直接将底层的 []byte 转换成了字符串类型返回
    • 使用 Grow() 方法能预分配内存

空结构体

  1. 空结构体 struct{} 实例不占据任何内存空间

  2. 可作为各种场景下的占位符使用

    • 节省资源
    • 空结构体本身具有很强的语义，即这里不需要任何值，仅作为占位符
    • 可以用于将 map 类型转换为 set

atomic 包

锁的实现是通过操作系统来实现，属于系统调用；atomic 操作是通过硬件实现，效率比较高；sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量；对于非数值操作，可以使用 atomic.Value，能承载一个 interface{}

  1. 维护原子变量，而不使用互斥锁

性能优化原则

  1. 要依靠数据不是猜测
  2. 要定位最大瓶颈而不是细枝末节
  3. 不要过早优化
  4. 不要过度优化

性能分析工具 pprof

希望知道应用在什么地方耗费了多少CPU、Memory；pprof是用于可视化和分析性能分析数据的工具

avatar
文章
阅读
粉丝