How hoangtien2k3/web-app-backend-springboot works
Project type and purpose
• This is a monolithic Java Spring Boot backend for an e-commerce (“shopapp”) system. It exposes RESTful APIs for Web or Mobile clients. It uses layered architecture, integrates with MySQL for persistence, Redis for caching, Kafka for messaging, and Flyway for DB migrations. It’s containerized via Docker and orchestrated with docker-compose.
Main components and boundaries
• Clients: Web UI, Mobile App, API testing tools (Postman/Swagger UI).
• Spring Boot Application (single deployable JAR):
• Controllers (BrandController, ProductController, UserController, etc.) – handle HTTP/REST requests.
• Services (UserService, OrderService, CouponService, etc.) – contain business logic.
• Repositories (JPA/Hibernate-based) – data-access layer to MySQL.
• Components & Filters (CorsFilter, JwtTokenFilter) – security, CORS, JWT management.
• Aspects (PerformanceAspect, UserActivityLogger) – cross-cutting concerns via AOP.
• Configurations (SecurityConfig, RedisConfig, FlywayConfig, OpenApiConfig, etc.) – bootstrap beans, externalized settings.
• Utils, DTOs, Mappers – support classes for mapping, validation, message translation.
• Datastores & Infrastructure services (all inside Docker Compose):
• MySQL8 container – persistent relational DB + Flyway migrations at startup.
• Redis container – caching layer.
• Kafka + Zookeeper containers – async messaging bus for inter-component events (e.g., order events).
• Other: file uploads directory, SQL scripts, Dockerfile, CI/CD pipeline (CircleCI), code quality (SonarCloud).
Relationships & data flow
• Clients → (HTTP/HTTPS) → Spring Boot Controllers
• Controllers → Services → Repositories → (JDBC/Hibernate) → MySQL
• Services ↔ Redis (cache read/write via RedisTemplate)
• Services ↔ Kafka (publish/subscribe events)
• On startup: FlywayConfig runs DB migrations against MySQL
• Security filters (CorsFilter, JwtTokenFilter) sit on the inbound HTTP path
• Aspects wrap service calls for logging and performance metrics
Architectural patterns & design principles
• Layered architecture (Presentation → Business → Data).
• AOP for logging, performance, exception handling.
• JWT + Spring Security filter chain for stateless auth.
• Externalized configuration for profiles (dev, prod) and secrets (.env files).
• Containerization: each infra component runs in its own Docker container.
• DB migration versioning with Flyway.
• Redis for caching hot data and improving read performance.
• Kafka for decoupled, event-driven communication.