Java 编程规约技能

作用

本技能基于《阿里巴巴Java开发手册》的编程规约章节，为Java开发者提供全面的代码规范审查和指导。

涵盖以下规约领域：

使用方法

1. 按需加载规约 — 输入：用户问题或待审查代码的特征描述；执行：选择对应的规约文件读取，不要一次性加载所有文件；输出：已加载的规约领域清单
2. 代码审查 — 输入：Java 代码片段或文件路径；执行：读取相关规约文件后逐条对照检查；输出：按【强制】【推荐】【参考】分级的问题清单 + 正例参考
3. 编码指导 — 输入：用户正在编写的 Java 代码场景；执行：引用相关规约条款分析；输出：符合规约的编码建议 + 示例代码

编程审查检查点

执行 Java 编程规约审查时，以下场景需先向用户确认，再执行后续操作：

规约文件索引

所有规约原文存放于 references/ 目录下，按小节拆分，按需读取：

references/
├── naming-style.md          # 命名风格（类名、方法名、变量名、常量、包名等）
├── constant-definition.md   # 常量定义（魔法值、常量分层、枚举）
├── code-format.md           # 代码格式（缩进、空格、换行、行宽）
├── oop-convention.md        # OOP规约（equals、BigDecimal、包装类型、序列化）
├── datetime-convention.md   # 日期时间（SimpleDateFormat、日期处理）
├── collection-convention.md # 集合处理（ArrayList、HashMap、subList、toArray）
├── concurrency-convention.md # 并发处理（线程池、锁、ThreadLocal、volatile）
├── control-statement.md     # 控制语句（switch、if-else、三目运算）
├── comment-convention.md    # 注释规约（类注释、方法注释、特殊标记）
├── frontend-backend.md      # 前后端规约（接口规范、API设计）
└── other-convention.md      # 其他

按需读取指引

根据任务类型，读取对应的规约文件：

边界条件处理

规约适用性判断

不是所有代码都需要检查所有规约。审查时应结合上下文判断规约是否适用，避免对单线程代码套用并发规约、对临时脚本套用工程规约等误判。

规约等级说明

原文中的规约分为三个等级：

• 【强制】：必须遵守，违反会导致严重问题
• 【推荐】：建议遵守，不遵守可能影响代码质量
• 【参考】：供参考，根据具体情况决定是否采用

审查输出格式

审查Java代码时，按以下结构输出：

1. 【强制】违规项 — 必须修复的问题，说明违反的规约编号和内容
2. 【推荐】改进项 — 建议改进的代码，说明原因
3. 【参考】优化建议 — 可酌情采纳的建议
4. 正例参考 — 提供符合规约的代码示例