Go代码审查：检查什么以及如何给新手提供反馈

Go代码审查：检查什么以及如何给新手提供反馈

代码审查不仅仅是合并拉取请求前的形式检查。它是提升代码质量、在团队中分享知识以及在早期阶段预防错误的强大工具。对于Go初学者来说，参与审查可能会感到压力：害怕收到批评，或者相反，害怕遗漏关键错误。在本文中，我们将探讨审查Go代码时需要注意什么，以及如何提供有用而非伤人的反馈。

为什么代码审查在Go中尤为重要？

Go语言的设计强调简单、可读性和可靠性。然而，语法的简单性并不能消除逻辑的复杂性。Go项目中常见的问题包括：忽略错误、goroutine使用不当以及资源泄漏。良好的代码审查有助于在问题进入生产环境之前发现这些问题。

Go代码中检查什么：新手检查清单

为了使审查系统化，请使用检查清单。以下是每个拉取请求中应检查的主要项目。

1. 错误处理

在Go中，错误是值，不能忽略。检查每个返回error的函数是否处理了错误，或显式地将错误向上传递。

// 不好：忽略错误\nfile, _ := os.Open("config.yaml")\n\n// 好：处理错误\nfile, err := os.Open("config.yaml")\nif err != nil {\n    log.Fatalf("cannot open config: %v", err)\n}\ndefer file.Close()

同时检查错误是否使用fmt.Errorf("...: %w", err)进行包装以传递上下文，而不是仅仅记录并忽略。

2. 命名与可读性

在Go中，变量名通常较短（例如，r表示reader，w表示writer），而导出的函数名则较长。请检查：

\n
• 导出的函数、类型和变量是否有注释（以实体名称开头）。
\n
• 变量名是否反映其用途（不要使用a、b、tmp）。
\n
• 没有不必要的缩写（calc最好替换为calculate）。
\n

3. goroutine与并发处理

Goroutine是强大但危险的工具。请检查：

\n
• 共享数据是否有同步机制（通道、互斥锁）。
\n
• 是否创建了“泄漏”的goroutine。使用上下文（context.Context）进行取消。
\n
• goroutine是否永久阻塞（死锁）。
\n

// 安全使用goroutine的示例\nfunc worker(ctx context.Context, jobs <-chan int, results chan<- int) {\n    for {\n        select {\n        case job, ok := <-jobs:\n            if !ok {\n                return\n            }\n            results <- job * 2\n        case <-ctx.Done():\n            return\n        }\n    }\n}

4. 资源管理（defer）

检查所有打开的文件、网络连接、数据库事务是否通过defer关闭。这应在成功打开资源后立即完成。

// 正确：立即关闭\nconn, err := net.Dial("tcp", "example.com:80")\nif err != nil {\n    return err\n}\ndefer conn.Close()

5. 测试

新手常常忘记编写测试。确保为新逻辑编写了单元测试。请检查：

\n
• 测试不仅覆盖正常路径，还覆盖边界情况。
\n
• 是否使用t.Run进行子测试。
\n
• 没有依赖外部资源（数据库、网络）且未使用mock的测试。
\n

如何提供反馈：新手的5条规则

技术部分只是成功的一半。另一半是沟通能力。以下是