这是我参加「第五届青训营 」伴学笔记创造活动的第 7 天

前语

本文将介绍Go言语的高质量编程、Go言语编码标准。

简介

什么是高质量？

在编写代码时，能够达到正确可靠、简练明晰的目标可称之为高质量代码。

高质量代码需求满意的条件：

  • 各种边界条件是否考虑完备
  • 反常状况处理周全、稳定性的确保
  • 代码易读易保护

编写高质量代码，团队之间相互阅览代码才会比较顺利，同时也能提高团队开发功率。做到高质量代码，别人在看代码时才干清楚了解代码的效果，才干够定心的去重构或进行代码优化，才干定心的在原有代码基础之上添加新的功用，不用忧虑呈现无法预料到的东西。

编程原则

实践应用场景千变万化，各种言语的特性和语法各不相同，可是高质量编程遵从的原则是相同的。

简略性

  • 消除“多余的杂乱性”，以简略明晰的逻辑编写代码
  • 不了解的代码无法修复改善

可读性

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

生产力

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

编码标准

怎么编写高质量的Go代码？有一些公认的开源的编码标准能够供给咱们参阅，像一些公司内部也有自己的编码标准。

下面选几个重要的标准来介绍下：

  • 代码格局
  • 注释
  • 命名标准
  • 操控流程
  • 过错和反常处理

代码格局

代码各种能一致的话，团队之间合作就能把关注点放在具体的逻辑上，提高功率。

推荐运用gofmt自动格局化代码

gofmt

Go言语官方供给的东西，能自动格局化Go言语代码为官方一致风格，常见IDE都支撑便利的装备

goimports

也是Go言语官方供给的东西，实践等于gofmt加上依赖包管理，自动增删依赖的包引证、将依赖包按字母序排序并分类。

注释

写代码时不加注释，其时也许只有你和天主知道，但过了几年，也许只有天主才干知道了。

Good code has lots of comments, bad code requires lots of comments. 好的代码有许多注释，坏的代码需求许多注释。

公共符号一直要注释

  • 包中声明的每个公共的符号：变量、常量、函数以及结构都需求添加注释
  • 任何既不显着也不简略的公共功用有必要予以注释
  • 无论长度或杂乱成都怎么，对库中的任何函数都有必要进行注释
  • 破例：不需求注释接线接口的办法。

Go 高质量编程、编码规范｜ 青训营笔记

注释很重要，能够快速了解代码的含义，那注释应该怎么做呢？

  • 应该解说代码效果
  • 应该解说代码怎么做的
  • 应该解说代码完成的原因
  • 应该解说代码什么状况会呈现过错
解说代码效果

合适注释公共符号，比方公共的常量、函数。假如一个函数经过姓名就能知道他的效果，那么这样的函数能够不用加注释。

Go 高质量编程、编码规范｜ 青训营笔记

解说代码怎么做的

合适注释完成过程

对一些完成逻辑杂乱的代码、调用函数功用不是很显着的代码逻辑加上注释。

Go 高质量编程、编码规范｜ 青训营笔记

解说代码完成的原因

合适解析代码的外部要素，供给额定上下文，让人知道为什么这样做，要不然后续再保护代码时，会让人很难了解。

Go 高质量编程、编码规范｜ 青训营笔记

解说出错状况

合适解说代码的限制条件，经过注释能够知道在运用的过程中应该有哪些留意的点，以防在运用的过程中，发生过错。

Go 高质量编程、编码规范｜ 青训营笔记

命名标准

命名标准的中心目标是下降阅览了解代码的本钱，要点考虑上下文信息，设计简练明晰的称号。

Good naming is like a good joke,if you have to explian it, it is not funny. 好的命名就像一个好笑话，假如你有必要解说她，那就欠好笑了。

变量

  • 简练胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需求导出时，运用全小写
    • 例如运用ServeHTTP而不是ServeHttp
    • 运用XMLHTTPRequest或许xmlHTTPRequest
  • 变量间隔其被运用的地方越远，则需求带着越多的上下文信息
    • 全局变量在其姓名中需求更多的上下文信息，使得在不同地方能够容易辨认出其含义
// 欠好的代码
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愈加简略

操控流程

流程操控要遵从线性原理，处理逻辑尽量走直线，避免杂乱的嵌套分支；正常流程代码要沿着屏幕向下移动；

好的流程能够提高代码的可保护性和可读性。

在实践项目中，毛病问题大多呈现在杂乱的条件句子和循环句子中。

好的流程操控要遵从以下几点：

  • 避免嵌套，坚持正常流程明晰

    // 欠好的代码
if foo {
    return x
} else {
    return nil
}
// 好的代码
if foo {
    return x
}
return nill

    假如两个分支都包括return句子，则能够去除冗余的else(也被称为卫句子)。

  • 尽量坚持正常代码途径为最小缩进

    • 优先处理过错状况/特殊状况，尽早回来或持续循环来减少嵌套
    // 欠好的代码
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

Go 高质量编程、编码规范｜ 青训营笔记

过错的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中记载当前的调用栈

引证

高质量编程简介及编码标准