AI 代码评审功能指南

AI 代码评审是基于 Claude Code Agent SDK 的自动化代码审查功能。系统连接 Git 仓库,分析指定时间范围内的代码提交,自动识别潜在问题并生成结构化的评审报告。

整体流程

flowchart LR
    A[创建评审任务] --> B[配置 Git 仓库和分支]
    B --> C[执行评审]
    C --> D[克隆仓库并分析代码]
    D --> E[生成 Markdown 报告]

前置条件

使用 AI 代码评审功能前,需要完成以下准备工作:

  1. 安装 Claude Code CLI:参考 Claude Code 正确的安装方式 完成安装和供应商配置
  2. 开通 AI 套餐:确保已开通 AI 服务套餐
  3. 配置模型供应商:通过 CC-Switch 或环境变量配置好可用的 API 中转服务

功能背景

代码评审(Code Review)是保障代码质量的关键环节,但传统的人工评审存在以下问题:

  • 评审效率低,大量提交积压时容易敷衍了事
  • 评审标准不统一,依赖个人经验和偏好
  • 难以覆盖所有维度,如安全漏洞、性能隐患、编码规范等
  • 跨时区团队协作时评审响应滞后

AI 代码评审通过 Claude Code 自动分析 Git 仓库中的代码变更,从安全性、性能、规范性、可维护性等多个维度进行全面审查,生成标准化的评审报告。

flowchart LR
    A[PIGX 平台] --> B[Claude Code]
    B --> C[克隆 Git 仓库]
    C --> D[分析代码变更]
    D --> E[生成评审报告]
    E --> F[SSE 流式返回]

使用指南

AI 代码评审任务列表

创建评审任务

进入 AI 代码评审 页面,点击「新增」按钮创建评审任务。

任务配置字段说明:

字段说明示例
任务名称评审任务的标识名称,系统内唯一writer-agent-日常评审
Git 地址仓库的 SSH 或 HTTPS 克隆地址git@github.com:user/repo.git
分支需要评审的目标分支main
时间范围分析的提交时间区间最近1小时、今天、自定义等
启用状态是否启用该任务启用/停用

Git 仓库认证

系统根据 Git 地址格式自动识别协议类型,并显示对应的认证配置:

SSH 协议git@ssh:// 开头):

  • 填写 SSH 私钥内容,用于仓库克隆认证
  • 编辑模式下如不修改私钥可保持原样

HTTPS 协议http://https:// 开头):

  • 填写用户名和密码(或 Personal Access Token)
  • 推荐使用 Token 替代密码,安全性更高
认证安全

Git 地址在任务列表中会自动脱敏显示,隐藏用户名等敏感信息。SSH 私钥和密码在编辑时以掩码形式展示,未修改则不会覆盖原有凭证。

执行评审

在任务列表中点击「执行」按钮,打开实时评审弹窗。点击「开始评审」后,系统通过 SSE 连接实时展示评审过程。

评审界面分为三个区域:

  • 顶部信息栏:显示 Git 地址、分支、时间范围、当前状态和进度条
  • 左侧执行日志:实时展示 AI 的工具调用过程,包括仓库克隆、提交记录查询、文件读取、代码搜索等操作
  • 右侧评审报告:以 Markdown 格式流式输出评审结果
执行过程

评审过程中 AI 会自动执行以下操作:克隆目标仓库、切换到指定分支、查询时间范围内的提交记录、读取变更文件、搜索潜在问题(TODO/FIXME/安全隐患等),最终生成结构化报告。

查看历史报告

点击任务列表中的「报告」按钮,打开全屏抽屉查看历史评审记录。

  • 左侧:按时间倒序展示所有执行记录,每条记录显示执行时间、成功/失败状态、耗时,以及提交数量和代码增删行数统计
  • 右侧:选中某条记录后展示完整的 Markdown 评审报告

支持单条删除和批量删除执行记录。

评审报告内容

AI 生成的评审报告通常包含以下内容:

报告模块内容
概览分析文件数、代码行数、发现问题数、优化建议数
提交记录时间范围内的 commit 列表,包含哈希、作者、时间、信息
问题分析逐项列出发现的问题,标注文件路径、行号和修复建议
优化建议测试覆盖、异常处理、日志规范、依赖管理等改进方向
评审结论整体代码质量评估和优先修复事项
仓库访问权限

请确保配置的认证信息具有目标仓库的读取权限。评审过程中 AI 会克隆仓库到服务器临时目录,任务完成后自动清理。