# forever-violet/oce architecture

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

- Interactive diagram: https://gitdiagram.com/forever-violet/oce
- Repository: https://github.com/forever-violet/oce

## Overview

##### Project type and purpose
- This is a full-stack, multi-module examination system (“一键生成考卷系统”) that automates exam creation and management.
- It consists of:
- A Vue3+TypeScript SPA (ocepgen-ui)
- A Spring-Boot admin backend (ocepgen-admin)
- A code-generation service (ocepgen-generator)
- Shared Java libraries (ocepgen-common, ocepgen-dynamic-datasource)
- Persistence (MySQL) and caching (Redis)

##### File structure
- Top-level modules:
- ocepgen-ui: front-end UI, Vite build, static assets, Vue Router & Pinia store
- ocepgen-admin: SpringBoot REST API, layered (controller/service/dao), AOP (logging, data-filter), Quartz jobs, OSS integration, Shiro security
- ocepgen-generator: SpringBoot code-generator service + its own front UI
- ocepgen-common: shared DTOs, utils, Redis config, base service/DAO
- ocepgen-dynamic-datasource: AOP aspect and config for multi-DB dynamic routing
- Docker files and docker-compose.yml suggest containerized deployment.

##### README
- Confirms tech stack: Spring Boot + MyBatis-Plus + Shiro + Quartz + Druid + Vue3 + Element Plus + Vite
- Outlines modules: job, log, oss, security, sys, exam, question, course
- Mentions MySQL initialization and Swagger, and OSS providers (Aliyun, Qiniu, Qcloud)

##### Main components
a. Frontend:
- Browser / ocepgen-ui (Vue3 SPA)
b. Backend services:
- Admin Service (ocepgen-admin SpringBoot)
- Generator Service (ocepgen-generator SpringBoot)
- Shared modules (ocepgen-common, ocepgen-dynamic-datasource)
c. Data stores:
- Primary relational DB (MySQL)
- Redis cache
d. External integrations:
- OSS providers (Aliyun/Qiniu/Qcloud)
- Email SMTP (for notifications)
- Swagger UI (documentation)

##### Relationships and interactions
- UI → Admin Service: HTTP(S)/Axios REST calls (authentication, CRUD, exam generation, scheduling, OSS uploads)
- UI → Generator Service: HTTP calls to generate code templates
- Admin Service → MySQL: MyBatis-Plus mappers
- Admin Service → Redis: caching, data-scope permissions
- Admin Service → OSS cloud: via RestTemplate, dynamic credentials
- Admin Service → Quartz scheduler: triggers DB-backed tasks
- Generator Service → MySQL: reads schema metadata
- Both services reference ocepgen-common and dynamic-datasource libs at build time

##### Architectural patterns and principles
- Layered MVC (Controller → Service → DAO → DB)
- AOP for cross-cutting concerns: logging, data filtering, dynamic datasource switching
- Shared-library pattern: common utils and config extracted into separate modules
- Template-driven code generation (Velocity/VM)
- Microservice-like separation: admin vs. generator, each SpringBoot app can scale independently

##### Must-include
- Arrowheads with verbs or protocols (e.g., “GET /api/courses”, “MQ trigger”, “Redis GET/SET”)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend Layer"
        UI["Browser / ocepgen-ui"]:::frontend
    end

    subgraph "Backend Services"
        Admin["ocepgen-admin<br/>(SpringBoot REST API)"]:::backend
        Gen["ocepgen-generator<br/>(SpringBoot Service)"]:::backend
    end

    subgraph "Shared Libraries"
        Common["ocepgen-common"]:::libs
        DynDS["ocepgen-dynamic-datasource"]:::libs
    end

    subgraph "ocepgen-admin Modules"
        Shiro["ShiroConfig"]:::modules
        Scheduler["ScheduleConfig & Tasks"]:::modules
        OSSMod["OSS Module"]:::modules
        Mappers["MyBatis-Plus Mappers"]:::modules
        RestConf["RestTemplateConfig"]:::modules
        Swagger["SwaggerConfig"]:::modules
        Email["EmailUtils"]:::modules
    end

    subgraph "Data Stores"
        MySQL[(MySQL)]:::db
        Redis[(Redis Cache)]:::db
    end

    subgraph "External Services"
        OSS["OSS Providers<br/>(Aliyun/Qiniu/Qcloud)"]:::external
        SMTP["Email SMTP"]:::external
        SwaggerUI["Swagger UI"]:::external
    end

    UI -->|"REST API\n(GET/POST)"| Admin
    UI -->|"REST API\n(code gen)"| Gen

    Admin -->|"SQL via MyBatis-Plus"| MySQL
    Admin -->|"Redis GET/SET"| Redis
    Admin -->|"Upload via RestTemplate"| OSS
    Admin -->|"Send email\nvia SMTP"| SMTP
    Admin -->|"Expose docs"| SwaggerUI

    Gen -->|"Read schema\ncode templates"| MySQL

    Admin --> Common
    Admin --> DynDS
    Gen   --> Common
    Gen   --> DynDS

    Admin --- Shiro
    Admin --- Scheduler
    Admin --- OSSMod
    Admin --- Mappers
    Admin --- RestConf
    Admin --- Swagger
    Admin --- Email

    click UI "https://github.com/forever-violet/oce/tree/master/ocepgen-ui/"
    click Admin "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/AdminApplication.java"
    click Gen "https://github.com/forever-violet/oce/blob/master/ocepgen-generator/src/main/java/io/ocepgen/GeneratorApplication.java"
    click Common "https://github.com/forever-violet/oce/tree/master/ocepgen-common/src/main/java/io/ocepgen/common/"
    click DynDS "https://github.com/forever-violet/oce/tree/master/ocepgen-dynamic-datasource/src/main/java/io/ocepgen/commons/dynamic/datasource/"
    click MySQL "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/db/mysql.sql"
    click Redis "https://github.com/forever-violet/oce/blob/master/ocepgen-common/src/main/java/io/ocepgen/common/redis/RedisConfig.java"
    click OSSMod "https://github.com/forever-violet/oce/tree/master/ocepgen-admin/src/main/java/io/ocepgen/modules/oss/cloud/"
    click OSSMod "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/modules/oss/controller/SysOssController.java"
    click Scheduler "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/modules/job/config/ScheduleConfig.java"
    click Scheduler "https://github.com/forever-violet/oce/tree/master/ocepgen-admin/src/main/java/io/ocepgen/modules/job/task/"
    click Shiro "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/modules/security/config/ShiroConfig.java"
    click Email "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/common/utils/EmailUtils.java"
    click Swagger "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/common/config/SwaggerConfig.java"
    click RestConf "https://github.com/forever-violet/oce/blob/master/ocepgen-admin/src/main/java/io/ocepgen/common/config/RestTemplateConfig.java"
    click Mappers "https://github.com/forever-violet/oce/tree/master/ocepgen-admin/src/main/resources/mapper/"

    classDef frontend fill:#E3F2FD,stroke:#2196F3
    classDef backend fill:#E8F5E9,stroke:#4CAF50
    classDef db fill:#FFF3E0,stroke:#FF9800
    classDef external fill:#ECEFF1,stroke:#90A4AE
    classDef libs fill:#F3E5F5,stroke:#9C27B0
    classDef modules fill:#F0F4C3,stroke:#AFB42B
```
