Java手册

基于阿里巴巴Java开发手册，涵盖编程规约、安全、异常日志、单元测试、数据库、工程结构及设计规范的开发指南。

核心功能: 本技能提供化工作流场景等能力。

Java Development Man

付费版进阶功能

能力	免费版	付费版
基础功能	支持	支持
深度漏洞扫描与CVE关联	不支持	支持
安全基线合规审计	不支持	支持
批量资产风险评分	不支持	支持
威胁情报实时订阅与告警	不支持	支持
零日漏洞检测与防护规则下发	不支持	支持

功能能力

本手册基于阿里巴巴Java开发手册（嵩山版），将规约分为7个维度。规约按约束力强弱分为：

级别	含义	说明
【强制】	必须遵守	违反可能导致严重问题
【推荐】	建议遵守	提升代码质量和可维护性
【参考】	可选择性采纳	根据实际情况判断

开始使用

1. 确认运行环境满足依赖说明中的要求
2. 在AI Agent对话中调用本技能,提供必要的输入参数
3. 检查输出结果,根据需要进行后续处理

详细的输入输出格式请参考下方章节说明。

适用范围

1. 命名检查 → 查看 coding-convention.md 的"命名风格"章节
2. 并发问题 → 查看 [coding-convention.md&ownerHandle=shinelon) 的"并发处理"章节
3. 异常处理 → 查看 [exception-log.path=references%2Fexception-log.md&ownerHandle=shinelon)
4. 安全问题 → 查看 [security.path=references%2Fsecurity.md&ownerHandle=shinelon)

使用指南

Step 1: 内容解析

按审查标准执行检查 解析待审查内容, 提取以下要素:

• 关键要素: 关键要素

Step 2: 逐项检查

按审查标准执行检查 按照 references/checklist.md 中的检查清单逐项审查:

检查项	检查方法	通过标准
代码风格	多维度审查	符合标准
安全合规	多维度审查	符合标准
无障碍性	多维度审查	符合标准

Step 3: 评级判定

按审查标准执行检查 根据检查结果评定等级:

• A级(优秀): 符合标准
• B级(良好): 符合标准
• C级(及格): 符合标准
• D级(不及格): 符合标准

Step 4: 生成报告

按审查标准执行检查 输出审查报告, 包含: 总评/各项详情/改进建议/优先级排序.

参数说明

参数名	类型	必填	说明
content	string	否	java-development-manual处理的内容输入
strict_level	string	否	审查严格度, 可选: strict/normal/loose, 默认: normal

结果格式

json

{
  "success": true,
  "data": {
    "overall_grade": "A",
    "total_score": 92,
    "max_score": 100,
    "summary": "处理完成",
    "details": [
      {
        "item": "代码风格",
        "status": "pass",
        "score": 95,
        "comment": "符合规范"
      },
      {
        "item": "安全合规",
        "status": "warn",
        "score": 80,
        "comment": "符合规范"
      }
    ],
    "improvements": [
      {
        "priority": "high",
        "suggestion": "建议优化",
        "expected_gain": "+5分"
      },
      {
        "priority": "medium",
        "suggestion": "建议优化",
        "expected_gain": "+3分"
      }
    ]
  },
  "error": null
}

错误恢复方案

错误场景	原因	处理方式
待审查内容为空	用户未提供内容	提示用户提供待审查的代码
内容格式不识别	传入不支持的内容格式	列出支持的格式, 建议转换后
检查项超出范围	传入了不存在的检查维度	列出可用检查维度, 使用默认全部检查
审查超时	内容过长导致处理超时	建议分段审查, 每段不超过5000字
其他异常	内部处理异常	检查输入后

安装与配置

运行环境

• 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应妥善保管,避免泄露到版本控制系统.

案例展示

示例1：基础用法

text

### 代码审查场景
# ...
1.md&ownerHandle=shinelon) 的"命名风格"章节
2.md&ownerHandle=shinelon) 的"并发处理"章节
3.md&ownerHandle=shinelon)

问答汇总

Q1: 如何开始使用Java Development Man？

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

常见问题FAQ

Q1: Java手册中的“编程规约”具体包含哪些内容？

A: Java手册中的“编程规约”包括命名规范、代码格式、注释规范、异常处理、集合类使用、日期时间处理、多线程并发等。

Q2: 如何在Java手册中查找特定数据库操作的优选实践？

A: 在“MySQL数据库”章节中，可以通过搜索关键词或浏览目录来查找特定数据库操作的优选实践。

Q3: Java手册中如何处理单元测试的覆盖率问题？

A: 在“单元测试”章节中，提供了单元测试覆盖率的标准、测试用例设计方法以及如何提高测试覆盖率。

Q4: 在Java手册中，如何找到关于安全编码的优选实践？

A: 在“安全规约”章节中，详细介绍了各种安全编码的优选实践，包括防止SQL注入、XSS攻击、CSRF攻击等。

Q5: Java手册中是否有关于工程结构的建议？

A: 在“工程结构”章节中，提供了关于项目目录结构、模块划分、依赖管理等方面的建议。

问题处理指引

错误现象	可能原因	诊断步骤	解决方案
报错：无法解析配置参数	配置参数错误或缺失	检查配置文件，确保参数正确无误	修正配置文件，重新运行
报错：代码风格检查失败	代码不符合规范	检查代码，确保符合Java手册中的编程规约	修改代码，使其符合规范
报错：数据库连接失败	数据库连接信息错误	检查数据库连接信息，确保正确无误	修正数据库连接信息，重新连接
报错：单元测试未通过	单元测试用例编写错误	检查单元测试用例，确保正确无误	修改单元测试用例，重新运行
报错：安全检查未通过	代码存在安全风险	检查代码，确保符合安全规约	修改代码，消除安全风险

安全提示

风险项	等级	防护措施	验证方法
SQL注入	高	使用预处理语句或参数化查询	检查数据库访问日志，确保无SQL注入攻击
XSS攻击	高	对用户输入进行编码和转义	使用XSS检测工具进行测试
CSRF攻击	高	使用CSRF令牌验证	检查CSRF令牌是否正确生成和验证
未授权访问	高	限制访问权限，使用认证和授权机制	定期检查访问日志，确保无未授权访问
数据泄露	高	加密敏感数据，限制数据访问	定期进行数据泄露检测
代码注入	高	对用户输入进行验证和过滤	使用代码注入检测工具进行测试

技术创新

效率提升量化分析
代码审查时间缩短
安全漏洞修复时间缩短
单元测试覆盖率提高
项目维护成本降低
开发效率提升

差异化对比表格
特点
:-----------------
规约全面性
安全性
实用性
易用性
社区支持

功能介绍

• 自动化执行: Java开发手册规约集合，基于阿里巴巴Java开发手册（嵩山版）。 涵盖7大维度：编程规约、异常日志、单元测试、安全规约
• 文件处理: 支持多种文件格式的读取、解析和写入操作
• API集成: 通过标准化接口调用外部服务并处理响应
• 命令执行: 在安全沙箱中执行系统命令并收集结果
• 信息检索: 快速搜索和过滤目标数据

效率量化分析

操作场景	手动耗时	自动化耗时	效率提升
文件解析与提取	5-10分钟/个	<5秒/个	60-120x
批量文件处理(100个)	8-16小时	<5分钟	96-192x
API调用与响应解析	2-3分钟/次	<1秒/次	120-180x
多接口数据聚合	15-30分钟	<10秒	90-180x
命令执行与结果收集	3-5分钟/次	<2秒/次	90-150x
重复任务批量执行	因任务而异	线性缩减	5-50x
错误排查与修复	10-30分钟	<30秒	20-60x

差异化对比

对比维度	Java手册	传统手动方式	通用脚本工具
自动化程度	全流程自动	完全手动	部分自动
错误处理	内置错误恢复	依赖人工经验	基本try-catch
可复用性	参数化配置	一次性脚本	模板化
安全合规	内置安全检查	无安全保障	无安全保障
适用场景	Java开发手册规约集合，基于阿里巴巴Java开发手册（嵩山版）。 涵盖7大维度	通用场景	通用场景

错误恢复

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

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

Java手册通用排查步骤

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

Java手册通用排查步骤

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