高质量编程与性能调优实战|青训营笔记

玖之
105 阅读5分钟

这是我参与「第三届青训营 -后端场」笔记创作活动的的第3篇笔记

高质量编程与性能调优实战

高质量编程

  1. 高质量编程简介

    什么是高质量编程：一编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

  • 各种边界条件是否考虑完备
  • 异常情况处理，稳定性保证
  • 易读易维护 原则：简单性、可读性、生产力
  1. 编码规范

  • 代码格式

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

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

    goimports
    也是Go语言官方提供的工具
    实际等于gofmt加上依赖包管理
    自动增删依赖的包引用、将依赖包按字母序排序并分类

  • 注释

    注释应该做的:

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

  • 命名规范

    variable

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

      例如使用ServeHTTP而不是ServeHttp
      使用XMLHT TPRequest或者XmIHT TPRequest

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

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

    function

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

    package

    • 只由小写字母组成。不包含大写字母和下划线等字符
    • 简短并包含一定的上下文信息。例如schema、task 等
    • 不要与标准库同名。例如不要使用sync 或者strings 以下规则尽量满足，以标准库包名为例
    • 不使用常用变量名作为包名。例如使用bufio而不是buf
    • 使用单数而不是复数。例如使用encoding而不是encodings
    • 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

  • 控制流程

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

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

  • 错误和异常处理

    简单错误

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

    错误的Wrap和Unwrap

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

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

      Go1.13在errors 中新增了三个新API和一个新的format关键字，分别是errors.Is errors.As,errors.Unwrap以及fmt.Errorf 的%W。如果项目运行在小于Go1.13的版本中，导入 golang.org/x/xerrors 来使用 错误判定

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

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

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

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

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

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

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

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

    • 嵌套无法生效

    • 只在当前goroutine生效

    • defer的语句是后进先出

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

  1. 性能优化建议

  • 简介
    性能优化的前提是满足正确可靠、简洁清晰等质量因素
    性能优化是综合评估，有时候时间效率和空间效率可能对立。

  • benchmark

    如何使用
    go test -bench=. -benchmem

    结果说明

    v.png

  • slice
    slice预分配内存

    • 尽可能在使用make()初始化切片时提供容量信息

    另一个陷阱:大内存未释放

    在已有切片基础上创建切片，不会创建新的底层数组

    • 场景
      原切片较大，代码在原切片基础上新建小切片
      原底层数组在内存中有引用，得不到释放 可使用copy替代re-slice

  • map
    map预分配内存

  • 字符串处理
    使用strings.Builder

    func StrBuilder(n int, str string) string {
    var builder strings.Builder
    for i:=0;i<n;i++{
        builder.WriteString(str)
    }
    return buf.String()
}

  • 空结构体
    使用空结构体节省内存

    • 空结构体struct{}实例不占据任何的内存空间
    • 可作为各种场景下的占位符使用
      • 节省资源
      • 空结构体本身具备很强的语义，即这里不需要任何值,仅作为占位符

  • atomic包
    如何使用

    type atomicCounter struct {
    i int32
}
func AtomicAddOne(C 
    *atomicCounter) {
    atomic .AddInt32(&c.i,1)
}

    使用atomic包

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

性能调优实战

  1. 性能调优简介

    性能调优原则

  • 要依靠数据不是猜测
  • 要定位最大瓶颈而不是细枝末节
  • 不要过早优化
  • 不要过度优化

  1. 性能分析工具pprof实战
    github.com/wolfogre/go…

    5.png

  2. 性能调优案例
    业务服务优化

    基本概念

    服务：能单独部署，承载一定功能的程序
    依赖：Service A 的功能实现依赖 Service B 的响应果，称为 Service A 依赖 Service B
    调用链路：能支持一个接口请求的相关服务集合及其相互之间的依赖关系
    基础库：公共的工具包、中间件

    流程

    建立服务性能评估手段
    分析性能数据，定位性能瓶颈
    重点优化项改造
    优化效果验证

    基础库优化

    AB实验SDK的优化

    分析基础库核心逻辑和性能瓶颈

    • 设计完善改造方案
    • 数据按需获取
    • 数据序列化协议优化
      内部压测验证
      推广业务服务落地验证

    Go 语言优化

    编译器&运行时优化

    优化内存分配策略
    优化代码编译流程，生成更高效的程序
    内部压测验证
    推广业务服务落地验证

    优点

    接入简单，只需要调整编译配置
    通用性强

avatar
文章
阅读
粉丝