高质量编程|青训营

高质量编程

高质量：编写的代码能够达到正确可靠、简洁清晰的目标

1. 各种边界条件是否考虑完备
2. 异常情况处理，稳定性保证
3. 易读易维护

编程原则：

• 简单性

• 可读性

• 生产力

编码规范

如何编写高质量的Go代码：

1. 代码格式
2. 注释
3. 命名规范
4. 控制流程
5. 错误和异常处理

编码规范-代码格式

使用gofmt自动格式化代码：gofmt自动格式化代码，保证所有的Go代码与官方推荐格式保持一致。而且可以很方便的进行配置，像Goland内置 了相关功能，直接开启即可在保存文件的时候自动格式化。

gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格。常见IDE都支持方便的配置

goimports 也是Go语言官方提供的工具。goimports会对依赖包进行管理，自动增删依赖的包引用，按字母序排序分类

编码规范-注释

注释应该做的：

1. 解释代码作用 注释公共符号：

   • 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
   • 任何既不明显也不简短的公共功能必须予以注释
   • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
   • 有一个例外，不需要注释实现接口的方法（因为实际没有给出信息）。具体不要像下面这样做

// Read implements the io.Rladet, interface
func (r *FileReader) Read(bur []byte) (int error)

1. 解释代码如何做的 注释实现过程：
2. 解释代码实现的原因 解释代码的外部因素 提供额外上下文
3. 解释代码什么情况会出错 解释代码的限制条件

小结：

• 代码是最好的注释
• 注释应该提供代码未表达出的上下文信息

编码规范-命名规范

variable：

• 简洁胜于冗长

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

  • 例如使用ServeHTTP而不是ServeHttp
  • 使用XMLHTTPRequest或者xmIHTTPRequest

• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

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

// Good
func (C *Client) send(req *Request, deadline time.Time)
// Bad
func (C *Client) send(req *Request, t time.Time)

• 将deadline替换成t降低了变量名的信息量
• t常代指任意时间
• deadline指截止时间，有特定的含义

function ：

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的（包名.func）

• 函数名尽量简短

• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

• 当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息

http包中创建服务的函数如何命名更好?

func Serve(l net._istener, handler Handler) error
func ServeHTTP(l net.Listener, handler Handler) error

推荐使用第一种，原因在于你在调用http包的时候是.Serve

package:s

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如schema、task等
• 不要与标准库同名。例如不要使用sync或者strings

以下规则尽量满足，以标准库包名为例

• 不使用常用变量名作为包名。例如使用bufio而不是buf
• 使用单数而不是复数。例如使用encoding而不是encodings
• 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

小结:

• 核心目标是降低阅读理解代码的成本
• 重点考虑上下文信息，设计简洁清晰的名称

编码规范-控制流程

避免嵌套，保持正常流程清晰: 如果两个分支中都包含return语句，则可以去除冗余的else。

// Bad
if foo {
  return X
} else {
  return nil
}
// Good
if foo {
  return X
}
return nil

尽量保持正常代码路径为最小缩进:

• 优先处理错误情况特殊情况，尽早返回或继续循环来减少嵌套
• 最常见的正常流程的路径被嵌套在两个if条件内

go
复制代码
// Good
func OneFunc( ) error {
    if err := doSomething(); err != nil {
        return err
    }
    if err. := doAnotherThing(); err != nil {
        return err
    }
    return nil // normal case
}

小结:

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多出现在复杂的条件语句和循环语句中

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

简单错误:

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

go
复制代码
func defaultCheckRedirect(req *Request, via []*Request) error {
 if len(via) >= 10 {
  return errors . New( "stopped after 10 redirects")
 }
 return nil
}

错误的Wrap和Unwrap:

• 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链

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

  go
  复制代码
  list, _, err := c.GetBytes(cache.Subkey(a.actionID, "srcfiles"))
  if err != nil{
   return fmt.Errorf("reading srcfiles list: %W",err)
  }
  

Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.Is errors.As,errors.Unwrap以及fmt.Errorf的%W。

如果项目运行在小于Go1.13的版本中，导入golang.org/x/ xerrors来使用

错误判定:

• 判定一个错误是否为特定错误，使用errors.Is

• 不同于使用==,使用该方法可以判定错误链.上的所有错误是否含有特定的错误

• 在错误链上获取特定种类的错误，使用errors.As

  go
  复制代码
  if _,err := os.Open("non-existing"); err != nil {
    var pathError *fs.PathError
    if errors.As(err, &pathError) {
        fmt. Println("Failed at path:", pathError.Path)
    } else {
        fmt.Println(err)
    }
  }
  

panic:

• 不建议在业务代码中使用panic

• 调用函数不包含recover会造成程序崩溃

• 若问题可以被屏蔽或解决，建议使用error代替panic

• 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

  go
  复制代码
  func main() {
   ctx, cancel := context.WithCancel(context.Background( ))
   client,err := sarama.NewConsumerGroup(strings.Split(brokers,"), group, config)
   if err!=nil{
    log.Panicf("Error creating consumer group client: %V",err)
   }
  }
  // Panicf is equivalent to Printf() followed by a call to panic().
  func Panicf(format string, V ... interface{}) {
   S := fmt.Sprintf(format, V... )
   std.output(2,s)
   panic(s)
  }
  

recover:

• recover只能在被defer的函数中使用

• 嵌套无法生效

• 只在当前goroutine生效

• defer的语句是后进先出

• 如果需要更多的上下文信息，可以recover 后在log中记录当前的调用栈

  go
  复制代码
  func (t *treeFS) Open(name string) (f fs.File, err error) {
   defer func() {
    if e := recover(); e != nil {
     f = nil
     err = fmt.Errorf("gitfs panic: %V\n%S", e, debug.Stack())
    }
    // ...
   }
  }
  

小结:

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

编码规范

哪种命名方式更好? :

调用的时候，time.Now()更简洁

go
复制代码
t := time.Now()
t := time.NowTime()

---

go
复制代码
package time
// A function parses a duration string.
// such as "300ms", "-1.5h” or "2h45m'
func Parse(s string) (Duration, error)
// or
func ParseDuration(s string) (Duration, error)

实际调用的时候:

go
复制代码
duration := time.Parse(s)
duration := time.ParseDuration(s) //没有误解