SuperAPI AI 工具集

alibaba-java-coding-guidelines-skill

编程与开发

查看项目

更新于 10-15 16:45

技能介绍

用途:把《阿里巴巴 Java 开发手册》作为 Java 代码生成、重构与审查的默认质量基线,先处理强制规则,再处理推荐规则;若与项目本地约定冲突,需说明冲突点并以用户或项目约定为准。规则摘要见 references/alibaba-java-rules.md,完整条文见 https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/。

适用场景:审查 Java、Spring、MyBatis、Maven、SQL、DDL、日志、异常处理或安全相关改动;生成类、接口、DTO、VO、DO、枚举、异常类、测试类、Mapper、Service、DAO 或 SQL;重构命名、常量、集合、并发、控制流、日志、异常与数据库访问代码;输出评审意见、整改清单、符合性报告或修复建议。

工作流程:先识别任务类型(生成、审查、重构、SQL/DDL 审查、依赖治理、安全检查),再读取项目已有风格、包结构、测试框架与持久层写法,然后按强制、推荐、参考三级处理,并按正确性与安全、稳定性与性能、可维护性、风格一致性的顺序输出。

主要规则要点:命名上类名用 UpperCamelCase,方法、参数、成员变量与局部变量用 lowerCamelCase,常量用大写加下划线;注释使用中文,公开 API、复杂业务规则、异常含义与空值语义要写清;不用魔法值,固定范围值优先用枚举;日志用 SLF4J 门面,不直接绑定具体实现,低级别日志用占位符或级别判断;资源关闭优先 try-with-resources,不在 finally 中 return 或抛新异常;MyBatis 参数默认用 #{},禁止拼接用户输入;Web、Open API、SQL、HTML 输出与用户输入需做权限、校验、转义或脱敏。

审查输出要求:每条意见包含级别、位置(文件与行号)、违反的规约类型、风险、可落地建议;未发现问题时需说明已检查范围与未覆盖风险。

兼容性与校验:属通用 Agent Skill,不绑定单个运行器;Claude Code、Codex 等支持 Agent Skills 目录规范的工具依赖 SKILL.md 与按需读取的 references/ 内容。agents/openai.yaml 仅为 OpenAI/Codex UI 可选元数据。提供 Python、Node.js、Go 三种等价校验实现 scripts/validate_skill.py、scripts/validate_skill.mjs、scripts/validate_skill.go,一致性验证运行 tests/test_validators.sh。

限制:不替代实际测试与线上配置检查;未提供收费、价格、平台支持范围等事实。