高质量编程与性能调优 ｜ 青训营笔记

制冰机
72 阅读7分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天

重点内容

  1. 如何编写更简洁清晰的代码
  2. 常用Go语言程序优化手段
  3. 熟悉Go程序性能分析工具
  4. 了解工程中性能优化的原则和流程

详细知识点

高质量编程

要点：正确可靠、简洁清晰

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

编程原则：简单性、可读性、生产力 简单：消除“多余的复杂性”、逻辑简单清晰 刻度：编写可维护代码

编码规范

代码格式

Golang可以使用Go官方提供的工具gofmt自动格式化代码，也可以使用goimports(gofmt+依赖包管理)

我觉得这种有官方一键整理代码格式的功能挺好的，有的时候写的快，可能哪里敲了空格但代码里没有，格式就会不舒服，一键格式化后就不用花更多时间关注格式问题了

注释

  1. 注释应该解释代码 作用
  2. 如何做的
  3. 实现的原因
  4. 什么情况会出错

1：适合注释公共符号 2：适合注释代码实现过程 3：适合解释代码的外部因素，提供额外上下文 4：适合解释代码的限制条件

公共符号始终要注释！

这里我看下来的感受是注释还是用英文吧，因为看视频里的例子全是英文注释，个人用不同IDE时，如果是两种编码规则中文注释就会乱码，英文就不会出现这个情况了。

命名规范

变量variable

简洁胜于冗长 缩略词全大写、当位于变量开头且不需导出时小写 使用ServeHTTP而不是ServeHttp 使用XMLHTTPRequest或xmlHTTPRequest 变量距离被使用的地方越远，则需要携带越多的上下文信息 全局变量名字中需要更多上下文信息

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

这个例子可以很明显看出deadline做参数名比t做参数名含义更明显

函数function

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

http包中创建服务函数如何命名？：

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

因为是http包中的函数，调用时会http.Serve，所以再加HTTP就会很多余

包package

只由小写字母组成，不包含大写字母和下划线等字符 简短并包含一定的上下文信息。 不要与标准库同名。如不用strings

对Golang包的理解不是很深刻，这部分后面继续理解

控制流程

1、避免嵌套，保持流程清晰

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

这个例子中，两个分支都包含return语句，可以去除冗余的else。这个错误处理中比较常见，前几节课看到的代码中基本都是这样的处理

2、尽量保证正常代码路径为最小缩进，即优先处理错误情况/特殊情况，尽早返回或继续循环减少嵌套

//Bad 
func OneFunc() {
    err := doSomething()
    if err == nil {
        err := doAnotherThing()
        if err == nil {
            return nil // normal case
        }
    }
    return err
}
​
//Good
func OneFunc() {
    if err := doSomething(); err != nil {
        return err
    }
    if err := doAnotherThing(); err != nil {
        return err 
    }
    return nil // normal case 
}

这里可以很清楚的看到两段代码的功能是一样的，但是下面的比上面的要简洁清晰的多

简单来说，正常情况放最后，先处理特殊情况和异常情况

错误和异常处理

简单错误

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

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关键字来将一个错误关联至错误链中

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

这里不是很理解意思，是说可以为错误信息添加上下文？ 还是说可以把遇到的所有错误信息都输出到一起？

错误判定

用 errors.Is 判断一个错误是否为特定错误 更可以判定错误链上的所有错误是否包含特定的错误 （比 == 功能更强大）

data, err = lockedfile.Read(targ)
if errors.Is(err, fs.ErrNotExist) {
    return []byte{}, nil
}
return data, err

错误链上获取特定种类的错误：errors.As

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

recover

recover只能在被defer的函数中使用 嵌套无法生效 只在当前goroutine生效 defer的语句是后进先出

func (s *ss) Token(skipSpace bool, f func(rune) bool) (tok []byte, err error) {
    defer func() {
        if e := recover(); e != nil {
            if se, ok := e.(scanError); ok {
                err = se.err
            } else {
                panic(e)
            }
        }
    }()
    // ...
}

如果需要更多上下文信息，可以recover后在log中记录当前的调用栈 通过debug.Stack()

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

性能优化

性能优化是综合评估，有时候时间效率和空间效率可能对立

Benchmark

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

Slice

预分配内存 使用 make([]int, 0, size) 而不是 make([]int, 0)

在已有切片基础上创建切片，不会创建新的底层数组 所以在原切片大，新切片小的情况下，可使用copy代替re-slice，这样原切片就能被释放了

Map

同理，预分配内存

向map添加元素时会触发map的扩容，提前分配内存可以减少内存拷贝和Rehash的消耗

字符串处理

三种字符串拼接方式：

// +
func Plus(n int, str string) string {
    s := ""
    for i := 0; i < n; i++ {
        s += str
    }
    return s
}
​
//strings.Builder
func StrBuilder(n int, str string) string {
    var builder strings.Builder
    for i := 0; i < n; i++ {
        builder.WriteString(str)
    }
    return builder.String()
}
​
//ByteBuffer
func ByteBuffer(n int, str string) string {
    buf := new(bytes.Buffer)
    for i := 0; i < n; i++ {
        buf.WriteString(str)
    }
    return buf.String()
}

+性能最差，strbuilder比起buffer会短一些，两者性能都比较好

+拼接时会开辟新的空间，另两个底层都是[]byte数组

strbuilder直接将底层的[]byte数组转换成了字符串，而bytebuffer转化为字符串时申请了一块空间

可以在合成时先扩容，这样效率更高 使用 .Grow(n * len(str))

空结构体

用空结构体struct{}作为map键值对的值，不占空间，适用于在不取map值的情况

atomic包

适用于多线程编程，现在还不是特别懂，先码着？

锁的实现通过OS实现，属于system call atomic操作通过硬件实现，效率比锁高 sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量 对于非数值操作，可以使用atomic.Value，能承载一个interface{}

avatar
文章
阅读
粉丝