这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天

─═♤═─‧─═♥═─‧─═♤═─‧─═♥═─‧─═♤═──═♤═─‧─═♥═─‧─═♤═─‧─═♥═─‧─═♤═‧─═♥═─‧─═♤═

一、本节课重点知识

• 高质量编程简介及编码规范
• 性能优化建议

二、详细知识介绍

1、高质量编程简介及编码规范

高质量

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

编程原则：简单性 可读性 生产性

编码规范

1、代码格式

gofmt

2、注释

公共符号始终要注释

包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释

任何既不明显也不简短的公共功能必须予以注释

无论长度或复杂程度如何，对库中的任何函数都必须进行注释

3、命名规范

变量命名

• 简洁胜于冗长

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

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

函数命名

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

包的命名规范

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如schema、task等
• 不要与标准库同名。例如不要使用sync或者strings
• 以下规则尽量满足，以标准库包名为例
• 不使用常用变量作为包名。例如使用bufio而不是buf
• 使用单数而不是复数。例如使用encoding而不是encodings
• 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

4、控制流程

• 避免嵌套，保持正常流程清晰
• 如果两个分支都包含return语句，则可以去除冗余的else
• 尽量保持正常代码路径为最小缩进
• 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

5、错误和异常处理

简单错误

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

return errors.New("stopped after 10 redirects")

错误的Wrap和Unwrap

错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链

在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中错误判定

判定一个错误是否为特定错误，使用errors.Is

不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

异常处理

• error尽可能提供简明的上下文信息链，方便定位问题
• panic用于真正异常的情况
• recover
  • recover只能在被defer的函数中使用
  • 嵌套无法生效
  • 只在当前goroutine生效
  • defer的语句是后进先出

2、性能优化建议

代码运行结果说明

(1)Slice

Slice预分配内存

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

type slice struct{

array unsafe.Pointer //数组指针

len int //片段长度

cap int //片段容量

}

(2)Map

map预分配内存

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

(3)字符串处理 使用string.Builder

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

(4)使用空结构体节省内存

• 空结构体struct{}实例不占据任何的内存空间
• 可作为各种场景下的占位符使用
• 节省资源
• 空结构体本身具备很强的语义，即这里不需要任何值，仅仅作为占位符

(5)使用atomic包

锁的实现是通过操作系统来实现，属于系统调用

三、总结

核心目标是降低阅读理解代码的成本

重点考虑上下文信息，设计简洁清晰的名称

线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支

正常流程代码沿着屏幕向下移动

提升代码可维护性和可读性

故障问题大多出现在复杂的条件语句和循环语句中