SuperAPI AI 工具集

java-coding-standards

编程与开发

查看项目

更新于 10-16 07:23

技能介绍

用途:作为 Java 17+ / Spring Boot 项目的简明工作卡,指导编写、评审、重构和讲解 Java 代码。SKILL.md 只保留流程与路由,具体规则按需加载 references/ 下的参考文件。仓库内规则(AGENTS.md、CLAUDE.md、本地格式化配置、相邻代码)优先于本技能,冲突影响结果时再指出。

主要能力:核心默认规则包括 2 空格缩进、100 列限制、K&R 大括号、不用通配符导入;类用 UpperCamelCase、常量用 UPPER_SNAKE_CASE;不直接暴露 Entity,请求用 Form、返回用 VO、跨层用 DTO、内部用 BO;布尔字段用 xxxFlag;方法参数尽量不超过 5 个。分层上 Controller 只做路由、认证边界、校验与响应转换,Service 做业务编排,Manager 承载 @Transactional(rollbackFor = Exception.class) 与 DAO 组合,DAO/Mapper 只做持久化。

使用方式:编写或重构时先看构建文件、本地说明、formatter/lint 配置、包结构与相似类写法,只加载当前改动需要的参考文件,控制改动面,用定向测试、模块编译、formatter 或静态检查验证。评审时先看 bug 与风险,按严重程度排序并给出文件/行号,说明违反规则、原因与修法。回答规范问题时按规则、原因、示例、本地覆盖约定组织。参考路由:格式与命名加载 references/google-style.md;项目结构与现代 Java 特性加载 references/code-style.md;分层与 URL、事务、设计模式加载 references/architecture.md;异常、日志、性能、线程池、安全、测试、数据库加载 references/best-practices.md。

限制:不要为满足技能而大规模重构无关代码;机械性规则优先交给 formatter、Checkstyle、Spotless、测试、CI 或 hooks。禁止在事务内调用外部 HTTP、LLM、S3、MQ、邮件等慢速远程接口;不要依赖同类内部调用触发 @Transactional;不要创建静态异常实例;不要写空 catch;不要在同一层既记日志又抛同一异常;不要把 N+1 调用藏进 Stream 或循环;不要硬编码密钥、Token、供应商 base URL;生产路径不要用 Executors.newFixedThreadPool() 或 newCachedThreadPool()。URL 风格默认跟随仓库约定,无约定时偏向非 RESTful 的 GET/POST /module/submodule/action。文档注解跟随仓库现有 Swagger/OpenAPI 体系。具体命令与验证流程资料未提供。