编程原则

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

简单性

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

可读性

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

生产力

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

编码规范

代码格式

在ide中一般都会带有格式化工具，在goland中有gofmt和goimports

注释

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

命名规范

变量

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

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

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

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

函数

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

包

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

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

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

控制流程

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

尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，尽早返回或继续循环嵌套来减少嵌套

• 最常见的正常流程的路径被嵌套在两个if条件内
• 成功的退出条件是return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

错误和异常处理

简单错误

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

错误的Wrap和Unwrap

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

错误判定

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

panic

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

recover

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

性能优化

Beanchmark

性能表现需要实际数据衡量，go语言提供了支持基准性能测试的beanchmark工具

go test -bench=. -benchmem

Slice 预分配内存

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

• 切片本质是一个数组片段的描述

• • 包括数组指针
  • 片段的长度
  • 片段的容量(不改变内存分配情况下的最大长度)

• 切片操作并不复制切片指向的元素
• 创建一个新的切片会复用原来切片的底层数组

大内存未释放

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

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

• 可使用copy代替re-slice

map

map预分配内存

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

字符串处理

使用strings.Builder拼接字符串

使用+拼接新能最差，strings.Builder，bytes.Buffer详解,strings.Buffer更快

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