Java Backend Coding Guide
Paste the following prompt into your AI chat to install this skill:
Please follow https://skillhub.cn/install/skillhub.md to install @user_978fa0ea/java-coding-guide.
About this skill
What Problem It Addresses
In Java backend development, requirement understanding, design, coding style, and test validation often live in different stages: some teams change code first and discover missing edge cases during testing, while docs and implementation can drift. java-coding-guide turns these constraints into an executable workflow: clarify scope, boundaries, and non-functional requirements, record confirmed changes, update the technical design, implement under Java backend coding standards, then complete compilation, static checks, and unit tests.
How It Works
The skill is organized around two reference files: coding-standards.md for backend implementation rules and unit-testing-standards.md for test authoring. It enforces an ordered process:
- Requirement analysis: define scope, boundaries, performance, security, compatibility, and data consistency, and make assumptions explicit.
- Documentation: write confirmed changes into a requirements-change document and create or incrementally update a technical design in docs/design/ or the repo's existing path.
- Standardized coding: follow layering, DTO, Mapper XML, Spring Boot, transaction, and annotation/comment conventions, and reuse existing components first.
- Validation: run project-defined commands such as mvn -q -DskipTests compile, fix errors, add tests for core logic, boundaries, and exception paths, and repeat execution until tests pass.
Where It Fits Best
It suits Java/Spring Boot backend repositories where teams need a consistent engineering workflow, especially when an Agent should align requirements and design before implementation. It does not replace project architecture decisions, domain rules, or private conventions; documentation paths, build commands, and static-check policies should still follow the repository's actual setup.
Use Cases
- After receiving a Java backend task, clarify boundaries, performance, and security assumptions before drafting requirement and design notes.
- Before implementing APIs in a Spring Boot repo, code according to layering, DTO, Mapper XML, transaction, and comment conventions while reusing components.
- After coding, run compile and static checks, fix failures, then add unit tests for boundary and exception paths per the testing standard.
- Ask the Agent to produce a backend change in the order of requirement analysis, design update, implementation, and testing instead of jumping steps.
Best For
- Backend engineers handling Spring Boot API and data changes who need requirements, design, coding, and unit tests in one consistent workflow.
- Tech leads using Agents for backend work who want models to align boundaries and design before implementing under repo conventions.
- Teams maintaining Java code quality who need consistent layering, DTO, Mapper XML, transaction, and test acceptance conventions.
- Developers taking over legacy Java services and needing to add documentation and tests while completing changes through a standard process.
Related Skills
Analyzes code to extract control and data flow, then outputs Markdown with Mermaid source and high-resolution PNG diagrams.
For development and programming scenarios around VSCode and TypeScript IDE.
A TypeScript-oriented Windmill Wrap development reference.
A Python-based Selenium wrapper for engineering browser automation workflows.