Java 后端编码规范指南
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_978fa0ea/java-coding-guide。
技能介绍
解决什么问题
Java 后端开发里,需求理解、技术方案、编码风格与测试验收常分散在不同环节:有人直接改代码,有人补测试时才发现边界缺失,文档和实现口径也不一致。java-coding-guide 把这些约束变成可执行的流程:先澄清范围、边界、非功能要求,再记录需求变更,更新技术方案,然后按 Java 后端编码规范 实现,最后完成编译、静态检查和单元测试。
技能如何工作
该技能围绕两个资源文件展开:coding-standards.md 用于约束后端代码编写,unit-testing-standards.md 用于约束测试编写。它要求按顺序执行:
- 需求分析:明确范围、边界、性能、安全、兼容性与数据一致性,显式写出默认假设。
- 文档沉淀:将已确认变更写入需求变更文档,并在
docs/design/或仓库既有路径下新建/增量更新技术方案。 - 规范编码:遵循分层调用、DTO、Mapper XML、Spring Boot、事务与注释等规则,优先复用现有组件。
- 质量验证:执行
mvn -q -DskipTests compile等项目约定编译命令,修复错误后按单测规范补充核心逻辑、边界与异常路径测试,并反复运行至通过。
适用边界
它更适合 Java/Spring Boot 后端仓库中需要统一工程流程的场景,尤其适合希望让 Agent 在实现前先对齐需求和方案的团队。该技能不会替代项目自身架构决策、领域规则或团队私有规范;文档路径、构建命令与静态检查策略仍应以仓库实际约定为准。
使用场景
- 接到 Java 后端需求后,先澄清边界、性能、安全假设,并整理成需求变更与技术方案。
- 在 Spring Boot 仓库实现接口前,按分层、DTO、Mapper XML、事务和注释规范编码并复用组件。
- 编码完成后执行编译和静态检查,修复错误,再按单测规范补充边界与异常路径测试。
- 让 Agent 按需求分析、方案更新、实现、测试的顺序生成可交付后端变更,避免直接跳步。
适合人员
- 负责 Spring Boot 服务接口与数据库改造的后端工程师,需要把需求、方案、编码和单测串成同一流程。
- 使用 Agent 做后端开发的技术负责人,希望模型先对齐边界与技术方案,再按仓库规范实现。
- 维护 Java 仓库工程质量的团队,需要统一分层调用、DTO、Mapper XML、事务和测试验收口径。
- 接手旧 Java 服务并需要补文档、补单测的开发者,希望按标准流程完成变更而不是只改代码。