# shuhongfan/sky-take-out architecture

> Architecture diagram of the GitHub repository shuhongfan/sky-take-out, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shuhongfan/sky-take-out
- Repository: https://github.com/shuhongfan/sky-take-out

## Overview

##### Project Type and Purpose
- This is a full-stack “苍穹外卖” (Sky Take-Out) application comprising:
- A Vue+TypeScript admin web app (project-rjwm-admin-vue-ts)
- A Weixin Mini Program client (mp-weixin) for end users
- A Java SpringBoot backend (sky-take-out with sky-common, sky-pojo, sky-server modules)
- Nginx for serving static assets, reverse proxy and load balancing
- Demonstration/sample modules (springcache-demo, etc.) used in training

##### File Structure
- Top-level:
- `.idea`, `PPT`, `Readme.md`, `assets` – training materials
- `mp-weixin` – Weixin Mini Program code
- `nginx-1.20.2` – Nginx distribution, conf for reverse proxy/load balancing
- `project-rjwm-admin-vue-ts` – Admin front-end SPA
- `sky-take-out` – Java backend multi-module Maven project
- `springcache-demo`, other subdirs – demo applications
- Backend follows layered MVC:
- sky-common (constants, exceptions, utils)
- sky-pojo (entities, DTOs, VOs)
- sky-server (controllers, services, mappers, config, tasks, WebSocket)
- Front-ends:
- Admin SPA built with Vue, router, store, Element UI, charts, service worker
- Mini Program built with uni-app components

##### README Insights
- Describes system comprised of:
- 管理端 (Admin): employee/category/dish/setmeal/order management, data statistics, voice reminders
- 用户端 (Mini Program): WeChat login, menu browsing, cart, checkout, order history
- Tech stack:
- User layer: Vue.js, Element UI, ECharts, Weixin Mini Program
- Gateway: Nginx (static, reverse proxy, load balancing)
- Application: SpringBoot, SpringMVC, Spring Task, Spring Cache, JWT, Swagger/Knife4j, MyBatis, WebSocket, Ali OSS, HTTPClient, POI
- Data: MySQL, Redis

##### Main Components
a. Clients:
- Browser (Admin SPA)
- Weixin Mini Program (mp-weixin)
b. Gateway:
- Nginx – serves `/sky` static assets, proxies `/api/` to backend cluster
c. Backend Monolith/Cluster:
- SpringBoot app (`sky-server`) – HTTP REST controllers (/admin/**, /user/**, /notify/**)
- Scheduler (Spring Task) for order status cleanup, reminders
- WebSocket server for live order notifications
- JWT interceptors for admin and user authentication
d. Data Services:
- MySQL – core relational data (employees, categories, dishes, orders, cart, etc.)
- Redis – caching (pagehelper, Spring Cache), session or temporary data
- Ali OSS – image/file storage via HTTPClient
- External Services: WeChat Pay (PayNotifyController), SMS/voice (HttpClientUtil)

##### Relationships and Data Flows
- Admin SPA / Mini Program → Nginx → SpringBoot REST controllers
- Controllers → Services → MyBatis Mappers → MySQL
- Service layer uses Spring Cache/Redis for hot data (e.g., dish listings)
- File uploads/downloads → Ali OSS
- Order events → WebSocket → Mini Program to push live updates
- Scheduled tasks → cleanup stale orders, send reminders via WebSocket or SMS
- Swagger/Knife4j exposes `/doc.html` for API documentation

##### Architectural Patterns & Principles
- Layered MVC architecture in backend (Controller / Service / Mapper)
- Front-end/back-end separation with a gateway (Nginx)
- Stateless JWT-based auth with interceptors
- Caching layer (Redis) for performance
- Asynchronous notifications via WebSocket
- Scheduled tasks via Spring Task for periodic processing
- Externalized configuration (application-dev.yml, application.yml) for environments

##### Important: Detail over breadth
- Break the backend into sub-components: Auth (JWT), Order, Dish, User, Reporting
- Interceptors and tasks as distinct modules
- Service interactions with Redis vs direct DB calls
- Convey load-balancing/upstream if multiple SpringBoot instances are deployed

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "User Layer"
        AdminSPA["Admin SPA"]:::frontend
        MiniProgram["Weixin Mini Program"]:::frontend
    end

    subgraph "Gateway Layer"
        Nginx["Nginx (80)"]:::gateway
    end

    subgraph "Application Layer"
        subgraph "SpringBoot Cluster"
            SkyApp["SkyApplication"]:::backend
            subgraph "Controllers"
                AdminCtrl["Admin API (/admin)"]:::backend
                UserCtrl["User API (/user)"]:::backend
                PayNotify["PayNotify API"]:::backend
            end
            subgraph "Auth"
                JwtAdmin["JwtTokenAdminInterceptor"]:::backend
                JwtUser["JwtTokenUserInterceptor"]:::backend
            end
            subgraph "Service & Data Access"
                Service["Service Layer"]:::backend
                Mapper["MyBatis Mappers"]:::backend
            end
            Task["Scheduler Tasks"]:::backend
            WebSocket["WebSocket Server"]:::backend
            subgraph "Common & POJO Modules"
                CommonModule["sky-common"]:::backend
                PojoModule["sky-pojo"]:::backend
            end
        end
    end

    subgraph "Data Layer"
        MySQL["MySQL DB"]:::database
        Redis["Redis Cache"]:::database
        AliOSS["Ali OSS"]:::cloud
        WCPay["WeChat Pay"]:::cloud
    end

    AdminSPA -->|"/sky static"| Nginx
    MiniProgram --> Nginx
    Nginx -->|"/api/* proxy"| SkyApp

    SkyApp --> AdminCtrl
    SkyApp --> UserCtrl
    SkyApp --> PayNotify
    AdminCtrl --> Service
    UserCtrl --> Service
    PayNotify --> Service
    Service --> Mapper
    Mapper --> MySQL
    Service --> Redis
    PayNotify --> WCPay
    AdminCtrl --> AliOSS
    UserCtrl --> AliOSS

    Task --> AdminCtrl
    Task --> UserCtrl
    Task --> WebSocket
    WebSocket --> MiniProgram

    SkyApp --> JwtAdmin
    SkyApp --> JwtUser

    SkyApp --> CommonModule
    SkyApp --> PojoModule

    classDef frontend fill:#D0E8FF,stroke:#0066CC,color:#003366
    classDef gateway fill:#FFE8C0,stroke:#CC6600,color:#663300
    classDef backend fill:#D0FFD8,stroke:#009933,color:#006622
    classDef database fill:#FFF2CC,stroke:#CC9900,color:#996600
    classDef cloud fill:#E8E8E8,stroke:#888888,color:#555555

    click AdminSPA "https://github.com/shuhongfan/sky-take-out/tree/main/project-rjwm-admin-vue-ts/"
    click MiniProgram "https://github.com/shuhongfan/sky-take-out/tree/main/mp-weixin/"
    click Nginx "https://github.com/shuhongfan/sky-take-out/blob/main/nginx-1.20.2/conf/nginx.conf"
    click SkyApp "https://github.com/shuhongfan/sky-take-out/blob/main/sky-take-out/sky-server/src/main/java/com/sky/SkyApplication.java"
    click AdminCtrl "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-server/src/main/java/com/sky/controller/admin/"
    click UserCtrl "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-server/src/main/java/com/sky/controller/user/"
    click PayNotify "https://github.com/shuhongfan/sky-take-out/blob/main/sky-take-out/sky-server/src/main/java/com/sky/controller/notify/PayNotifyController.java"
    click CommonModule "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-common/src/main/java/com/sky/"
    click PojoModule "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-pojo/src/main/java/com/sky/"
    click Service "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-server/src/main/java/com/sky/service/"
    click Mapper "https://github.com/shuhongfan/sky-take-out/tree/main/sky-take-out/sky-server/src/main/java/com/sky/mapper/"
    click WebSocket "https://github.com/shuhongfan/sky-take-out/blob/main/sky-take-out/sky-server/src/main/java/com/sky/websocket/WebSocketServer.java"
```
