How travezvinueza/rolesandpermission works
Project type and purpose
• This is a Spring Boot–based RESTful API monolith focused on user/role/permission management, JWT‐based authentication/authorization, product CRUD, image upload, PayPal payments, PDF reporting, email notifications, and simple caching via Postgres UNLOGGED tables.
File structure
• Top‐level Maven project (pom.xml, mvnw).
• src/main/java/com/develop/backend:
• application – DTOs & mappers (API‐internal data contracts)
• domain – business entities, enums, service interfaces, repository interfaces
• domain/service/impl – business logic implementations
• infrastructure – configuration (JWT filter, security, PayPal, async executor, Swagger), REST controllers, exception handlers, utilities
• src/main/resources:
• Flyway migrations (db/migration)
• application.properties (database, SMTP, PayPal, JWT)
• JasperReports templates, email templates, file‐upload root
• src/test: unit/integration tests for controllers and application start
README for insights
• Confirms use of Spring Boot, Spring Security (JWT), Spring Data JPA (Postgres), Flyway, Spring Mail, PayPal SDK, Springdoc OpenAPI, JasperReports, Lombok.
• Describes major features: registration, login, token refresh, role & permission checks, product management, file upload, PDF reports, caching.
1. Client (Web/Mobile)
2. API Gateway / Spring Boot Application
– Security & Auth Filter (JWTAuthFilter)
– REST Controllers (AuthController, UserController, ProductController, etc.)
– Application Layer (DTOs, mappers)
– Domain Layer (Services & ServiceImpl)
– Data Layer (Spring Data JPA Repositories)
3. Relational Database (PostgreSQL + UNLOGGED cache tables + Flyway)
4. File Storage (local “uploads” directory)
5. External Services:
– SMTP Email Server
– PayPal API
6. Reporting Engine (JasperReports)
7. API Documentation (Springdoc OpenAPI UI)
• Client → HTTP request → JWTAuthFilter → Appropriate Controller
• Controller → Map request DTO → Service interface
• Service → Business logic, may call GenericCacheService for cached reads
• Service → Repository → SQL queries → PostgreSQL
• Service → FileUploadService → writes to local “uploads”
• AuthService → interacts with TokenRepository, UserRepository → issues JWT + refresh token
• EmailService → SMTP server → sends verification or notification emails
• PaypalService → PayPal REST API → processes payments
• ReportService (or domain service) → JasperReports → generates PDF
• Flyway (on app startup) → migrates schema & seed data in PostgreSQL
c. Architectural patterns & design principles:
• Layered (Controller → Service → Repository)
• DTO & Mapper pattern (separate internal entities from API contracts)
• Dependency Injection & inversion of control (Spring)
• Exception handling via @ControllerAdvice (GlobalExceptionHandler)
• Asynchronous configuration (AsyncExecutorConfig) for nonblocking tasks
• Security filter chain for stateless JWT auth
• Caching via custom GenericCacheService backed by Postgres UNLOGGED tables
• API documentation auto‐generation (Springdoc OpenAPI)
d. Key technologies/frameworks to annotate:
• Spring Boot, Spring Security, Spring Data JPA
• JWT (via JwtGenerator, JwtAuthFilter)
• Flyway (db/migration scripts)
• PostgreSQL (with UNLOGGED cache tables)
• Spring Mail
• PayPal SDK
• JasperReports
• Lombok
• Springdoc OpenAPI