What problem does it solve?
This Skill addresses the challenge of maintaining consistent, readable, and maintainable Java code within Spring Boot services by providing clear coding standards.
Core Features & Use Cases
- Standardized Naming Conventions: Ensures uniformity in naming classes, methods, fields, and constants.
- Immutability Guidance: Promotes the use of immutable objects to reduce side effects and improve thread safety.
- Effective Optional Usage: Guides developers on the correct application of
Optional to handle potentially absent values gracefully.
- Stream API Best Practices: Offers recommendations for writing clear and efficient stream pipelines.
- Exception Handling: Defines strategies for domain-specific exceptions and wrapping technical ones.
- Generics and Type Safety: Encourages the use of generics for type safety and code reusability.
- Project Structure: Provides a recommended layout for Maven/Gradle projects.
- Formatting and Style: Outlines rules for code formatting, file structure, and member ordering.
- Code Smells Avoidance: Identifies and suggests alternatives for common code smells.
- Logging and Null Handling: Offers best practices for logging and managing null values.
- Testing Expectations: Sets standards for unit testing frameworks and practices.
Quick Start
Apply the java-coding-standards skill to review and enforce Java coding standards in the provided Spring Boot project.
