How elunez/eladmin works
Main Components
• eladmin-common: Contains all shared components such as custom annotations, aspects, base classes, common configurations (security, Redis, Swagger, etc.), exception handling, and utilities. It forms the backbone for many cross-cutting concerns.
• eladmin-system: The core module and entry point for the application. This module includes the system’s business logic, service modules (login, monitoring, scheduling, security, and system functionalities like user, role, menu, and department management), REST controllers, and the application startup code.
• eladmin-logging: A dedicated module for system logging. It provides classes and APIs to capture user operations, exceptions, and various system events.
• eladmin-tools: Houses external tool integrations such as email sending, local storage, Qiniu cloud storage, and Alipay payment. These are separate service modules that can be used by the core system.
• eladmin-generator: Provides code generation capabilities. It automatically generates both backend and front-end CRUD code based on templates and domain configurations.
Component Relationships and Data Flow
• The core system (eladmin-system) imports and utilizes common functionalities from eladmin-common, ensuring reusability of utilities, configurations, and exception handling.
• When logging is needed, eladmin-system and possibly other modules (like eladmin-tools) interact with eladmin-logging to persist or manage log data.
• For integration with third-party services (email, cloud storage, payments), eladmin-system communicates with the respective components in eladmin-tools.
• The code generation module (eladmin-generator) has its own REST controllers and services but ultimately feeds into the main system by producing source code that is then compiled or used by the overall application.
• External systems and clients (such as the front-end Vue application mentioned in the readme) consume the exposed REST APIs provided by eladmin-system.
Highlighting Key Architectural Patterns
• Modular Architecture: Each top-level module encapsulates distinct functionalities (common utilities, system core, logging, tools, and code generation).
• Layered (MVC-like) Structure: In the core system, you have controllers (REST endpoints), services (business logic), repositories (data access) and domain objects (models/entities).
• Cross-cutting Concerns: The use of aspects (eladmin-common/aspect) to implement features like rate limiting (with @Limit and LimitAspect) and logging via custom annotations.
• Security: The integration of Spring Security, JWT-based authentication, and specific configuration modules for user caching and token management to maintain robust access control.
• Extensibility: The design of modules like eladmin-generator and eladmin-tools ensures the platform can be extended through code generation and third‐party tool integrations.
Technologies and Frameworks
• Spring Boot 2.7.18 as the framework backbone.
• Spring Boot JPA for database interactions along with MyBatis-Plus (mentioned in the alternative repository).
• JWT and Spring Security to secure the APIs.
• Redis for caching and possibly session management.
• Quartz for scheduling tasks, integrated in the system modules.
• External integrations: Email, Alipay, Qiniu, and local storage via respective tool modules.
• Swagger configuration (in eladmin-common) for API documentation.