高质量编程| 青训营笔记

109 阅读3分钟

编码原则:

简单性、可读性、生产力

注释

解释代码作用、解释代码如何做、解释代码实现的元婴、解释代码什么情况会出错

命名规范

简介胜于冗长

缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写:例如使用ServeHTTP而不是ServeHttp、使用XMLHTTPRequest或者xmlHTTPRequest

变量距离其被使用的方法越远,则需要携带更多的上下文信息、使得在不同地方可以辨认出其含义

for循环

i和index的作用域仅限于for循环内部时,index的额外冗长几乎没有增加对于程序的理解 ** function**:

函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的

函数名尽量简短

当名为foo的包某个函数返回类型Foo时,可以省略类型信息而不导致歧义

当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息

Package

只由小写字母组成,不包含大写字母和下划线等字符

简短并包含一定的上下文信息。例如schema、task等

不要与标准库同名。例如不要使用sync或者strings

以下规则尽量满足,以标准包名为例

不使用常量名作为包名。例如使用bufio而不是buf

使用单数而不是复数。例如使用encoding而不是encodings

谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

性能优化建议:

Slice

slice预分配内存:尽可能在使用make()初始化切片时提供容量信息

切片本质是一个数组片段的描述:包括数组指针、片段的长度、片段的容量(不改变内存分配情况下的最大长度)

切片操作并不复制切片指向的元素

创造一个新的切片会复用原来切片的底层数组

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

场景:原切片较大、代码在原切片基础上新建小切片、原底层数组在内存中有引用,得不到释放,可用copy替代re-slice

字符串处理

使用strings.Builder

bytes.Buffer转化为字符串时重新申请了一块空间

strings.builder直接将底层的[]byte转换成了字符串类型的返回

结构体

使用空结构体节省内存

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

可作为各种场景下的占位符使用:节省资源,空结构体本身具备很强的语义,可以不需要任何值、仅作为占位符

使用atomic包:

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

atomic操作是通过硬件实现,效率比锁高

sync.Mutex应该用来保护一段逻辑,不仅仅用于保护一个变量

对于非数值操作,可以使用atomic.Value,能承载一个interface{}