前言
本文将介绍Go
言语的高质量编程、Go
言语编码规范。
简介
什么是高质量?
在编写代码时,能够达到正确牢靠、简洁明晰的方针可称之为高质量代码。
高质量代码需求满意的条件:
- 各种边界条件是否考虑完备
- 异常状况处理周全、稳定性的保证
- 代码易读易保护
编写高质量代码,团队之间彼此阅览代码才会比较顺畅,一起也能进步团队开发效率。做到高质量代码,他人在看代码时才干清楚明白代码的效果,才干够放心的去重构或进行代码优化,才干放心的在原有代码基础之上添加新的功用,不必忧虑呈现无法预料到的东西。
编程准则
实际应用场景千变万化,各种言语的特性和语法各不相同,但是高质量编程遵从的准则是相同的。
简略性
- 消除“多余的杂乱性”,以简略明晰的逻辑编写代码
- 不了解的代码无法修复改善
可读性
- 代码是写给人看的,而不是机器
- 编写可保护代码的第一步是保证代码可读
生产力
- 团队全体工作效率非常重要
编码规范
怎么编写高质量的Go代码?有一些公认的开源的编码规范能够供给咱们参阅,像一些公司内部也有自己的编码规范。
下面选几个重要的规范来介绍下:
- 代码格式
- 注释
- 命名规范
- 操控流程
- 过错和异常处理
代码格式
代码各种能统一的话,团队之间协作就能把关注点放在详细的逻辑上,进步效率。
推荐运用gofmt
主动格式化代码
gofmt
Go
言语官方供给的东西,能主动格式化Go
言语代码为官方统一风格,常见IDE都支撑便利的配置
goimports
也是Go
言语官方供给的东西,实际等于gofmt
加上依靠包办理,主动增删依靠的包引证、将依靠包按字母序排序并分类。 能够在下方链接找到答案:
GoLand (windows)配置 go fmt 与 goimports_goland 添加gofmt goimport_情、狠现实的博客-CSDN博客
注释
写代码时不加注释,其时或许只有你和天主知道,但过了几年,或许只有天主才干知道了。
Good code has lots of comments, bad code requires lots of comments. 好的代码有许多注释,坏的代码需求许多注释。
公共符号始终要注释
- 包中声明的每个公共的符号:变量、常量、函数以及结构都需求添加注释
- 任何既不明显也不简略的公共功用必须予以注释
- 不管长度或杂乱成都怎么,对库中的任何函数都必须进行注释
- 例外:不需求注释接线接口的办法。
注释很重要,能够快速了解代码的意义,那注释应该怎么做呢?
- 应该解说代码效果
- 应该解说代码怎么做的
- 应该解说代码完成的原因
- 应该解说代码什么状况会呈现过错
解说代码效果
适合注释公共符号,比如公共的常量、函数。假如一个函数经过姓名就能知道他的效果,那么这样的函数能够不必加注释。
解说代码怎么做的
适合注释完成进程
对一些完成逻辑杂乱的代码、调用函数功用不是很明显的代码逻辑加上注释。
解说代码完成的原因
适合解析代码的外部因素,供给额定上下文,让人知道为什么这样做,要不然后续再保护代码时,会让人很难了解。
解说出错状况
适合解说代码的限制条件,经过注释能够知道在运用的进程中应该有哪些留意的点,以防在运用的进程中,产生过错。
命名规范
命名规范的核心方针是下降阅览了解代码的成本,重点考虑上下文信息,设计简洁明晰的名称。
Good naming is like a good joke,if you have to explian it, it is not funny. 好的命名就像一个好笑话,假如你必须解说她,那就欠好笑了。
变量
-
简洁胜于冗长
-
缩略词全大写,但当其坐落变量开头且不需求导出时,运用全小写
- 例如运用ServeHTTP而不是ServeHttp
- 运用XMLHTTPRequest或者xmlHTTPRequest
-
变量距离其被运用的当地越远,则需求带着越多的上下文信息
- 全局变量在其姓名中需求更多的上下文信息,使得在不同当地能够容易辨认出其意义
go
仿制代码
仿制代码
// 欠好的代码
for index := 0; index < len(s); index++ {
// so something
}
// 好的代码
for i := 0; i < len(s); i++ {
// so something
}
i
和index
的效果域规模仅限于for
循环内部时,index
的额定冗长几乎没有添加对于程序的了解。
函数
- 函数名不带着包名的上下文信息,由于包名和函数名总数成对呈现的
- 函数名尽量简略
- 当名为foo的包某个函数回来类型Foo时,能够省掉类型信息而不导致歧义
- 当名为foo的包某个函数回来类型T时(T并不是Foo),能够在函数名中参加类型信息
包名
- 只由小写字母组成,不包括大写字母和下划线等字符
- 简略并包括必定的上下文信息,例如schema、task等
- 不要与规范库同名,例如不要运用sync、strings等
以下规则尽量满意,以规范库包名为例
- 不运用常用变量名作为包名,例如运用bufio而不是buf
- 运用单数而不是复数,例如运用encoding而不是encodings
- 谨慎地运用缩写,例如运用fmt在不破坏上下文的状况下比format更加简略
操控流程
流程操控要遵从线性原理,处理逻辑尽量走直线,避免杂乱的嵌套分支;正常流程代码要沿着屏幕向下移动;
好的流程能够提高代码的可保护性和可读性。
在实际项目中,毛病问题大多呈现在杂乱的条件句子和循环句子中。
好的流程操控要遵从以下几点:
-
避免嵌套,坚持正常流程明晰
go 仿制代码 仿制代码 // 欠好的代码 if foo { return x } else { return nil } // 好的代码 if foo { return x } return nill
假如两个分支都包括
return
句子,则能够去除冗余的else
(也被称为卫句子)。 -
尽量坚持正常代码路径为最小缩进
- 优先处理过错状况/特殊状况,尽早回来或继续循环来削减嵌套
go 仿制代码 仿制代码 // 欠好的代码 func OneFunc() error { err := dosomething() if err == nil { err := dosomething() if err == nil { return nil } return err } return err } // 好的代码 func OneFunc() error { if err := dosomething(); err != nil { return err } if err := doAnotherthing(); err != nil { return err } return nil }
过错和异常处理
error尽可能供给简明的上下文信息链,便利定位问题,panic用于真正异常的状况,recover收效规模,在当时goroutine的被defer的函数中收效。
简略过错
- 简略的过错指的是仅呈现一次的过错,且在其他当地不需求捕获该过错
- 优先运用
errors.New
来创建匿名变量来直接表示简略过错 - 假如有格式化的需求,运用
fmt.Errorf
过错的Wrap和Unwrap
- 过错的
Wrap
实际上是供给了一个error
嵌套另一个error
的能力,从而生成一个error
的跟踪链 - 在
fmt.Errorf
中运用%w
关键字来将一个过错关联至过错链中
过错断定
- 断定一个过错是否为特定过错,运用
errors.Is
- 不同于运用==,运用该办法能够断定过错链上的一切过错是否含有特定的过错
- 在过错链上获取特定种类的过错,运用
errors.As
panic
- 不建议在业务代码中运用
panic
- 调用函数不包括
recover
会造成程序崩溃 - 若问题能够被屏蔽或处理,建议运用
error
代替panic
- 当程序启动阶段产生不可逆转的过错时,能够在
init
或main
函数中运用panic
recover
-
recover
只能在被defer
的函数中运用 -
嵌套无法收效
-
只在当时
goroutine
收效 -
defer
的句子是后进先出 -
假如需求更多的上下文信息,能够
recover
后再log
中记录当时的调用栈