java-coding-standards

Standards for readable, maintainable Java (17+) code in Spring Boot services. Remember : Keep code intentional, typed, and observable. Optimize for maintainability over micro-optimizations unless proven necessary. - Writing or reviewing Java code in Spring Boot projects - Enforcing naming, immutability, or exception handling conventions - Working with records, sealed classes, or pattern matching (Java 17+) - Reviewing use of Optional, streams, or generics - Structuring packages and project layout - Prefer clarity over cleverness - Immutable by default; minimize shared mutable state - Fail fast with meaningful exceptions - Consistent naming and package structure - Use unchecked exceptions for domain errors; wrap technical exceptions with context - Create domain-specific exceptions (e.g., MarketNotFoundException ) - Avoid broad catch (Exception ex) unless rethrowing/logging centrally - Avoid raw types; declare generic parameters - Prefer bounded generics for reusable utilities - Use 2 or 4 spaces consistently (project standard) - One public top-level type per file - Keep methods short and focused; extract helpers - Order members: constants, fields, constructors, public methods, protected, private - Long parameter lists → use DTO/builders - Deep nesting → early returns - Magic numbers → named constants - Static mutable state → prefer dependency injection - Silent catch blocks →...