高质量编程 | 豆包MarsCode AI刷题

1 高质量编程

1.1 高质量编程简介

什么是高质量：

编写的代码能够达到正确可靠、简介清晰的目标可称之为高质量代码

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

编程原则：

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

简单性

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

1.2 编码规范

如何编写高质量Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

1.2.1 代码格式

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

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

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

1.2.2 编码规范-注释

Good code has lots of comments, bad code requires lots of comments -- Dave Thomas and Andrew Hunt

注释应该做的：

• 注释应该解释代码作用

  • 适合注释公共符号

• 注释应该解释代码如何做的

  • 适合注释实现过程

• 注释应该解释代码实现的原因

  • 适合解释代码的外部因素
  • 提供额外的上下文

• 注释应该解释代码什么情况会出错

  • 适合解释代码的限制条件

• 公共符号始终要注释

  • 包中声明的每个公共的符号、变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
  • 一个例外：不需要注释实现接口的方法

小结

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

1.2.3 编码规范-命名规范

variable

• 简介胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 例如使用ServeHTTP而不是ServeHttp
  • 使用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
}

//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

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

package

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

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

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

小结

Good naming is like a good joke. If you have to explain it, it's not funny. -- Dave Cheney

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

1.2.4 编码规范-控制流程

避免嵌套，保持正常流程清晰

如果两个分支都包含return语句，则可以去除冗余的else

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

//Good
if foo {
	return x
}
return nil

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

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

如下例：

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

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

• 最常见的正常流程的路径被嵌套在两个if条件内
• 成功的退出条件是return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结

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

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")
	}
	return nil
}

错误的Wrap和Unwrap

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

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

错误判定

• 判定一个错误是否为特定错误，使用error.Is
• 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

data, err = lockedfile.Read(targ)
if errors.Is(err, fs.ErrNotExist) {
	//Treat non-existent as empty, to bootstrap the "latest" file
	//the first time we connect to a given database
	return []byte{}, nil
}
return data, err

• 在错误链上获取特定种类的错误，使用error.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的语句是后进先出
• 如果需要更多的上下文信息，可以recover后再log中记录当前的调用栈

小结

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

1.3 性能优化建议

简介

• 性能优化的前提使满足正确可靠、简洁清晰等质量因素
• 性能优化是综合评估，有时候时间效率和空间效率可能对立
• 针对Go语言的特性、介绍Go相关的性能优化建议

1.3.1 Benchmark

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

//from fib.go
func Fib(n int) int {
	if n < 2 {
		return n
	}
	return Fib(n-1) + Fib(n-2)
}

//from fib_test.go
func BenchmarkFib10(b *testing.B) {
	// run the Fib function b.N times
	for n := 0; n < b.N; n++ {
		Fib(10)
	}
}

go test -bench=. -benchmem

1.3.2 性能优化建议-Slice

slice预分配内存

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

//Bad
func NoPreAlloc(size int) {
	data := make([]int, 0)
	for k := 0; k < size; k++ {
		data = append(data, k)
	}
}

//Good
func PreAlloc(size int) {
	data := make([]int, 0, size)
	for k := 0; k < size; k++ {
		data = append(data, k)
	}
}

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

大内存未释放

//Bad
func GetLastBySlice(orgin []int) []int {
	return origin[len(origin)-2:]
}

//Good
func GetLastByCopy(origin []int) []int {
	result := make([]int, 2)
	copy(result, origin[len(origin)-2:])
	return result
}

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

1.3.3 性能优化建议-Map

map预分配内存

• 不断向map中添加元素的操作会触发map的扩容
• 提前分配好空间可以减少内存拷贝和Rehash的消耗
• 根据实际需求提前预估好需要的空间

1.3.4 性能优化建议-字符串处理

使用strings.Builder

//Bad
func Plus(n int, str string) string {
	s := ""
	for i := 0; i < n; i++ {
		s += str
	}
	return s
}
//Good
func StrBuilder(n int, str string) string {
	var builder strings.Builder
	for i := 0; i < n; i++ {
		builder.WriteString(str)
	}
	return builder.String()
}

使用+拼接性能最差，strings.Builder，bytes.Buffer相近，strings.Buffer更快

分析

• 字符串在Go语言中是不可变类型，占用内存大小是固定的
• 使用+每次都会重新分配内存
• strings.Builder，bytes.Buffer底层都是[]byte数组
• 内存扩容策略，不需要每次拼接重新分配内存

1.3.5 性能优化建议-空结构体

使用空结构体节省内存

func EmptyStructMap(n int) {
	m := make(map[int]struct{})

	for i := 0; i < n; i++ {
		m[i] = struct{}{}
	}
}

func BoolMap(n int) {
	m := make(map[int]bool)

	for i := 0; i < n; i++ {
		m[i] = false
	}
}

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

使用场景：实现Set

• 考虑用map来代替
• 只需要map的键，不需要值
  • 即使将map的值设置为bool类型，也会多占据一个字节空间

性能优化建议-atomic包

加锁

type mutexCounter struct {
	i int32
	m sync.Mutex
}

func MutexAddOne(c *atomicCounter) {
	c.m.Lock()
	c.i++
	c.m.Unlock()
}

使用atomic包

type atomicCounter struct {
	i int32
}

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

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

小结

• 避免常见的性能陷阱可以保证大部分程序的性能
• 普通应用代码，不要一味地追求程序的性能
• 越高级的性能优化手段越容易出现问题
• 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能