wardbit/springboot-init-skills
Overview
This skill defines development specifications and provides ready-to-use templates for initializing Spring Boot monolithic projects across multiple stacks. It guides technology selection, package layout, coding conventions, dependency choices, and access-control options. Use it to generate consistent, production-ready boilerplate and enforce team standards.
How this skill works
The skill inspects your chosen Spring Boot version and recommended JDK, then applies compatible conventions (package structure, imports, and configuration patterns) for the selected ORM and security stack. It emits concrete artifacts: controller/service/mapper/repository templates, DTO/VO/Entity examples, BaseResponse utilities, and standardized exception and logging patterns. It also documents required annotations, transaction rules, and dependency recommendations for each configuration.
When to use it
- Starting a new Spring Boot monolith and needing a standard project skeleton
- Standardizing code style and architecture across a team
- Evaluating ORM or access-control options for a new module
- Bootstrapping CRUD modules with ready DTO/VO/entity templates
- Migrating between Spring Boot major versions (2.x → 3.x/4.x)
Best practices
- Choose Spring Boot version and JDK together — follow the compatibility matrix (2.x → Java 8/11, 3.x/4.x → Java 17+)
- Follow the prescribed package layout: controller, service, mapper/repository, model (entity/dto/vo), config, aop, exception
- Keep controllers thin: validate, authorize, call service, return BaseResponse<T>; no business logic in controllers
- Use @Slf4j for logging and @Transactional for multi-table or multi-step business operations
- Prefer constructor injection for immutability and testability; @Resource or @Autowired are allowed per team convention
Example use cases
- Generate a new project skeleton for Spring Boot 3.x with Jimmer repository and Keycloak SSO
- Create CRUD endpoints using MyBatis-Plus with DTO/VO and paginated responses
- Switch an existing module from javax.* imports to jakarta.* when migrating to Spring Boot 3.x+
- Enforce unified error handling with ThrowUtils, BusinessException, and standardized ErrorCode values
- Implement role-based endpoints using Sa-Token, Spring Security, Shiro, or a custom AOP AuthCheck
FAQ
Use Jimmer for strong-typed DSL and immutable entities; it fits complex domain models and DDD patterns.
How must controllers return results?
All controllers must return BaseResponse<T> and use Request DTOs for multi-parameter inputs.
What to do when migrating from Spring Boot 2.x to 3.x?
Update JDK to recommended level, replace javax.* imports with jakarta.*, and review any library compatibility notes.
