高质量编程与性能调优实战(一) | 青训营

60 阅读2分钟

一.高质量编程

1.1 介绍 编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

各种边界条件是否考虑完备 异常情况处理,稳定性倮证 易读易维护 1.2编码规范 代码格式 注释 命名规范 控制流程 错误和异常处理 1.2.1 编码规范-代码格式 推荐使用gofmt 自动格式化代码

gofmt

Go 语言官方提供的 工具,能自动格式化 Go 语言代码为官方统一风格

常见IDE都支持方便的配置

goimports

也是Go 语言官方提供的工具

实际等于gofmt 加上依赖包管理

自动增删依赖的包引用、将依赖包按字母序排序并分类

1.2.2 编码规范-注释 注释应该解释代码作用 注释应该解释代码如何做的 注释应该解释代码实现的原因 注释应该解释代码什么情况会出错 1.2.3编码规范-命名规范 简洁胜于冗长

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

例如使用 ServeHITTP 而不是 ServefIttp 使用 XMLHTTPReauest 或者 xmIIITTPRequest 变量距离其被使用的地方越远,则需要携带越多的上下文信息

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

// Bad for index := 0; index < len(s); index++ { // do sth. }

// Good for i := 0; i < len(s); i++ { // do sth. } i和index 变量作用域仅限于 for 循环内,index的额外冗长几乎没有增加对于程序理解

// Good func (c *Client) send(req *Request, deadline time.Time)

// Bad func (c *Client) send(req *Request, t time.Time) 将deadline 替换成t降低了变量名的信息量

t常代指任意时间

deadline 指截止时间,有特定的含义

函数名不应携带包名的上下文信息,因为两者总是成对出现; 函数名应当尽量简短; 当名为 foo 包的某个函数返回类型为 Foo 时,可以省略类型信息而不导致歧义; 当名为 foo 包的某个函数返回类型为 T 而不是 Foo 时,应该在函数名中加入类型信息。 package http // Good func Serve(I net.Listener, handler Handler) error // Bad func ServeHTTP(I net.Listener, handler Handler) error

只由小写字母组成。不包含大写字母和下划线等字符; 简短并包含一定的上下文信息; 不要和标准库同名。 不使用常用变量名作为包名。例如使用 bufio 而不是 buf; 使用单数而不是复数。例如使用 encoding 而不是 encodings; 谨慎的使用缩写。例如使用 fmt 在不破坏上下文的情况下比 fotmat 更简短。 小结

go语言走的是极简风格

1.2.4编码规范-控制流程

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

// Bad if foo { return x } else { return nil }

// Good if foo { return x } return nil 如果两个分支中都包含return语向,则可以去除冗余的else

1.2.5编码规范-错误和异常处理

>简单错误

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

•错误的 Wrap 实际上是提供了一个error 嵌套另一个 error

的能力,从而生成一个 error 的跟踪链

在fmt.Brrorf 中使用:%w关键字来将一个错误关联至错误

链中

Go1.13 在errors 中新增了三个新API和一个新的

format 关键字,分别是 errors.Is errors.As,errors.Unwrap 以及fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中,导人golang.org/x/xerrors来使用

>错误判定

判定一个错误是否为特定错误,使用 errors.ls 不同于使用二,使用该方法可以判定错误链上的所有错误是否含有特定的错误 在错误链上获取特定种类的错误,使用errors.As

panic

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

recover

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

未完待续。。。。。。。