高质量编程与编码规范和性能优化方案

84 阅读2分钟

高质量编程

高质量指的是编写的代码能够达到正确可靠,简洁清晰的目标可称之为高质量代码,主要包括简单性,可读性,生产力三点

如何编写高质量的Go代码

1.代码格式

推荐使用Goland中的的gofmt与goimports工具,gofmt能够自动格式化代码,goimports能够管理依赖包,根据代码自己动删除或导入依赖包

2.注释

注释应该解释代码的作用,解释代码如何做的(注释代码实现过程),解释代码实现的原因(适合解释代码的外部因素,提供格外的上下文),解释代码何时会出错(解释代码的限制条件),公共符号都要拥有注释。

3.命名规范

简洁而不冗长。缩略词应全部大写(当缩略词位于变量开头且不需要导出时使用小写),变量距离越远越需要提供上下文信息。函数名不要携带包名的上下文信息(例如http包中,函数名serve和serveHTTP中选择前者)。

4.控制流程

避免嵌套保持正常的流程清晰,保证正常代码路径为最小缩进

5.错误和异常处理

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

性能优化

Go语言中提供了性能测试的工具Benchmark在要测试时候输入指令go test -bench=. -benchmem即可进行程序的性能测试

1.性能优化建议

在使用make()函数时提供容量信息,在go语言中+拼接新能最差strings.Builder,bytes.buffer相近,string.Buffer更快

2.性能优化工具

pprof功能简介

J7Q)2R[5$M34MF%V8]6N(DF.png