Go语言协作如何做代码审查规范_Golang PR模板与检查清单-Golang-PHP中文网

go项目代码审查必须聚焦context未cancel、error未unwrap、defer参数提前求值、sync.map误用四类高频线上问题；pr需强制填写what、why、how、test、related五字段，缺一拒合；审查优先定位main、init、http.handlerfunc及context.with相关函数，严查资源释放、ctx配对、error链完整性与并发安全。

go语言协作如何做代码审查规范_golang pr模板与检查清单

Go 项目代码审查不能靠“看看有没有语法错误”，真正卡住上线的，往往是 context 没 cancel、error 没 unwrap、defer 参数提前求值、sync.Map 误用这四类问题。

PR 提交前必须填满的 5 个字段

不是“建议填写”，是 CI 拒绝合并的硬门槛。缺任意一项，自动打回：

What：用一句话说清改了什么（不是“修复 bug”，而是“HTTP handler 中补全 resp.Body.Close() 防泄漏”）
Why：说明触发修改的直接原因（如“go tool trace 显示 goroutine 数持续上涨”或“日志中出现 http: response.WriteHeader on hijacked connection”）
How：描述关键改动点（例如“在 handleUserRequest 函数入口加 ctx, cancel := context.WithTimeout(r.Context(), 5*time.Second)，并在 defer 中调用 cancel()”）
Test：明确列出覆盖的测试项（如“新增 TestHandleUserRequest_Timeout，验证超时后 ctx.Done() 被监听”）
Related：关联 issue 编号或线上 error ID（如 ISSUE-1234 或 ERR-789012）

评审时优先盯死的 4 类函数签名

别从头读代码。先用 grep -n "func main" *.go、grep -n "func init" *.go、grep -n "http.HandlerFunc" *.go、grep -n "context.With" *.go 定位关键节点：

Alibabacloud Sdk Client Initialization For Golang

初始化并管理阿里云SDK Go 客户端，涵盖 sync.Once 单例、goroutine 安全、endpoint 与 region 配置、VPC 端点及调试。

下载

func main()：查是否有阻塞调用（如 time.Sleep、无 timeout 的 http.ListenAndServe）、全局资源（sql.DB、redis.Client）是否在 main 结束前 close
func init()：查是否有跨包初始化依赖（如 var a = b，而 b 在另一个文件的 init 中定义）、是否调用了未初始化的全局变量
http.HandlerFunc：查是否漏掉 defer resp.Body.Close()、是否用 http.Error 返回 500 却没记录日志、是否直接返回 err 而非包装为 fmt.Errorf("xxx: %w", err)
context.WithCancel/context.WithTimeout：查是否配对 cancel()、cancel() 是否在 defer 中、是否在 goroutine 内部调用 defer cancel()（会导致不执行）

error 处理审查最容易忽略的 3 个细节

Go 的 error 不是字符串拼接，链式行为必须显式维护：

所有自定义 error 类型，如果实现了 Error() 方法，但没实现 Unwrap()，会导致 errors.Is(err, myErr) 永远返回 false
用 fmt.Errorf("%s", err) 包装错误会断开 error 链；必须用 fmt.Errorf("xxx: %w", err)（%w 是唯一能保留链的动词）
函数返回 error 时，若内部有多个 error 来源（如 DB 查询 + HTTP 调用），不能只返回第一个；应统一用 fmt.Errorf("db query failed: %w", dbErr) 或 fmt.Errorf("http call failed: %w", httpErr)，避免掩盖根因

并发与资源释放的硬性检查项

这些不是“建议优化”，是线上事故高频来源，必须逐行确认：

所有 os.Open、http.Get、sql.Query 等返回可关闭资源的调用，必须配 defer xxx.Close()，且 defer 语句必须在资源获取成功后立即写（不能放在 if 分支里漏掉）
所有启动 goroutine 的地方，必须确认 ctx 是否已传入、是否监听 ctx.Done()、是否在退出前清理（如关闭 channel、释放锁）
用 sync.Map 前先问：这个 map 是高频读+极低频写？如果不是，直接用 map + sync.RWMutex 更可控；sync.Map 不支持 len() 和 range，容易引发隐性 bug