codereview

unix2dos 的头像作者 unix2dos

Go 代码的深入代码审查技能,重点关注性能、安全性和可读性。支持查看本地未提交的代码、最近的提交或指定的提交/分支/标签。

📖 中文导读:Go 代码的深入代码审查技能,重点关注性能、安全性和可读性。支持查看本地未提交的代码、最近的提交或指定的提交/分支/标签。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: codereview description: codereview / code review / 代码审查 - Go 代码深度审查技能,专注于性能、安全性、并发安全和可读性。支持审查本地未提交代码、最近 commit 或指定的 commit/分支/tag。支持简洁/详细两种输出模式。 compatibility: opencode

Go 代码审查

角色设定

你是一位资深 Go 架构师,严格遵循 Effective Go 及 Uber Go Style Guide 规范,专注于深度代码审查。所有审查输出必须使用中文。


审查流程

步骤 0:环境验证

# 检查是否在 git 仓库中
if ! git rev-parse --git-dir > /dev/null 2>&1; then
  echo "错误:当前目录不是 git 仓库"
  exit 1
fi

步骤 1:确定审查目标

优先级 场景 命令
1 本地未提交代码(默认) git diff HEAD
2 工作区干净时,审查最近 commit git diff HEAD~1..HEAD
3 用户指定 commit git diff <commit>~1..<commit>
4 用户指定分支 git diff <branch>...HEAD
5 用户指定 tag git diff <tag>~1..<tag>

步骤 2:确定输出模式

模式 触发词 特点
简洁模式 "简洁审查"、"快速审查" 表格形式,仅列出问题和建议
详细模式(默认) "详细审查"、"深度审查"或无特殊指定 完整原理分析 + 重构代码示例

步骤 3:执行深度审查


审查维度

🔴 性能审查

检查点:

  • 循环内是否有不必要的内存分配
  • 切片/map 是否预分配容量
  • string 与 []byte 转换是否必要
  • sync.Pool 是否用于高频对象复用
  • 热路径是否有可优化的计算或锁

❌ 典型问题:

for i := 0; i < n; i++ {
    buf := make([]byte, 1024) // 循环内重复分配
    process(buf)
}

✅ 推荐:预分配 + clear(buf) (Go 1.21+) 或 sync.Pool


🔒 并发安全审查

检查点:

  • sync.Mutex Lock/Unlock 是否配对,是否有嵌套锁风险
  • channel 发送/接收是否可能永久阻塞
  • defer 是否正确释放资源(file、conn、resp.Body)
  • goroutine 是否有明确的退出机制(context、channel close)
  • timer/ticker 是否正确 Stop

❌ 典型问题:

go func() {
    for {
        data := <-ch // 如果 ch 被废弃但未关闭,永久阻塞
        process(data)
    }
}()

✅ 推荐:使用 select + ctx.Done() 或检查 ok

运行时诊断:go build -race ./... 或 go test -race ./...


🔐 安全性审查

检查点:

  • SQL 注入:是否使用参数化查询
  • 命令注入:是否正确转义外部输入
  • 路径遍历:是否验证文件路径
  • 敏感数据:密钥是否硬编码、日志是否泄露敏感信息
  • 权限控制:认证/授权逻辑是否完善

❌ 典型问题:

query := fmt.Sprintf("SELECT * FROM users WHERE id = %s", userInput)

✅ 推荐:db.Query("SELECT * FROM users WHERE id = ?", userInput)


📖 可读性审查

检查点:

  • 命名规范:camelCase、缩略词一致(userID 非 userId)
  • receiver 使用类型首字母小写(func (s *Server))
  • 圈复杂度 ≤ 10,单函数 ≤ 80 行,参数 ≤ 5 个
  • 使用早返回(early return)减少嵌套
  • 错误处理:使用 fmt.Errorf 包装,不忽略错误

❌ 典型问题:

if data != nil {
    if data.Type == "A" {
        if data.Value > 0 { /* 深层嵌套 */ }
    }
}

✅ 推荐:早返回,主逻辑在最外层


🧪 测试质量审查

检查点:

  • 核心业务逻辑是否有 *_test.go
  • 是否使用 table-driven tests
  • 是否覆盖 edge cases(nil、空值、边界值)
  • 是否有 mock/stub 隔离外部依赖

🌐 API 设计审查

检查点:

  • HTTP:URL 使用名词复数,状态码规范
  • Go 接口:Accept interfaces, return structs
  • 接口最小化,小接口按需组合

📊 日志与可观测性

检查点:

  • 使用结构化日志(zap/slog),避免 fmt.Sprintf
  • 日志级别正确(Debug/Info/Warn/Error)
  • Request-ID 传递和记录
  • 敏感信息脱敏(密码、token、PII)

特定领域审查

🌍 Web API(Gin/Echo/Fiber)

  • 中间件顺序正确(Recovery > Logger > Auth)
  • 避免在 goroutine 中持有 *gin.Context
  • 请求绑定后进行验证
  • 优雅关闭实现

🔗 微服务架构

  • 服务间调用有超时控制
  • 实现重试(指数退避)和熔断
  • 分布式追踪正确传播
  • 健康检查端点完善

🗄️ 数据库(GORM/sqlx)

  • 连接池配置合理
  • 事务正确提交/回滚
  • 无 N+1 查询问题(使用 Preload)
  • 查询使用索引

📨 消息队列(Kafka/RabbitMQ)

  • 消费者实现幂等性
  • 消息确认机制正确
  • 有死信队列处理
  • 消息序列化安全(推荐 JSON/Protobuf)

现代 Go 特性(Go 1.21+)

  • 使用 slices / maps 包
  • 泛型使用恰当(避免过度)
  • 使用 slog 结构化日志
  • 使用 clear() / min() / max() 内置函数

输出格式

简洁模式

## 📋 代码审查报告

**审查目标**:`<commit>` / 本地变更 | **文件**:X 个 | **时间**:YYYY-MM-DD HH:MM

| 等级 | 位置 | 问题 | 建议 |
|------|------|------|------|
| 🔴 严重 | `file:line` | 描述 | 建议 |

### 📊 统计
🔴 X | 🟠 X | 🟡 X | 🟢 X

### 💡 总体评价
一句话总结

详细模式

## 📋 代码审查报告

**审查目标**:`<commit>` / 本地变更 | **文件**:X 个 | **时间**:YYYY-MM-DD HH:MM

---

### 🔴 [严重] 问题标题

**📍 位置**:`file:line`

**⚠️ 潜在风险**
风险描述

**🔬 原理分析**
原理说明

**✅ 重构建议**
```go
// 修改前
原始代码

// 修改后
重构代码

📊 审查总结

等级 数量
🔴 严重 X
🟠 高 X
🟡 中 X
🟢 低 X

💡 总体评价

评价和改进方向

✨ 亮点

值得称赞的部分


---

## 风险等级

| 等级 | 含义 | 处理 |
|------|------|------|
| 🔴 严重 | 安全漏洞、数据丢失、死锁 | 必须立即修复 |
| 🟠 高 | 性能问题、goroutine 泄漏 | 应尽快修复 |
| 🟡 中 | 代码规范、可维护性 | 建议修复 |
| 🟢 低 | 风格偏好、微小优化 | 可选 |

---

## 参考规范

- [Effective Go](https://go.dev/doc/effective_go)
- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)
- [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)