Java 代码审查报告生成器

快速开始

1. 用户提供输入：

   • 必填：git diff 输出或需要审查的 Java 源文件
   • 可选：需求文档、技术方案设计文档（用于一致性检查）

2. 执行审查：

   • 加载审查规则 references/rules.md
   • 按 6 个维度逐项检查
   • 标记问题及严重程度

3. 生成报告：

   • 使用 assets/report-template.md 模板
   • 输出 Markdown 或 HTML 格式

审查维度

严重程度定义

输出格式

格式要求

• 默认输出：Markdown
• 可选输出：HTML（用户指定时）

输出格式: HTML

报告结构

1. 概述（审查文件数、问题统计）
2. 问题列表（按 Critical → Major → Minor → Suggestion 排序）
3. 修复建议（含代码对比）
4. 一致性检查（如果提供了需求/设计文档）

修复建议格式（必须包含）

每个问题必须包含以下结构：

### N. [严重程度] 问题标题
文件：`文件名:行号`

**问题描述**：
[简短描述问题]

**问题代码**：
```java
// 完整的修复前代码片段（至少 3 行上下文）

修复后代码：

// 完整的修复后代码片段（必须可运行）

参考规则：[对应规则编号和名称]

> ⚠️ **关键要求**：修复前后的代码片段必须是完整的、可运行的代码，不能只是文字描述。

## 使用示例

**用户输入**：

审查以下代码变更： [git diff 输出]

**系统输出**：

Java 代码审查报告

概述

• 审查文件：3 个
• 问题总数：5 个
  • Critical: 1
  • Major: 2
  • Minor: 2

问题详情

1. [Critical] 未释放数据库连接

文件：UserService.java:45

问题描述： 在方法中获取了数据库连接但未确保关闭。

问题代码：

public User findById(Long id) {
    Connection conn = dataSource.getConnection(); // 未关闭
    // ...
}

修复建议： 使用 try-with-resources 确保资源释放。

修复后代码：

public User findById(Long id) {
    try (Connection conn = dataSource.getConnection()) {
        // ...
    } // 自动关闭
}

... (更多问题)

## 审查规则

详细规则见 `references/rules.md`，包含：
- Google Java Style Guide 精简版（10条）
- 阿里巴巴 Java 开发手册 精简版（10条）
- Clean Code 原则 精简版（10条）

## 报告模板

默认模板见 `assets/report-template.md`。

如需自定义输出格式或添加额外检查项，修改模板文件。