AI 辅助 Code Review 检查清单：把规范沉淀为可自动校验的规则
一、引言：从人工审查到自动约束
Code Review 是保障代码质量的重要环节，但传统的人工审查存在明显局限：审查者经验不同，检查标准难以统一；重复性的规范检查（如命名规范、代码格式）占用大量时间；人工容易疲劳，导致漏检。
将团队积累的编码规范转化为可自动校验的规则，是提升 Review 效率的关键。AI 大模型的代码理解能力，为这一目标提供了新的实现路径。通过训练或提示词工程，AI 可以自动识别代码中的规范违反、潜在缺陷和安全风险。
更重要的是，AI 不仅能执行规则，还能从代码中学习新的模式，持续优化检查清单。这让 Code Review 从被动检查演进为主动防御。
二、核心方案：AI 驱动的检查规则体系
2.1 规则分层架构
graph TD
A[代码提交] –> B[静态分析工具]
A –> C[AI 代码分析]
B –> D[格式规则]
B –> E[语法规则]
B –> F[依赖规则]
C –> G[逻辑规则]
C –> H[安全规则]
C –> I[架构规则]
C –> J[性能规则]
D –> K[自动修复建议]
E –> K
F –> K
G –> L[人工确认]
H –> L
I –> L
J –> L
K –> M[评论到 PR]
L –> M
基础规则层：格式、语法、依赖等可以通过 ESLint、Prettier 等工具自动检查的规则。
智能规则层：需要理解代码语义的规则，如逻辑错误、安全漏洞、性能陷阱等，适合用 AI 检查。
2.2 规则定义格式
使用结构化格式定义检查规则：
interface CodeReviewRule {
id: string;
name: string;
description: string;
severity: 'error' | 'warning' | 'info';
category: 'style' | 'logic' | 'security' | 'performance' | 'architecture';
language: string[]; // 适用的编程语言
check: (code: string, context: ReviewContext) => Promise<RuleViolation[]>;
autoFixable: boolean;
examples: {
good: string;
bad: string;
};
}
interface RuleViolation {
ruleId: string;
message: string;
line: number;
column: number;
severity: 'error' | 'warning' | 'info';
suggestion?: string;
}
三、实战实现：从规范到自动检查
3.0 场景：代码审查中"重复出现"的同类型问题
在实际 Code Review 中，经常会出现同一类型的审查意见反复出现——"这里又忘记做错误处理"、"变量命名又不一致"。这说明规范被人在 Review 中发现了，但没有被沉淀为自动化规则。AI 的关键价值不在于替代人类审查者的一次性意见，而在于"把今天的审查意见变成明天的自动检查"。
从 Review 评论到规则的模式提取
当审查者在 PR 评论中指出了某个问题，系统应自动尝试将其转化为检查规则。例如：审查者评论说"这个 SQL 查询没有参数化，有 SQL 注入风险"→ AI 提取关键模式 → 生成一条检查规则 → 下次自动标记。
/**
* 从 Review 评论中提取规则模式
*/
async function extractRuleFromReviewComment(comment, codeSnippet, filePath) {
const prompt = `
从以下 Code Review 意见中提取可自动化的检查规则：
审查意见: ${comment}
代码文件: ${filePath}
代码片段:
\\`\\`\\`
${codeSnippet}
\\`\\`\\`
请以 JSON 格式返回：
{
"canAutomate": true/false,
"ruleName": "规则名称",
"patternDescription": "可以自动检测的模式描述",
"suggestedCheck": "建议的检查逻辑（用自然语言描述）",
"autoFixable": true/false
}
如果这个意见涉及业务逻辑判断（如"这个算法不够好"），返回 canAutomate: false。
`;
const response = await callAIModel(prompt);
const result = JSON.parse(response);
if (result.canAutomate) {
// 创建规则草稿，提交给团队审核
await createRuleDraft(result);
// 通知：已为你生成一条自动化规则草稿
await notifyTeam(`从审查意见中提取了一条潜在规则: ${result.ruleName}`);
}
return result;
}
踩坑：AI 规则的误报疲劳
当 AI 规则频繁产生误报时，开发团队会形成"习惯性忽略"——看到 AI 的 Review Comment 直接跳过不看，导致真正的风险被淹没。解决方案是：
3.1 基于 AI 的规则检查器
实现通用的 AI 代码检查框架：
class AICodeReviewer {
private rules: CodeReviewRule[] = [];
registerRule(rule: CodeReviewRule): void {
this.rules.push(rule);
}
async reviewFile(file: SourceFile): Promise<RuleViolation[]> {
const allViolations: RuleViolation[] = [];
for (const rule of this.rules) {
// 检查语言适用性
if (!rule.language.includes(file.language)) {
continue;
}
try {
const violations = await rule.check(file.content, {
fileName: file.name,
imports: file.imports,
exports: file.exports,
ast: file.ast
});
allViolations.push(…violations);
} catch (error) {
console.error(`规则 ${rule.id} 执行失败:`, error);
// 单个规则失败不影响其他规则
}
}
return allViolations;
}
async reviewPullRequest(pr: PullRequest): Promise<ReviewComment[]> {
const comments: ReviewComment[] = [];
for (const file of pr.changedFiles) {
const violations = await this.reviewFile(file);
for (const violation of violations) {
comments.push({
path: file.name,
line: violation.line,
message: this.formatViolationMessage(violation),
severity: violation.severity
});
}
}
return comments;
}
private formatViolationMessage(violation: RuleViolation): string {
let message = `**[${violation.ruleId}]** ${violation.message}`;
if (violation.suggestion) {
message += `\\n\\n建议：${violation.suggestion}`;
}
return message;
}
}
3.2 具体规则实现示例
规则1：检查敏感信息泄露
const noSensitiveInfoRule: CodeReviewRule = {
id: 'no-sensitive-info',
name: '禁止硬编码敏感信息',
description: '代码中不应包含 API Key、密码、Token 等敏感信息',
severity: 'error',
category: 'security',
language: ['javascript', 'typescript', 'python', 'java'],
autoFixable: false,
check: async (code, context) => {
const violations: RuleViolation[] = [];
// 使用 AI 识别敏感信息
const prompt = `
检查以下代码是否包含敏感信息（如 API Key、密码、Token、私钥等）。
文件名：${context.fileName}
代码：
\\`\\`\\`
${code}
\\`\\`\\`
如果发现敏感信息，请以 JSON 格式输出：
[{"line": 1, "message": "…", "suggestion": "使用环境变量或配置文件"}]
如果没有发现，输出 []。
`;
try {
const aiResponse = await callAIModel(prompt);
const findings = JSON.parse(aiResponse);
return findings.map((f: any) => ({
ruleId: 'no-sensitive-info',
message: f.message,
line: f.line,
column: 0,
severity: 'error' as const,
suggestion: f.suggestion
}));
} catch (error) {
console.error('AI 检查失败:', error);
return [];
}
},
examples: {
good: 'const apiKey = process.env.API_KEY;',
bad: 'const apiKey = "sk-1234567890abcdef";'
}
};
规则2：检查错误处理完整性
const completeErrorHandlingRule: CodeReviewRule = {
id: 'complete-error-handling',
name: '异步操作必须包含错误处理',
description: '所有 async/await 或 Promise 调用都应该有 try-catch 或 .catch()',
severity: 'warning',
category: 'logic',
language: ['javascript', 'typescript'],
autoFixable: false,
check: async (code, context) => {
const violations: RuleViolation[] = [];
// 使用 AST 分析
const ast = parseCodeToAST(code);
traverseAST(ast, {
enter(node) {
// 检查 await 表达式是否在 try 块中
if (node.type === 'AwaitExpression') {
const parentTry = findParentOfType(node, 'TryStatement');
if (!parentTry) {
violations.push({
ruleId: 'complete-error-handling',
message: 'await 表达式缺少 try-catch 错误处理',
line: node.loc.start.line,
column: node.loc.start.column,
severity: 'warning',
suggestion: '添加 try-catch 块或使用 .catch()'
});
}
}
// 检查 Promise.then 是否有 .catch
if (node.type === 'CallExpression' && node.callee.type === 'MemberExpression') {
if (node.callee.property.name === 'then') {
const hasCatch = node.parent &&
node.parent.type === 'CallExpression' &&
node.parent.callee.type === 'MemberExpression' &&
node.parent.callee.property.name === 'catch';
if (!hasCatch) {
violations.push({
ruleId: 'complete-error-handling',
message: 'Promise 链缺少 .catch() 错误处理',
line: node.loc.start.line,
column: node.loc.start.column,
severity: 'warning',
suggestion: '在 .then() 后添加 .catch()'
});
}
}
}
}
});
return violations;
},
examples: {
good: 'try { await fetchData(); } catch (error) { console.error(error); }',
bad: 'await fetchData();'
}
};
3.3 与 CI/CD 集成
将 AI Code Review 集成到 GitHub Actions：
# .github/workflows/ai-code-review.yml
name: AI Code Review
on:
pull_request:
types: [opened, synchronize]
jobs:
ai-review:
runs-on: ubuntu-latest
steps:
– uses: actions/checkout@v3
with:
fetch-depth: 0
– name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
– name: Install Dependencies
run: npm ci
– name: Run AI Code Review
env:
AI_API_KEY: ${{ secrets.AI_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
npx ai-code-reviewer \\
–pr-number ${{ github.event.pull_request.number }} \\
–repo ${{ github.repository }} \\
–base-ref ${{ github.event.pull_request.base.sha }} \\
–head-ref ${{ github.event.pull_request.head.sha }}
实现 GitHub PR 评论机器人：
import { GitHub } from '@actions/github';
class GitHubPRReviewer {
private octokit: GitHub;
private repo: { owner: string; repo: string };
constructor(token: string, owner: string, repo: string) {
this.octokit = new GitHub(token);
this.repo = { owner, repo };
}
async postReviewComments(
prNumber: number,
comments: ReviewComment[]
): Promise<void> {
try {
// 创建 Review
const review = await this.octokit.pulls.createReview({
owner: this.repo.owner,
repo: this.repo.repo,
pull_number: prNumber,
commit_id: await this.getHeadCommit(prNumber),
event: 'COMMENT',
comments: comments.map(c => ({
path: c.path,
line: c.line,
body: c.message
}))
});
console.log(`Review 已创建: ${review.data.html_url}`);
} catch (error) {
console.error('评论 PR 失败:', error);
throw new Error(`无法发布 Review 评论: ${error instanceof Error ? error.message : 'GitHub API 错误'}`);
}
}
private async getHeadCommit(prNumber: number): Promise<string> {
const { data } = await this.octokit.pulls.get({
owner: this.repo.owner,
repo: this.repo.repo,
pull_number: prNumber
});
return data.head.sha;
}
}
四、最佳实践与规则管理
4.1 规则优先级管理
不是所有规则都需要强制执行，根据项目阶段调整：
enum RuleEnforcement {
ERROR = 'error', // 阻断合并
WARNING = 'warning', // 提示但不阻断
INFO = 'info', // 仅记录
OFF = 'off' // 禁用
}
interface ProjectRuleConfig {
ruleId: string;
enforcement: RuleEnforcement;
exceptions?: string[]; // 例外的文件或目录
}
const ruleConfig: ProjectRuleConfig[] = [
{ ruleId: 'no-sensitive-info', enforcement: RuleEnforcement.ERROR },
{ ruleId: 'complete-error-handling', enforcement: RuleEnforcement.WARNING },
{ ruleId: 'prefer-const', enforcement: RuleEnforcement.INFO }
];
4.2 规则效果评估
追踪规则的有效性：
interface RuleEffectiveness {
ruleId: string;
triggeredCount: number; // 触发次数
truePositiveRate: number; // 真正率（确实是问题的比例）
falsePositiveRate: number; // 假正率（误报比例）
autoFixedCount: number; // 自动修复次数
dismissedCount: number; // 被忽略的次数
}
async function evaluateRuleEffectiveness(
ruleId: string,
timeRange: { start: Date; end: Date }
): Promise<RuleEffectiveness> {
// 从数据库查询规则触发记录
const records = await db.ruleViolations.findMany({
where: {
ruleId,
createdAt: { gte: timeRange.start, lte: timeRange.end }
}
});
const totalTriggers = records.length;
const truePositives = records.filter(r => r.wasValidIssue).length;
const autoFixed = records.filter(r => r.autoFixed).length;
const dismissed = records.filter(r => r.dismissed).length;
return {
ruleId,
triggeredCount: totalTriggers,
truePositiveRate: totalTriggers > 0 ? truePositives / totalTriggers : 0,
falsePositiveRate: totalTriggers > 0 ? (totalTriggers – truePositives) / totalTriggers : 0,
autoFixedCount: autoFixed,
dismissedCount: dismissed
};
}
4.3 团队规范沉淀流程
建立规范知识库：
interface TeamConvention {
id: string;
title: string;
description: string;
ruleImplementation?: CodeReviewRule;
examples: string[];
createdBy: string;
createdAt: Date;
updatedAt: Date;
}
class ConventionRegistry {
async addConvention(convention: Omit<TeamConvention, 'id' | 'createdAt' | 'updatedAt'>): Promise<void> {
// 将规范存入知识库
const record = await db.conventions.create({
data: {
…convention,
id: generateId(),
createdAt: new Date(),
updatedAt: new Date()
}
});
// 如果提供了规则实现，注册到检查器
if (convention.ruleImplementation) {
reviewer.registerRule(convention.ruleImplementation);
}
// 通知团队
await this.notifyTeam(`新规范已添加: ${convention.title}`);
}
async suggestRuleFromCodeReview(
codeSnippet: string,
issue: string
): Promise<void> {
// 使用 AI 从 Review 评论中提取规范
const prompt = `
从以下代码审查意见中，提取可固化为检查规则的设计规范。
代码片段：
${codeSnippet}
审查意见：
${issue}
请生成规范定义（JSON格式）：
{
"title": "规范标题",
"description": "详细描述",
"ruleImplementation": { … } // 可选，如果可以自动检查
}
`;
const suggestion = await callAIModel(prompt);
// 提交给团队审核
await this.submitForReview(suggestion);
}
}
五、总结与展望
AI 辅助的 Code Review 检查清单，通过将团队规范转化为可自动执行的逻辑，实现了代码质量的系统化保障。这种方式不仅提升了审查效率，更重要的是让规范真正落地，而不是停留在文档中。
核心价值：
未来方向：
- 自适应规则：基于项目特点，自动调整规则严格程度
- 跨项目学习：从多个项目中学习通用规范模式
- 自然语言规则：允许用自然语言定义规则，AI 自动转换为检查逻辑
Code Review 的终极目标不是找错，而是预防错误。当规范成为代码的一部分，质量就有了保障。
让 AI 处理重复性检查，让人专注于创造性讨论。希望本文能优化你的 Code Review 流程。
