How dahoon7151/qpbe-library-task works
Project type and purpose
• This is a backend-only, Spring Boot REST API for an online library management system.
• Core features: JWT-based authentication, book CRUD + tagging, loan management, Redis caching with Pub/Sub for cache consistency, CI/CD via GitHub Actions, containerized with Docker.
File structure
• Top-level artifacts:
• Dockerfile, docker-compose.yml → container build & orchestration
• build.gradle.kts, settings.gradle.kts → Gradle build
• .github/workflows/cicd.yml → CI/CD pipeline
• docs/ → JMeter test plans, performance/consistency reports, Swagger JSON
• src/main/java/com/dahoon/qpbetask:
• book, loan, user packages → Controllers, DTOs, Services, Repositories, Entities
• common/config → RedisConfig, SecurityConfig, SwaggerConfig
• common/cache → CacheInvalidationPublisher/Subcriber
• common/GlobalExceptionHandler
• src/test → Controller integration tests with SpringBootTest
Key architecture pointers from README
• Layered MVC: Controller → Service → Repository
• Spring Security filter chain with JwtAuthenticationFilter → JwtTokenProvider
• JPA for MySQL persistence
• Redis for caching (Read-Aside + Write-Around) + Pub/Sub for multi-instance invalidation
• CI/CD: build → test → Docker image → push → deploy via docker-compose
Components
A. External Clients
• Web/Mobile apps (or Postman/JMeter) invoking REST endpoints
B. API Layer (Spring Boot Application)
• Entry point: QpbetaskApplication → Actuator health check
• Security: SecurityConfig, JwtAuthenticationFilter, JwtAuthenticationEntryPoint
• Controllers: UserController, BookController, LoanController
C. Business Layer
• Services: UserService, BookService, LoanService
• Cache Layer:
• Redis Cache (Read-Aside for GETs)
• CacheInvalidationPublisher (on POST/PATCH/DELETE)
• CacheInvalidationSubscriber (listening on Redis Pub/Sub channel)
D. Persistence Layer
• Repositories: UserRepository, BookRepository, TagRepository, BookTagRepository, LoanRepository
• Database: MySQL
• Entities: User, Book, Tag, BookTag, Loan
E. Infrastructure/DevOps
• CI/CD: GitHub Actions → Gradle build, SpringBootTest + containerized MySQL/Redis services
• Containerization: Dockerfile for app image, docker-compose.yml to spin up app + MySQL + Redis
• Monitoring/Docs: Swagger UI, Actuator, JMeter test plans under docs/
Relationships & interactions
• Client → (HTTPS + JWT) → Security Filter Chain → Controllers
• Controllers ↔ Services ↔ Repositories ↔ MySQL
• Services ↔ Redis Cache (check cache before DB read, populate on cache miss)
• Write operations → Services call CacheInvalidationPublisher → Redis Pub/Sub channel → other instances’ CacheInvalidationSubscriber clears stale keys
• CI/CD pipeline → builds Docker image → pushes to registry → docker-compose deploys all containers → health check via /actuator/health
Architectural patterns & design principles
• Layered architecture (Controller-Service-Repository)
• Token-based stateless authentication (JWT + Spring Security)
• Cache-Aside + Write-Around strategy with Pub/Sub eventing for distributed cache consistency
• Transactional boundaries in services to maintain data integrity and avoid orphan entities
• Docker-Compose for local multi-container orchestration, GitHub Actions for CI/CD