Skillshub spring-boot-architecture
Standards for project structure and layering in Spring Boot 3+ applications. Use when structuring Spring Boot 3 projects, defining layers, or applying architecture patterns. (triggers: pom.xml, build.gradle, structure, layering, dto, controller, @RestController, @Service, @Repository, @Entity, @Bean, @Configuration)
install
source · Clone the upstream repo
git clone https://github.com/ComeOnOliver/skillshub
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/ComeOnOliver/skillshub "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/HoangNguyen0403/agent-skills-standard/spring-boot-architecture" ~/.claude/skills/comeonoliver-skillshub-spring-boot-architecture && rm -rf "$T"
manifest:
skills/HoangNguyen0403/agent-skills-standard/spring-boot-architecture/SKILL.mdsource content
Spring Boot Architecture Standards
Priority: P0 (CRITICAL)
Implementation Guidelines
Structure & Packaging
- Package by Feature: Prefer
(e.g.,com.app.feature
,user
) over technical layers (order
) for scalability.controllers - Dependency Rule: Outer layers (Web) depend on Inner (Service). Inner layers MUST NOT depend on Outer.
- DTO Pattern: ALWAYS use DTOs for API inputs/outputs. NEVER return
directly.@Entity - Java Records: Use
for DTOs to ensure immutability (Java 17+).record
Layer Responsibilities
- Controller (Web): Handle HTTP, Validation (
), DTO mapping. Delegate logic to Service.@Valid - Service (Business): Transaction boundaries, orchestration. Returns Domain/DTOs.
- Repository (Data): Database interactions only. Returns Entities/Projections.
API Design
- Global Error Handling: Use
with@RestControllerAdvice
(RFC 7807).ProblemDetails - Validation: Use Jakarta Bean Validation (
,@NotNull
) on DTOs.@Size - Response: Use
for explicit status orResponseEntity
.ResponseStatusException
Verification Checklist (Mandatory)
- No Entities in API: Are all API responses using DTOs/Records instead of JPA Entities?
- Validation: Are
and Jakarta Bean Validation constraints present on all input DTOs?@Valid - Layer coupling: Do Services depend on Controllers? (Prohibited)
- Transactionality: Are business transactions correctly bounded with
in the Service layer?@Transactional - Error Details: Is
used for consistent error responses?ProblemDetails
Anti-Patterns
- No Fat Controllers: Move business logic to Services.
- No Leaking Entities: Use DTOs instead of JPA Entities in APIs.
- No Circular Dependencies: Use Events or refactor to decouple services.
- No God Classes: Split large services into single-responsibility components.