企业级 Java 代码审查方案,支持批量审查、自定义规则、HTML 报告与 CI 集成。
本工具面向企业级 Java 开发团队,提供代码审查的完整治理方案是一项面向实际任务的技能,主要用于在免费版 6 大维度审查、4 级严重程度、修复建议能力之上,专业版新增批量多文件审查、自定义规则引擎、HTML 结构化报告、需求一致性检查、OWASP 安全审计、CI/CD 质量门禁等能力;通过可配置的规则引擎与数据驱动的质量度量,帮助团队建立可量化、可追踪的代码质量体系;
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
本工具面向企业级 Java 开发团队,提供代码审查的完整治理方案。在免费版 6 大维度审查、4 级严重程度、修复建议能力之上,专业版新增批量多文件审查、自定义规则引擎、HTML 结构化报告、需求一致性检查、OWASP 安全审计、CI/CD 质量门禁等能力。通过可配置的规则引擎与数据驱动的质量度量,帮助团队建立可量化、可追踪的代码质量体系。
版本兼容性说明:专业版完全兼容免费版(java-reviewer-tool-free)的所有审查维度、规则与报告格式,可无缝升级。
| 能力模块 | 免费版 | 专业版新增 |
|---|---|---|
| 审查范围 | 单文件/diff | 批量多文件/多模块/全项目 |
| 审查规则 | 内置固定规则 | 自定义规则 + 团队配置 |
| 报告格式 | Markdown | Markdown + HTML + JSON |
| 需求检查 | - | 需求/设计文档一致性检查 |
| 安全审计 | 基础安全检查 | OWASP Top 10 全面审计 |
| CI 集成 | - | 质量门禁 + 合并请求拦截 |
| 趋势追踪 | - | 历史报告对比与质量趋势 |
| 修复建议 | 代码片段 | 批量自动修复脚本 |
用input_params参数进行配置。
输入: 用户提供核心功能执行所需的指令和必要参数。 处理: 按照skill规范执行核心功能执行操作,遵循单一意图原则。 输出: 返回核心功能执行的执行结果,包含操作状态和输出数据。
input_params参数,支持创建/查询/导出操作用config_options参数进行配置。
输入: 用户提供参数配置与调用所需的指令和必要参数。 处理: 按照skill规范执行参数配置与调用操作,遵循单一意图原则。 输出: 返回参数配置与调用的执行结果,包含操作状态和输出数据。
config_options参数,支持修改/重置/导入操作用output_format参数进行配置。
输入: 用户提供结果处理与输出所需的指令和必要参数。 处理: 按照skill规范执行结果处理与输出操作,遵循单一意图原则。 输出: 返回结果处理与输出的执行结果,包含操作状态和输出数据。
output_format参数,支持导出/保存/转换操作
能力覆盖范围:本skill的核心能力覆盖以下场景关键词:企业级、Java、代码审查方案、支持批量审查、报告与、面向企业级、开发团队的代码审、查治理工具、Use、when、需要代码生成、编程辅助、调试测试、开发部署时使用、不适用于无明确技、术栈的模糊需求、适用于独立开发者、企业团队和自动化、工作流场景等。这些关键词对应description中声明的使用场景,均已在上述能力点中提供对应的操作支持。团队需要对整个项目进行全面的代码审查。
#!/bin/bash
PROJECT_DIR=$1
REPORT_DIR="reports/java-review-$(date +%Y%m%d)"
mkdir -p "$REPORT_DIR"
echo "=== Java 批量代码审查 ==="
echo "项目目录: $PROJECT_DIR"
echo "报告目录: $REPORT_DIR"
echo ""
JAVA_FILES=$(find "$PROJECT_DIR" -name "*.java" -not -path "*/test/*")
FILE_COUNT=$(echo "$JAVA_FILES" | wc -l)
echo "审查文件数: $FILE_COUNT"
TOTAL_ISSUES=0
CRITICAL=0
MAJOR=0
MINOR=0
SUGGESTION=0
cat > "$REPORT_DIR/summary.md" << 'EOF'
EOF
echo "| 指标 | 数值 |" >> "$REPORT_DIR/summary.md"
echo "| --- | --- |" >> "$REPORT_DIR/summary.md"
echo "| 审查日期 | $(date) |" >> "$REPORT_DIR/summary.md"
echo "| 审查范围 | $PROJECT_DIR |" >> "$REPORT_DIR/summary.md"
echo "| 文件数量 | $FILE_COUNT |" >> "$REPORT_DIR/summary.md"
echo "$JAVA_FILES" | while read file; do
REL_PATH=${file#$PROJECT_DIR/}
SQL_INJECTION=$(grep -n "String sql.*+.*"" "$file" | head -5)
if [ -n "$SQL_INJECTION" ]; then
echo "[Critical] $REL_PATH: 可能的 SQL 注入" >> "$REPORT_DIR/issues.md"
echo "$SQL_INJECTION" >> "$REPORT_DIR/issues.md"
fi
HARDCODED_PWD=$(grep -in "password.*=.*"|secret.*=.*"" "$file" | head -5)
if [ -n "$HARDCODED_PWD" ]; then
echo "[Critical] $REL_PATH: 硬编码密码/密钥" >> "$REPORT_DIR/issues.md"
echo "$HARDCODED_PWD" >> "$REPORT_DIR/issues.md"
fi
EMPTY_CATCH=$(awk '/catch.*{/{flag=1;next}/}/{if(flag && NR-prev<3) print FILENAME":"prev; flag=0}flag{prev=NR}' "$file")
if [ -n "$EMPTY_CATCH" ]; then
echo "[Major] $REL_PATH: 空 catch 块" >> "$REPORT_DIR/issues.md"
echo "$EMPTY_CATCH" >> "$REPORT_DIR/issues.md"
fi
UNCLOSED=$(grep -n "new FileInputStream|new FileOutputStream|getConnection" "$file" | grep -v "try.*(" | head -5)
if [ -n "$UNCLOSED" ]; then
echo "[Major] $REL_PATH: 资源可能未正确关闭" >> "$REPORT_DIR/issues.md"
echo "$UNCLOSED" >> "$REPORT_DIR/issues.md"
fi
LONG_METHODS=$(awk '/public|private|protected.*(/{start=NR;name=$0}/^}/{if(NR-start>50) print FILENAME":"start"-"NR" ("NR-start"行) "name; start=0}' "$file")
if [ -n "$LONG_METHODS" ]; then
echo "[Minor] $REL_PATH: 方法过长" >> "$REPORT_DIR/issues.md"
echo "$LONG_METHODS" >> "$REPORT_DIR/issues.md"
fi
done
echo ""
echo "=== 审查完成 ==="
echo "报告位置: $REPORT_DIR/"
团队需要根据项目特点自定义审查规则。
version: "2.0"
team: "后端开发组"
updated: "2026-07-18"
extends: "default"
rules:
naming:
max_method_length: 40 # 比默认 50 更严格
max_parameter_count: 4 # 方法参数上限
required_class_suffix: # 类名后缀要求
controller: "Controller"
service: "Service"
repository: "Repository"
dto: "DTO"
security:
owasp_top_10: true # 启用 OWASP Top 10 检查
forbidden_apis: # 禁止使用的 API
- "System.out.println" # 禁止直接控制台输出
- "Runtime.getRuntime" # 禁止直接执行命令
- "ObjectInputStream" # 禁止反序列化
required_validation: # 必须校验的输入
- "RequestMapping"
- "PostMapping"
- "GetMapping"
performance:
warn_collection_init: true # 集合未指定初始容量时告警
warn_string_concat: true # 循环内字符串拼接告警
max_query_count: 5 # 单个请求最大查询数
design:
max_cyclomatic_complexity: 10 # 最大圈复杂度
max_class_length: 500 # 最大类行数
require_di_pattern: true # 依赖注入模式
excludes:
- "**/test/**"
- "**/generated/**"
- "**/legacy/**"
- "**/dto/**" # DTO 类只检查命名
severity_override:
empty_catch: critical # 空 catch 提升为 Critical
magic_number: minor # 魔法值降为 Minor
report:
formats: ["markdown", "html", "json"]
output_dir: "reports/"
include_metrics: true
include_trend: true
合并请求需要通过代码审查才能合并。
name: Java 代码质量门禁
on:
pull_request:
branches: [main, develop]
jobs:
code-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # 获取完整历史用于 diff
- name: 安装 Java
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
- name: 执行代码审查
run: |
./scripts/batch-java-review.sh src/
- name: 检查 Critical 问题数
run: |
CRITICAL_COUNT=$(grep -c "[Critical]" reports/java-review-*/issues.md || echo 0)
echo "Critical 问题数: $CRITICAL_COUNT"
if [ "$CRITICAL_COUNT" -gt 0 ]; then
echo "::error::发现 $CRITICAL_COUNT 个 Critical 问题,阻止合并"
exit 1
fi
- name: 检查 Major 问题数
run: |
MAJOR_COUNT=$(grep -c "[Major]" reports/java-review-*/issues.md || echo 0)
echo "Major 问题数: $MAJOR_COUNT"
if [ "$MAJOR_COUNT" -gt 5 ]; then
echo "::warning::Major 问题数超过 5 个,建议修复后再合并"
fi
- name: 上传审查报告
if: always()
uses: actions/upload-artifact@v4
with:
name: java-review-report
path: reports/
- name: 评论审查结果
if: always()
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const report = fs.readFileSync('reports/java-review-*/summary.md', 'utf8');
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `## 代码审查报告nn${report}`
});
| OWASP 类别 | 检查项 | 检测方法 |
|---|---|---|
| 注入 | SQL 注入 | 检查字符串拼接 SQL |
| 注入 | 命令注入 | 检查 Runtime.exec 调用 |
| 认证失效 | 硬编码凭据 | 搜索 password/secret 赋值 |
| 敏感数据暴露 | 明文传输 | 检查 HTTP 连接(非 HTTPS) |
| XML 外部实体 | XXE 漏洞 | 检查 XML 解析器配置 |
| 访问控制失效 | 缺少权限校验 | 检查 Controller 方法注解 |
| 安全配置错误 | 调试信息泄露 | 检查异常信息直接返回前端 |
| XSS | 未转义输出 | 检查响应输出是否转义 |
| 不安全反序列化 | 反序列化漏洞 | 检查 ObjectInputStream |
| 已知漏洞组件 | 依赖漏洞 | 扫描依赖版本 |
Java 代码审查报告
Java 代码审查报告
审查日期: {{date}}
审查范围: {{scope}}
文件数量: {{file_count}}
问题总数: {{total_issues}}
- Critical: {{critical_count}}
- Major: {{major_count}}
- Minor: {{minor_count}}
- Suggestion: {{suggestion_count}}
问题趋势
问题详情
| 序号 | 严重程度 | 文件 | 行号 | 维度 | 问题描述 | 规则 |
|---|---|---|---|---|---|---|
| {{index}} | {{severity}} | {{file}} | {{line}} | {{dimension}} | {{description}} | {{rule_id}} |
审查时提供需求文档,工具会检查代码实现与需求的一致性 输入: 1. git diff 输出 2. 需求文档(可选) 3. 设计文档(可选) 一致性检查项: - 需求中的功能点是否都已实现 - 代码改动是否超出需求范围 - 接口设计是否与文档一致 - 数据结构是否与设计匹配 输出: - [已实现] 用户注册接口(需求 3.1) - [已实现] 邮箱验证功能(需求 3.2) - [未实现] 手机号注册(需求 3.3)← 需关注 - [超范围] 修改了登录逻辑(不在需求范围内)
#!/bin/bash echo "日期,Critical,Major,Minor,Suggestion,总文件数" > quality-trend.csv for report in reports/java-review-*/summary.md; do date=$(echo $report | grep -o '[0-9]*' | head -1) critical=$(grep -c "Critical:" "$report" 2>/dev/null || echo 0) major=$(grep -c "Major:" "$report" 2>/dev/null || echo 0) minor=$(grep -c "Minor:" "$report" 2>/dev/null || echo 0) suggestion=$(grep -c "Suggestion:" "$report" 2>/dev/null || echo 0) files=$(grep "文件数量" "$report" | grep -o '[0-9]*') echo "$date,$critical,$major,$minor,$suggestion,$files" >> quality-trend.csv done echo "趋势数据已保存到 quality-trend.csv"
CI 强制门禁:Critical 问题数为 0 才允许合并
规则版本管理:规则配置纳入 Git 版本控制
定期全项目审查:每周/每迭代执行全项目审查
趋势数据驱动:用历史数据追踪改进效果
安全审计上线前必做:OWASP Top 10 检查
需求一致性检查:对照需求文档审查实现范围
报告归档对比:保留历史报告用于趋势分析
规则渐进引入:新规则先警告后强制
excludes: - "**/test/**" # 排除测试代码 - "**/generated/**" # 排除生成代码 - "**/migration/**" # 排除迁移脚本 severity_override: magic_number: suggestion # 魔法值降为建议
策略: 1. 先生成完整报告,评估问题规模 2. 按严重程度排序,优先修复 Critical 3. 将修复任务拆分到多个迭代 4. 新代码必须完全合规(增量控制) 5. 老代码设定改进目标(如每迭代减少 20%)
./scripts/export-sonarqube.sh reports/java-review-latest/ > sonar-issues.json
[
{
"rule": "java:S2077",
"severity": "BLOCKER",
"message": "SQL 注入风险",
"component": "src/main/java/UserService.java",
"line": 45
}
]
| 指标 | 计算方式 | 目标值 |
|---|---|---|
| Critical 密度 | Critical 数 / 千行 | 0 |
| Major 密度 | Major 数 / 千行 | < 2 |
| 代码合规率 | (1 - 问题文件数 / 总文件数) × 100% | > 95% |
| 平均修复时间 | 问题提出到修复的天数 | < 3 天 |
| 重复代码率 | 重复行数 / 总行数 | < 5% |
echo "=== OWASP 安全审计 ===" echo "检查 SQL 注入..." grep -rn "String sql.*+.*"" src/ --include="*.java" echo "检查硬编码凭据..." grep -rn "password.*=.*"|secret.*=.*"" src/ --include="*.java" echo "检查明文传输..." grep -rn "http://" src/ --include="*.java" | grep -v "https://" echo "检查反序列化..." grep -rn "ObjectInputStream|readObject" src/ --include="*.java" echo "检查依赖漏洞..." mvn dependency-check:check 2>/dev/null || echo "需要安装 dependency-check 插件"
#!/bin/bash
find src/ -name "*.java" -exec sed -i
's/System.out.println((.*))/logger.info(1)/g' {} ;
find src/ -name "*.java" -exec grep -l "status == 1|status == 0" {} ; |
while read f; do
echo "建议在 $f 中提取状态常量"
done
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|---|---|---|---|
| JDK | 编译器/运行时 | 推荐 | oracle.com 或 openjdk.net 下载 |
| Git | 命令行工具 | 必需 | 系统包管理器安装 |
| Maven/Gradle | 构建工具 | 可选 | maven.apache.org / gradle.org |
| OWASP Dependency-Check | 安全扫描 | 可选 | mvn dependency-check:check |
| jq | JSON 处理 | 可选 | 系统包管理器安装 |
| LLM API | API | 必需 | 由 Agent 内置 LLM 提供 |
| 错误场景 | 原因 | 处理方式 |
|---|---|---|
| 配置错误 | 参数缺失或格式错误 | 检查依赖说明中的配置要求 |
| 运行时错误 | 运行环境不满足 | 确认运行环境符合依赖说明 |
| 网络错误 | 连接超时或不可达 | 执行ping命令测试网络连通性,检查防火墙和代理设置连接后执行ping命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令,参考国内替代方案 |
相关专题
热门下载
相关下载
精品课程
共0课时 | 0人学习
共0课时 | 0人学习
共0课时 | 0人学习
最新文章