301-framework-spring-boot

Spring Boot Development Guidelines

Project Structure

Best Practices

Configuration

configuration_guidelines:

• "Use configuration properties classes over @Value"
• "Externalize configuration using application.yml"
• "Use profiles for environment-specific settings"
• "Follow the 12-factor app methodology"
• "Use @ConfigurationProperties for type-safe configuration"

REST APIs

rest_guidelines:

• "Follow REST maturity model"
• "Use proper HTTP methods (GET, POST, PUT, DELETE)"
• "Implement proper error handling with @ControllerAdvice"
• "Use DTOs to control API response/request structure"
• "Implement API versioning"
• "Use proper HTTP status codes"
• "Document APIs using OpenAPI/Swagger"

Security

security_guidelines:

• "Enable HTTPS in production"
• "Implement proper authentication and authorization"
• "Use Spring Security for security concerns"
• "Implement CORS properly"
• "Follow OWASP security guidelines"
• "Use security headers"
• "Implement rate limiting"

Database

database_guidelines:

• "Use Spring Data JDBC repositories when possible"
• "Implement proper transaction management"
• "Use connection pooling"
• "Implement database migrations with Flyway/Liquibase"
• "Implement proper indexing strategy"

Testing

testing_guidelines:

• "Write unit tests for services and controllers"
• "Use @SpringBootTest for integration tests"
• "Implement test slices (@WebMvcTest, @DataJpaTest)"
• "Use test containers for integration tests"
• "Mock external services"
• "Test configuration properties"

Performance

performance_guidelines:

• "Use caching where appropriate"
• "Implement connection pooling"
• "Use async processing for long-running tasks"
• "Implement proper logging levels"
• "Use metrics and monitoring"
• "Implement proper exception handling"

Code Examples

Configuration Properties

@ConfigurationProperties(prefix = "app")
@Validated
public class AppProperties {
    @NotNull
    private String apiKey;
    private int cacheTimeout;
    // getters and setters
}