# zccbbg/wms-ruoyi architecture

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

- Interactive diagram: https://gitdiagram.com/zccbbg/wms-ruoyi
- Repository: https://github.com/zccbbg/wms-ruoyi

## Overview

##### Project type and purpose
- This is a full-stack warehouse management system (WMS) backend, built on the RuoYi framework.
- The repo is a multimodule Maven project:
- ruoyi-admin-wms – the Spring Boot WMS service
- ruoyi-common – shared starter libraries (core, web, security, redis, encrypt, excel, mail, etc.)
- ruoyi-modules – domain modules (system management, code generator, demo)
- script – DB scripts and helper shell/batch scripts
- The frontend (Vue 3 + Element UI) lives in a separate repo, communicating with this backend over REST.

##### File structure
- At the top level you see pom.xml orchestrating modules.
- ruoyi-admin-wms follows a classic layered MVC:
- controller (REST endpoints)
- service (business logic)
- mapper (MyBatis XML + interfaces)
- domain: entity ↔ BO ↔ VO
- ruoyi-common modules inject cross-cutting concerns via Spring Boot auto-configuration.
- ruoyi-modules add system management and code-generation capabilities.
- script/sql/wms.sql defines the MySQL schema.
- Configs: application.yml, Redis, JWT, MyBatis, thread pools, i18n, logging (logback-plus.xml).

##### README for additional insights
- Auth: JWT + Spring Security + ruoyi-common-satoken
- Cache/session: Redis + ruoyi-common-redis
- ORM: MyBatis-Plus (ruoyi-common-mybatis)
- External integrations: email (ruoyi-common-mail), SMS (ruoyi-common-sms), OSS, ip2region
- Print: LODOP/web printing
- Code generator: one-click front/backend scaffolding (ruoyi-modules/ruoyi-generator)

##### Details
- I18n resource bundles feeding the web layer
- Config files (application.yml, banner.txt) as part of initialization
- JWT filter chain and dynamic permission loader

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Users & Frontend
    User["User (Browser)"]:::external
    FE["Frontend (Vue3 + Element UI)"]:::external

    User --> FE
    FE -->|REST API Calls| Controller

    %% Backend Spring Boot Service
    subgraph "Spring Boot WMS Backend"
        direction TB
        App["RuoYiApplication"]:::runtime
        subgraph "Configurations"
            direction TB
            YAML["application.yml"]:::runtime
            LogConf["logback-plus.xml"]:::runtime
            I18n["i18n Resources"]:::runtime
            IP2["ip2region.xdb"]:::runtime
        end
        subgraph "Backend Layers"
            direction TB
            Controller["REST Controllers"]:::runtime
            Service["Business Logic Services"]:::runtime
            Mapper["MyBatis Mappers"]:::runtime
            Domain["Domain Model (Entities/BO/VO)"]:::runtime
            XML["MyBatis XML Mappers"]:::runtime
        end
    end

    FE --> Controller
    Controller -->|calls| Service
    Service -->|queries| Mapper
    Mapper -->|executes SQL| DB[(MySQL)]:::runtime
    Service -- Redis Caching & Session --> Redis[(Redis)]:::runtime
    Service -->|send email| SMTP[("SMTP Service")]:::external
    Service -->|send SMS| SMS[("SMS Gateway")]:::external
    Service -->|file upload/download| OSS[("OSS Provider")]:::external
    Service -->|geo lookup| IP2
    Service -->|print tasks| LODOP[("LODOP Print Service")]:::external

    %% Common Libraries
    subgraph "Common Libraries" 
        direction TB
        CommonCore["Core Auto-Config"]:::libs
        AsyncCfg["AsyncConfig"]:::libs
        SaToken["SaTokenConfig"]:::libs
        RedisCfg["RedisConfig"]:::libs
        MybatisCfg["MybatisPlusConfig"]:::libs
        MailCfg["MailConfig"]:::libs
        SmsCfg["SmsConfig"]:::libs
        OssClient["OssClient"]:::libs
    end

    %% Feature Modules
    subgraph "Feature Modules"
        direction TB
        SysMod["System Management Module"]:::libs
        GenMod["Code Generator Module"]:::libs
        DemoMod["Demo Module"]:::libs
    end

    %% Dependencies
    App --> CommonCore
    App --> AsyncCfg
    App --> SaToken
    App --> RedisCfg
    App --> MybatisCfg
    App --> MailCfg
    App --> SmsCfg
    App --> OssClient
    App --> SysMod
    App --> GenMod
    App --> DemoMod

    %% Schema Script
    Script["DB Schema Script (wms.sql)"]:::external
    Script --> DB

    %% Click Events
    click App "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-admin-wms/src/main/java/com/ruoyi/RuoYiApplication.java"
    click Controller "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/java/com/ruoyi/wms/controller"
    click Service "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/java/com/ruoyi/wms/service"
    click Mapper "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/java/com/ruoyi/wms/mapper"
    click Domain "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/java/com/ruoyi/wms/domain"
    click XML "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/resources/mapper/wms"
    click YAML "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-admin-wms/src/main/resources/application.yml"
    click LogConf "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-admin-wms/src/main/resources/logback-plus.xml"
    click I18n "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-admin-wms/src/main/resources/i18n"
    click IP2 "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-admin-wms/src/main/resources/ip2region.xdb"
    click Script "https://github.com/zccbbg/wms-ruoyi/blob/master/script/sql/wms.sql"
    click CommonCore "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/config"
    click AsyncCfg "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/config/AsyncConfig.java"
    click SaToken "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-satoken/src/main/java/com/ruoyi/common/satoken/config/SaTokenConfig.java"
    click RedisCfg "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-redis/src/main/java/com/ruoyi/common/redis/config/RedisConfig.java"
    click MybatisCfg "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-mybatis/src/main/java/com/ruoyi/common/mybatis/config/MybatisPlusConfig.java"
    click MailCfg "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-mail/src/main/java/com/ruoyi/common/mail/config/MailConfig.java"
    click SmsCfg "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-sms/src/main/java/com/ruoyi/common/sms/config/SmsConfig.java"
    click OssClient "https://github.com/zccbbg/wms-ruoyi/blob/master/ruoyi-common/ruoyi-common-oss/src/main/java/com/ruoyi/common/oss/core/OssClient.java"
    click SysMod "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-modules/ruoyi-system/src/main/java/com/ruoyi/system"
    click GenMod "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-modules/ruoyi-generator/src/main/java/com/ruoyi/generator"
    click DemoMod "https://github.com/zccbbg/wms-ruoyi/tree/master/ruoyi-modules/ruoyi-demo/src/main/java/com/ruoyi/demo"
    click Script "https://github.com/zccbbg/wms-ruoyi/blob/master/script/bin/ry.sh"
    click Script "https://github.com/zccbbg/wms-ruoyi/blob/master/script/bin/ry.bat"

    %% Styles
    classDef runtime fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef libs fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
```
