高质量编程
1.1简介
1.各种边界条件是否考虑完备
2.异常情况处理,稳定性保证
3.易读易维护
1.2 编码规范
——如何写高质量的GO代码
代码格式;注释;命名规范;控制流程;错误和异常处理
1.2.1 编码规范-代码格式
——推荐使用gofmt自动格式化代码
gofmt
GO语言官方提供的工具,能自动格式化GO语言代码为官方统一风格
常见IDE都支持方便的配置
goiports
也是GO语言官方提供的工具
实际等于gofmt加上依赖包管理
自动增删依赖包的引用、将依赖包按字母序排序并分类
1.2.2编码规范-注释
——公共符始终要注释
1.包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
2.任何既不明显也不简短的公共功能必须予以注释
3.无论长度或复杂程度如何,对库中的任何函数都必须进行注释
4.有一个例外,不需要注释实现接口的方法
注释应该做的
解释代码作用;解释代码如何做的;解释代码实现的原因;代码什么情况下会出错
1.2.3 编码规范-命名规范
——variable
1.简洁胜于长
2.缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写;如:使用ServeHTTP而不是ServeHttp,使用XMLHTTPRequest或者xmlHTTPRequest
3.变量距离其被使用的地方越远,则需要携带越多的上下信息
4.全局变量在其名字中雪瑶更多的上下文信息,使得在不同地方可以轻易辨认出其含义
——package
1.只由小写字母组成。不包含大写字母和下划线等字符
2.简短并包含一定的上文信息。例如schema、task等
3.不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足,以标准库包为例
1.不适用常用变量名作为包名。使用例如bufio而不是buf
2.使用单数而不是复数。例如使用encoding而不是encodings
3.谨慎的使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
1.2.4 编码规范-控制流程
——尽量保持正常代码路径为最小缩进
1.优先处理错误情况/特殊情况,应尽早返回或继续循环来减少嵌套
2.最常见的正常流程的路径被嵌套在两个if条件内
3.成功的退出条件是return nil,必须仔细匹配大括号来发现函数最后一行返回一个错误,需要追溯到匹配的左括号,才能了解合适会触发错误
4.如果后续正常流程需要增加一步操作,调用新的函数,则又会增加一层嵌套
故障问题大多出现在复杂的条件语句和循环语句中
1.2.5编码规范—错误和异常处理
——简单错误
1.简单错误指的是仅出现一次的错误,且在其他地方不需要捕获该错误
2.优先使用errors.New来创建匿名变量来直接表示简单错误
3.如果有格式化的需求,使用fmt.Errorf
——错误的Wrap和Unwrap
1.错误的Wrap实际上提供了一个error嵌套另一个error的能力,从而产生一个error的跟踪链
2.在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中
——错误判定
1.判定一个错误是否为特定错误,使用error.ls
2.不同与使用==,使用该方法可以判定错误链上所有错误是否有含有特定的错误
3.在错误链上获取特定种类的错误,使用errors.As
——panic
1.不建议在业务代码中使用panic
2.调用函数不包含recover会造成程序崩溃
3.若问题可以被屏蔽或解决,建议使用error代替panic
4.当程序启动阶段发生不可逆转的错误时,可以在init或main函数中使用panic
——recover
1.recover只能在被defer的函数中使用
2.嵌套无法生效
3.只在当前goroutine生效
4.defer的语句是后进先出
5.如果需要更多的上下文信息,可以recover后在log中记录当前的调用栈