Java代码

自动审查Java代码变更,生成结构化报告,标记问题及修复建议,支持多文件批量分析和CI/CD集成。

天轰穿

@thcjp

Install

$ openclaw skills install @thcjp/java-code-reviewer

功能说明: 本技能涵盖 中文交互、化流程场景、识别用户需求并匹配优选处理策略 等核心能力。

Java Code Reviewer

付费版进阶功能

能力免费版付费版
基础功能支持支持
Java Code Reviewer代码审查报告生成不支持支持
代码静态分析与质量评分不支持支持
依赖缺陷检测与升级建议不支持支持
批量代码审查与报告生成不支持支持
CI/CD流水线集成不支持支持

场景介绍

场景输入输出
代码处理源代码文件路径分析报告与修改建议
Git操作仓库路径与分支名操作结果与变更记录
质量审查代码文件与检查规则审查报告与评级

不适用于:需要人工判断的复杂决策场景

使用说明

  1. 用户提供输入:

    • 必填:git diff 输出或需要审查的 Java 源文件
    • 可选:需求文档、技术方案设计文档(用于一致性检查)
  2. 执行审查:

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

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

请求格式

参数名类型必填说明
contentstring否java-code-reviewer处理的内容输入
strict_levelstring否审查严格度, 可选: strict/normal/loose, 默认: normal

响应格式

格式要求

  • 默认输出:Markdown
  • 可选输出:HTML(用户指定时)
输出格式: HTML

报告结构

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

修复建议格式(必须包含)

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

### N. [严重程度] 问题标题
文件:`文件名:行号`
# ...
**问题描述**:
[简短描述问题]
# ...
**问题代码**:
```java
// 完整的修复前代码片段(至少 3 行上下文)

...

修复后代码:

...

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

...

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

...

> ⚠️ **关键要求**:修复前后的代码片段必须是完整的、可运行的代码,不能只是文字描述.
## 运行环境
### 运行环境
- **Agent平台**: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
- **操作系统**: Windows / macOS / Linux

### 依赖说明(补充)
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|:------|------:|:------|:------|
| LLM API | API | 必需 | 由Agent内置LLM提供 |

### API Key 配置
- 

### 可用性分类
- **分类**: MD+execute()
- **说明**: 基于Markdown的AI Skill,

**API Key配置方式**:
```bash
export API_KEY="${API_KEY:?请设置环境变量}"

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

常见疑问

...

Q1: 如何开始使用Java Code Reviewer?

A: 请参考使用流程和依赖说明章节,确保运行环境满足要求后调用本技能。

...

Q2: 遇到错误怎么办?

...

Q3: Java Code Reviewer有什么限制?

...

技术创新

效率提升量化分析

操作步骤手动耗时自动化耗时时间节约准确率提升
代码审查1小时/文件5分钟/文件55分钟/文件10%
问题定位30分钟/问题2分钟/问题28分钟/问题15%
修复建议生成1小时/建议10分钟/建议50分钟/建议5%
报告生成1小时/报告10分钟/报告50分钟/报告10%
总计3.5小时/文件25分钟/文件3小时25分钟/文件10%

差异化对比

对比维度本技能手动操作Python脚本专业软件
审查效率高效,自动化审查低效,人工审查较高效,需要编程高效,但成本高
代码覆盖率宽泛,覆盖常见问题有限,依赖审查者经验有限,依赖审查者经验宽泛,但成本高
报告格式Markdown/HTML文本/PDF文本/CSVPDF/HTML
集成能力易于集成到CI/CD难以集成可集成,但需要编程易于集成,但成本高
成本低高中等高
易用性高低中等高

核心痛点解决

痛点描述影响范围解决方案量化效果
代码审查效率低人工审查耗时,效率低下影响项目进度和质量自动化审查,提高效率时间节约10%
问题定位困难人工审查难以快速定位问题影响开发效率自动化定位,提高效率准确率提升15%
修复建议不全面人工审查建议可能不全面影响代码质量自动化生成修复建议,提高全面性准确率提升5%

安全保障说明

  1. 确保代码审查过程中不泄露敏感信息。
  2. 定期更新审查规则,以应对新出现的代码安全问题。
  3. 限制对代码审查报告的访问权限,防止未授权访问。
  4. 避免在公共代码仓库中存储敏感信息。
  5. 确保代码审查工具本身的安全,防止被恶意利用。

安全风险防范

风险项等级防护措施验证方法
代码泄露高对审查报告进行加密加密测试
恶意代码审查中限制审查权限权限测试
审查规则漏洞中定期更新审查规则漏洞测试
运行时安全高确保运行环境安全安全扫描
数据安全高对敏感数据进行加密加密测试

故障处理体系

针对Java代码使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

Java代码通用排查步骤

  1. 检查输入参数: 确认所有必填参数已提供且格式正确
  2. 查看日志输出: 定位具体错误行和异常类型
  3. 验证环境配置: 确认依赖库版本和运行环境满足要求
  4. 逐步调试: 缩小问题范围,隔离故障模块

Top skills in this category