How dromara/ruoyi-vue-plus works
Project type and purpose
• This is a full-stack, multi-module backend framework (RuoYi-Vue-Plus) designed for distributed clusters and multi-tenant scenarios, paired with a separate Vue3+TS frontend.
• It follows a plugin-based modular structure: a core monolithic API server (ruoyi-admin), extension micro-services (ruoyi-monitor-admin, ruoyi-snailjob-server), and a suite of reusable common libraries (ruoyi-common/*).
Key architectural layers and modules
• Frontend (external): Vue3 + TypeScript + ElementPlus UI. Communicates via REST, WebSocket, SSE.
• API Gateway / Reverse Proxy: Nginx in Docker Compose for SSL, routing, static content.
• Core Backend (“ruoyi-admin”):
• Spring Boot (Undertow) monolith hosting REST controllers, authentication, multi-tenant logic, dynamic datasource, plugin loader.
• Exposes APIs for tenant management, user/role/menu, CRUD, file upload, code generation, monitoring endpoints.
• Extension Services:
• ruoyi-monitor-admin: Spring Boot Admin server for runtime health, logs, metrics.
• ruoyi-snailjob-server: Distributed task scheduler (SnailJob).
• Common Libraries (ruoyi-common/*):
• Core framework (config, utils, constants)
• Security & Auth (Sa-Token, JWT, multi-tenant support)
• Data access & ORM (MyBatis-Plus, dynamic-datasource, pagination, SQL monitor)
• Cache & Redis support (Spring-Cache extensions, Redisson, rate limiter, queue, lock)
• Encryption / Decryption / Data translation / Sensitive masking / SSE / WebSocket / Excel / Mail / SMS / logging / doc generator, etc.
• Modules (ruoyi-modules/*): Demo, code generator, job examples, system admin features, workflow engine. Pluggable into ruoyi-admin.
• Infrastructure:
• Relational Database: MySQL / PostgreSQL / Oracle / SQLServer (dynamic multi-datasource).
• Redis: Caching, distributed locks, rate limiter, queue, session sync.
• Minio/S3: File storage (local/non-cluster object store).
• External services: SMS providers, email SMTP, JustAuth social OAuth, AWS S3 endpoints.
• Observability: p6spy for SQL logging, Apache SkyWalking tracing, Spring Boot Actuator.
Architectural patterns & design principles
• Plugin-based modular monolith: core + pluggable feature modules, loaded via classpath or jar on startup.
• Layered architecture: Controllers → Services → Repositories (MyBatis+Mapper) → Common utilities.
• Dynamic data source routing for multi-tenant & multiple DBs.
• Decorator & interceptor patterns for encryption, logging, idempotency, translation, validation.
• Event-driven / Queue patterns: Redis Pub/Sub & Spring ApplicationEvents for async notifications & tasks.
• Observability & tracing: centralized Actuator, Spring Boot Admin, SkyWalking.
Detail checklist
• Components: Nginx, Vue3 UI, ruoyi-admin (with sub-modules: Auth, Tenant, Sys, Workflow, Generator), ruoyi-monitor-admin, ruoyi-snailjob-server.
• Infrastructure: Database(s), Redis, Minio/S3, External SMS/Email/Auth.
• Technologies: Spring Boot (Undertow), MyBatis-Plus, dynamic-datasource, Sa-Token/JWT, Redisson, SnailJob, SpringDoc, p6spy, SkyWalking.
• Architectural patterns: plugin architecture, layered MVC, decorator/interceptor, dynamic routing.