spring-boot-coding-standards

What problem does it solve?

This Skill provides a standardized set of Spring Boot coding practices to improve code quality, maintainability, and consistency across projects.

Core Features & Use Cases

• Constructor Injection (Required): Always use constructor injection to enable better testability and clearer dependencies.
• DTOs and Value Objects: Create immutable DTOs when possible to ensure data integrity.
• Error Handling: Implement global exception handling to provide consistent error responses and reduce boilerplate.
• RESTful API Design: Follow REST conventions for controllers, endpoints, and responses to improve usability and interoperability.
• Lombok Usage: Use Lombok judiciously to reduce boilerplate while avoiding common pitfalls.
• Input Validation: Validate user input to prevent invalid data and security issues.
• Transaction Management: Use @Transactional appropriately to balance safety and performance. These guidelines help teams write maintainable Spring Boot applications and facilitate code reviews and onboarding.

Quick Start

Apply these Spring Boot coding standards when writing or reviewing code to ensure consistent, high-quality implementations.