青训营X豆包MarsCode技术训练营 | 高质量编程与性能调优实战什么是高质量 ————编写的代码能够达到正确可靠，简

一、课程目录

二、知识点

（一）高质量编程

1.1 简介

什么是高质量 ————编写的代码能够达到正确可靠，简洁清晰的目标

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

编程原则

实际应用场景千变万化，各种语言特性和语法各不相同，但是高质量编程遵循的原则是相通的

简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是给人看的，要清晰易懂
- 编写可维护的代码，第一步就是确保代码的可读
生产力
- 团队整体工作效率非常重要

1.2 编码规范

1.2.1 代码规范

推荐使用gofmt自动格式化代码

gofmmt：go语言官方提供的工具，能自动格式化GO语言代码为官方统一风格
goimports：GO语言官方提的工具，实际上相当gofmt嘉善依赖包管理，自动增删以来的包引用，将依赖包按字母序排序并分类

1.2.2 注释

注释应该解释代码作用
注释应该解释代码如何做的
注释应该解释代码实现的原因
注释应该解释代码什么情况会出错
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构
- 任何极不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 例外：不需要注释实现接口的方法

1.2.2小结

代码需要注释

注释应该提供给代码未表达出的上下文信息

1.2.3 命名规范

变量

简洁胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServerHTTP 而不是 ServerHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
变量距离其被使用得到地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

举例：

i和index的作用域范围仅限于for循环内部时，index的额外冗长没有增加对于程序的理解

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

 // Good
for i:=0;i<len(s);i++{
// do something
}

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

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

// Bad
func (c *CLient) send(req *Request,t time.Time)

方法

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
函数名尽量简短
当名为foo的包某个函数返回类型Foo 时，可以省略类型信息而不导致歧义
当名为foo 的包某个函数返回类型丁时（T并不是Foo)，可以在函数名中加入类型信息

举例：

在http包下明显第一个方法名更好

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

包

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

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

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

1.2.3小结

核心目标是降低阅读理解代码的成本

重点考虑上下文信息，设计简洁清晰的名称

1.2.4 控制流程

避免嵌套，保持正常流程清晰
尽量保持正常代码路径为最小缩进

    // Bad
    if foo{
        return x
    }else {
        return null
    }
    // Good
    if foo{
        return x
    }
    return null

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

// bad
func OneFunc()error{
    err := doSomething()
    if err==nil{
        err :=doAnotherThing()
        if err==nill{
            return nil
        }
        return err
    }
    return err
}

// good
func OneFunc()error{
    if err :=doSomething();err!=nill{
        return nil
    }
    if err := doAnotherThing();err!=nil{
        return err
    }
    return nil
}

1.2.4细节

线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支

正常流程代码沿着屏幕向下移动

提升代码可维护性和可读性

故障问题大多出现在复杂的条件语句和循环语句中

1.2.5 错误和异常处理

简单错误

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

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

错误的Wrap和Unwrap

错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的艰踪链
在fmt.Errorf 中使用: %w关键字来将一个错误关联至错误链中

list,_,err := c.GetBytes(cache.Subkey(a.actionID,"srcfiles"))
if err!=nil{
    return fmt.Errorf("reading srcfiles list:%w",err)
}

错误判定

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

data,err = lockfile.Read(targ)
if error.Is(err,fs.ErrNotExit){
    return []byte{},nil
}
return data,err


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

5. recover

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

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

1.3性能优化建议

1.3.1Benchmark

性能表现需要实际数据衡量
Go语言提供了支持基准性能测试的benchmark工具

go test -bench=. -benchmem

结果说明：

1.3.2 slice预分配内存

尽可能在使用make() 初始化切片时提供容量信息
第一条建议就是预分配，尽可能在使用make()初始化切片时提供容量信息，特别是在追加切片时
对比看下两种情况的性能表现，左边是没有提供初始化容量信息，右边是设置了容量大小
结果中可以看出执行时间相差很多，预分配只有一次内存分配

切片本质是一个数组片段的描述
- 包括数组拊针
- 片段的长度
- 片段的容量(不改变内存分配情况下的最大长度)
切片操作并不复制切片指向的元素
创建一个新的切片会复用原来切片的底层数组

先写到这吧，下次再继续咯, Good Bye~

青训营X豆包MarsCode技术训练营 | 高质量编程与性能调优实战

一、 课程目录