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

Rewind_fly
33 阅读7分钟

高质量编程

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

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

编程原则：

  • 简单性

    消除“多余的复杂性”，以简单清晰的逻辑

    不理解的代码无法修改改进

  • 可读性

    代码是写给人看的，而不是机器

    编写可维护代码的第一步是确保代码可读

  • 生产力

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

编码规范

注释

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

注释应该解释代码作用

  • 适合注释公共符号

byteDance11-1.png

如何做的

  • 适合注释实现过程

byteDance11-2.png

代码实现的原因

  • 适合解释代码的外部因素
  • 提供额外上下文

byteDance11-3.png

解释代码什么情况下会出错

  • 适合解释代码的限制条件

byteDance11-5.png

小结：

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

代码格式

gofmt

Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格 常见IDE都支持方便的配置

goimports 实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类

命名规范

variable

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 例如使用ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者xmlHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义。

function

byteDance11-6.png

package

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

以下规则尽量满足，以标准库包名为例：

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

小结：

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

控制流程

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

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

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

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

byteDance11-7.png

byteDance11-8.png

小结：

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

错误和异常处理

》简单错误

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

》错误的Wrap和Unwrap

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

byteDance11-9.png

》错误判定

  • 判定一个错误是否为特定错误，使用errors.Is
  • 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

byteDance11-10.png

  • 在错误链上获取特定种类的错误，使用errors.As

byteDance11-11.png

》panic

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

byteDance11-12.png

》recover

  • recover只能在被defer的函数中使用
  • 嵌套无法生效
  • 只在当前goroutine生效
  • defer的语句是后进先出

byteDance11-13.png

  • 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈

byteDance11-14.png

小结：

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

性能调优实战

Benchmark

》如何使用

  • 性能表现需要实际数据衡量
  • Go语言提供了支持基准性能测试的benchmark工具
go test -bench=. -benchmem

// fib.go
func Fib() int{
    if n < 2 {
        return n
    }
    return Fib(n-1) + Fib(n-2)
}
// from fib_test.go
func BenchmarkFib10(b *testing.B) {
    // run the Fib function b.N times
    for n :=0; n < b.N; n++ {
        Fib(10)
    }
}

》结果说明

byteDance11-15.png

Slice

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

byteDance11-16.png

》slice预分配内存

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

byteDance11-17.png

》另一个陷阱：大内存未释放

  • 在已有切片基础上创建切片，不会创建新的底层数组
  • 场景
    • 原切片较大，代码在原切片基础上新建小切片
    • 原底层数组在内存中有引用，得不到释放
  • 可使用copy替代re-slice

byteDance11-18.png

map

byteDance11-19.png

map预分配内存：

分析：

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

字符串处理

  • 常见的字符串凭借方式：

byteDance11-20.png

byteDance11-21.png

使用+拼接性能最差，strings.Builder，bytes.Buffer相近，string.Buffer更快

分析：

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

byteDance11-22.png

byteDance11-23.png

空结构体

  • 使用空结构体struct{}实例不占据任何的内存空间
  • 可作为各种场景下的占位符使用
    • 节省资源
    • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
func EmptyStructMap(n int) {
	m := make(map[int]struct{})
	for i := 0; i < n; i++ {
		m[i] = struct{}{}
	}
}

func BoolMap(n int) {
	m := make(map[int]bool)
	for i := 0; i < n; i++ {
		m[i] = false
	}
}

》使用空结构体节省内存

  • 实现Set，可以考虑用map来代替
  • 对于这个场景，只需要用到map的键，而不需要值
  • 即使是将map的值设置为bool类型，也会多占据1个字节空间

atomic包

byteDance11-24.png

使用atomic包

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

小结：

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