How pedrop3/stock works
Project type and purpose
• This is a backend-only, Java/Spring-Boot stock management microservice.
• It offers REST APIs for tracking stock movements, turnover analysis, ABC classification, alerts, and obsolete product handling.
• It uses a clean layered architecture and the Strategy pattern for movement processing.
File structure
• Top-level artifacts:
• Dockerfile & docker-compose.yml for containerized deployment
• build.gradle / Gradle wrapper for build automation
• settings.gradle for multi-module support (single module here)
• src/main/java/com/learn/stock:
• config (OpenApiConfig, RedisConfig)
• controller (REST entrypoints)
• service & service.impl (business logic)
• repository (JPA/Hibernate persistence)
• factory & strategy (Strategy pattern for IN/OUT movements)
• model (domain entities & enums)
• mapper (DTO↔Entity)
• exception (global handler & error response)
• response (DTOs and paging structures)
• src/main/resources:
• application.yml (app properties, DB, Redis)
• db/changelog (Liquibase migrations + seed SQL)
• src/test: unit and integration tests covering controllers, services, strategy factory
README insights
• Clean layered architecture
• Strategy pattern for movement types
• OpenAPI (Swagger) for API docs
• Liquibase for DB versioning
• Docker / Docker-Compose ready
a. Main components
• API Layer (StockController + Swagger)
• Service Layer (ProductService, StockMovementService, StockService)
• Strategy Layer (MovementTypeStrategy interface + In/Out implementations + StrategyFactory)
• Repository Layer (ProductRepository, StockMovementRepository)
• Persistence Store (PostgreSQL with Liquibase migrations)
• Cache Layer (Redis)
• External Interfaces (Swagger UI, H2 Console if enabled)
b. Relationships & interactions
• Controllers → Services → StrategyFactory → Strategy implementations
• Services ←→ Repositories → PostgreSQL
• Redis used by services for caching (highlight RedisConfig)
• Liquibase runs at startup (db.changelog-master.yaml → SQL scripts)
• HTTP clients (e.g., Swagger UI) → REST Controllers
c. Architectural patterns
• Layered (Controller → Service → Repository → DB)
• Strategy (MovementTypeStrategy + Factory)
• Exception handling via GlobalExceptionHandler
d. Technologies & frameworks
• Java 21, Spring Boot (REST, DI, Data JPA)
• Liquibase, PostgreSQL, Redis
• Swagger/OpenAPI
• Docker & Docker-Compose
• JUnit + Mockito for testing
Final advice
• Be thorough: break down services into individual components (Product vs. StockMovement vs. Stock services).
• StrategyFactory branching into IN/OUT strategies.
• Startup flows: config → Liquibase migrations → spring context initialization.