# dromara/ruoyi-vue-plus architecture

> Architecture diagram of the GitHub repository dromara/ruoyi-vue-plus, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dromara/ruoyi-vue-plus
- Repository: https://github.com/dromara/ruoyi-vue-plus

## Overview

##### 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.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Legend definitions
    classDef frontend fill:#E8F0FE,stroke:#3B78FF,color:#000
    classDef backend fill:#FEF3E8,stroke:#FF8C00,color:#000
    classDef service fill:#E8F8E0,stroke:#28A745,color:#000
    classDef db fill:#F0F8FF,stroke:#1E90FF,color:#000
    classDef cache fill:#FFF5E6,stroke:#D2691E,color:#000
    classDef external fill:#F5F5F5,stroke:#A9A9A9,color:#000

    %% User and Frontend
    User["User"]:::external
    Frontend["Vue3+TS UI"]:::frontend

    %% API Gateway
    subgraph "API Gateway / Reverse Proxy" 
        Nginx["Nginx"]:::service
        DockerCompose["Docker Compose"]:::service
    end

    %% Core Backend
    subgraph "Core Backend: ruoyi-admin" 
        RuoYiAdmin["ruoyi-admin"]:::backend
        subgraph "Controllers"
            AuthCtrl["AuthController"]:::backend
            IndexCtrl["IndexController"]:::backend
        end
        RuoYiApp["DromaraApplication"]:::backend
        AppConfig["application.yml"]:::backend
        subgraph "Plugin Modules" 
            DemoMod["ruoyi-demo"]:::backend
            GenMod["ruoyi-generator"]:::backend
            JobMod["ruoyi-job"]:::backend
            SysMod["ruoyi-system"]:::backend
            WfMod["ruoyi-workflow"]:::backend
        end
    end

    %% Extension Services
    subgraph "Extension Service: ruoyi-monitor-admin"
        MonitorApp["MonitorAdminApplication"]:::service
        AdminConfig["AdminServerConfig"]:::service
    end

    subgraph "Extension Service: ruoyi-snailjob-server"
        SnailApp["SnailJobServerApplication"]:::service
        ActuatorFilter["ActuatorAuthFilter"]:::service
    end

    %% Common Libraries
    subgraph "Common Libraries: ruoyi-common/*"
        CommonCore["ruoyi-common-core"]:::service
        CommonMybatis["ruoyi-common-mybatis"]:::service
        CommonRedis["ruoyi-common-redis"]:::service
        CommonSaToken["ruoyi-common-satoken"]:::service
        CommonSecurity["ruoyi-common-security"]:::service
        CommonTenant["ruoyi-common-tenant"]:::service
        CommonWeb["ruoyi-common-web"]:::service
        CommonWS["ruoyi-common-websocket"]:::service
        CommonSSE["ruoyi-common-sse"]:::service
        CommonEncrypt["ruoyi-common-encrypt"]:::service
        CommonExcel["ruoyi-common-excel"]:::service
        CommonIdemp["ruoyi-common-idempotent"]:::service
        CommonLog["ruoyi-common-log"]:::service
        CommonMail["ruoyi-common-mail"]:::service
        CommonJson["ruoyi-common-json"]:::service
        CommonJob["ruoyi-common-job"]:::service
        CommonRate["ruoyi-common-ratelimiter"]:::service
        CommonDoc["ruoyi-common-doc"]:::service
        CommonTrans["ruoyi-common-translation"]:::service
        CommonSMS["ruoyi-common-sms"]:::service
    end

    %% Infrastructure
    Database["Relational DB (MySQL/PostgreSQL/Oracle/SQLServer)"]:::db
    Redis["Redis Cluster"]:::cache
    Minio["Minio/S3 Storage"]:::external
    SMSMailAuth["External SMS/Email/Auth"]:::external

    %% Flows
    User -->|"uses UI"| Frontend
    Frontend -->|"HTTP/REST"| Nginx
    Nginx -->|"routes REST"| RuoYiAdmin

    RuoYiAdmin -->|"JDBC via MyBatis"| Database
    RuoYiAdmin -->|"Redis API"| Redis
    RuoYiAdmin -->|"HTTP API"| Minio
    RuoYiAdmin -->|"HTTP/SDK"| SMSMailAuth
    RuoYiAdmin -->|"WebSocket/SSE"| Frontend
    RuoYiAdmin -->|"Spring Cloud Registrar / HTTP"| MonitorApp
    RuoYiAdmin -->|"Spring Cloud Registrar / HTTP"| SnailApp

    %% Deployment arrows for Docker Compose
    DockerCompose --> Nginx
    DockerCompose --> RuoYiAdmin
    DockerCompose --> MonitorApp
    DockerCompose --> SnailApp
    DockerCompose --> Database
    DockerCompose --> Redis

    %% Click Events: API Gateway
    click Nginx "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/script/docker/nginx/conf/nginx.conf"
    click DockerCompose "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/script/docker/docker-compose.yml"

    %% Click Events: Core Backend
    click RuoYiAdmin "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-admin/pom.xml"
    click RuoYiAdmin "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-admin/Dockerfile"
    click RuoYiApp "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-admin/src/main/java/org/dromara/DromaraApplication.java"
    click AuthCtrl "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-admin/src/main/java/org/dromara/web/controller/AuthController.java"
    click IndexCtrl "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-admin/src/main/java/org/dromara/web/controller/IndexController.java"
    click AppConfig "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-admin/src/main/resources/application.yml"

    %% Click Events: ruoyi-monitor-admin
    click MonitorApp "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-monitor-admin/src/main/java/org/dromara/monitor/admin/MonitorAdminApplication.java"
    click AdminConfig "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-monitor-admin/src/main/java/org/dromara/monitor/admin/config/AdminServerConfig.java"
    click MonitorApp "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-monitor-admin/pom.xml"
    click MonitorApp "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-extend/ruoyi-monitor-admin/Dockerfile"

    %% Click Events: ruoyi-snailjob-server
    click SnailApp "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-snailjob-server/src/main/java/org/dromara/snailjob/SnailJobServerApplication.java"
    click ActuatorFilter "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-snailjob-server/src/main/java/com/aizuda/snailjob/server/starter/filter/ActuatorAuthFilter.java"
    click SnailApp "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/ruoyi-extend/ruoyi-snailjob-server/pom.xml"
    click SnailApp "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-extend/ruoyi-snailjob-server/Dockerfile"

    %% Click Events: Common Libraries
    click CommonCore "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-core"
    click CommonMybatis "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-mybatis"
    click CommonRedis "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-redis"
    click CommonSaToken "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-satoken"
    click CommonSecurity "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-security"
    click CommonTenant "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-tenant"
    click CommonWeb "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-web"
    click CommonWS "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-websocket"
    click CommonSSE "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-sse"
    click CommonEncrypt "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-encrypt"
    click CommonExcel "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-excel"
    click CommonIdemp "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-idempotent"
    click CommonLog "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-log"
    click CommonMail "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-mail"
    click CommonJson "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-json"
    click CommonJob "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-job"
    click CommonRate "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-ratelimiter"
    click CommonDoc "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-doc"
    click CommonTrans "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-translation"
    click CommonSMS "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-common/ruoyi-common-sms"

    %% Click Events: Plugin Modules
    click DemoMod "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-modules/ruoyi-demo"
    click GenMod "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-modules/ruoyi-generator"
    click JobMod "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-modules/ruoyi-job"
    click SysMod "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-modules/ruoyi-system"
    click WfMod "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/ruoyi-modules/ruoyi-workflow"

    %% Click Events: Infra Scripts
    click Database "https://github.com/dromara/ruoyi-vue-plus/tree/5.X/script/sql/"
    click Redis "https://github.com/dromara/ruoyi-vue-plus/blob/5.X/script/docker/redis/conf/redis.conf"

    %% Styles
    class User,Frontend frontend
    class Nginx,DockerCompose,RuoYiAdmin,MonitorApp,SnailApp service
    class RuoYiApp,AuthCtrl,IndexCtrl,AppConfig,DockerCompose,DemoMod,GenMod,JobMod,SysMod,WfMod backend
    class Database db
    class Redis cache
    class Minio,SMSMailAuth external
```
