# xxl-job/xxl-job-admin architecture

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

- Interactive diagram: https://gitdiagram.com/xxl-job/xxl-job-admin
- Repository: https://github.com/xxl-job/xxl-job-admin

## Overview

##### Project Type and Purpose
- XXL-JOB is a full-stack distributed task scheduling platform:
- “xxl-job-admin” – the scheduling center (backend + web UI).
- “xxl-job-core” – the shared library that implements the scheduling protocol, executor registration, job dispatching, callback, and utility classes.
- “xxl-job-executor-samples” – example executor applications (frameless, Spring-Boot) that show how business code plugs into the core.
- Users access the Admin web UI to CRUD jobs; the Admin persists data to a relational database; executors register themselves and receive dispatch commands via REST; job results and logs flow back asynchronously.

##### Main Components
- Web Client (browser)
- Admin Service (Spring Boot + Spring MVC + MyBatis + Freemarker)
- Web Layer (controllers, interceptor, resolver)
- Core Scheduler Engine (XxlJobScheduler, Cron, Trigger Pool, Thread Pools)
- Route/Registry/Alarm Modules
- Service Layer / DAO Layer (MyBatis mappers → RDBMS)
- RDBMS (MySQL/PostgreSQL)
- Executors (one or many instances)
- XxlJobExecutor (core client)
- JobHandler implementations (Java, scripts via GLUE, CLI)
- Registry thread, callback thread, log file cleaner
- External Services
- Email/SMS/3rd-party alarm
- Docker/Kubernetes (container images provided)

##### Relationships and Data Flows
- Users → HTTP → Admin Service (UI) → JDBC → RDBMS
- Admin Scheduler Engine polls job table → computes triggers → pushes HTTP REST calls to Executors
- Executors periodically heart-beat & register → HTTP REST → Admin
- Executors execute business handlers → log files → callback REST → Admin → save logs to RDBMS
- On failure/timeouts → Admin invokes Alarm module → external email/SMS
- GLUE tasks: Admin serves code fragments; executors fetch and compile at runtime.

##### Architectural Patterns & Design Principles
- Center-oriented scheduling (single Admin with HA clustering via DB locks)
- Executor registration & discovery (pull registry list from DB)
- Fully asynchronous flows (scheduling, execution, callback)
- Pluggable routing strategies (round-robin, fail-over, broadcast, consistent-hash)
- Thread-pool isolation for slow vs. fast tasks
- MVC for Web UI; layering (Controller → Service → DAO).
- Cross-language via RESTful API; dynamic job code via GLUE.

##### Technologies & Frameworks
- Spring Boot, Spring MVC
- MyBatis + MyBatis-Mapper XML
- Freemarker templates + static assets (AdminLTE, jQuery, CronGen, CodeMirror)
- Maven multi-module project
- Java concurrency utilities
- Dockerfile for containerization
- RESTful APIs for Admin ↔ Executor

##### Step-by-Step Diagramming
- MVC Web Layer
- Scheduler Core
- Registry & Routing
- Alarm Module
- Service/DAO
3. “Admin Service” → “RDBMS” (MySQL)
- Inside executor: “Registry Thread”, “Callback Thread”, “JobExecutor”
5. Connector from Executor → Admin (“heartbeat/registry”)
6. Connector from Executor → Admin (“execute callback & logs”)
7. Connector Admin → External Alarm Service (“email/SMS”)
8. GLUE code flow: Admin → Executor fetch → compile → run.

Summary

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Users and UI
    User["User/Web Browser"]:::user
    User -->|"HTTP"| AdminUI["Admin Web UI"]:::frontend

    %% Admin Service
    subgraph "Admin Service" 
        direction TB
        AdminApp["XxlJobAdminApplication"]:::backend

        subgraph "Web Layer"
            direction TB
            Controllers["Controllers"]:::frontend
            Interceptor["Interceptor"]:::frontend
            Resolver["Resolver"]:::frontend
        end

        subgraph "Scheduler Core"
            direction TB
            Scheduler["XxlJobScheduler"]:::core
            TriggerPool["JobTriggerPoolHelper"]:::core
            Trigger["XxlJobTrigger"]:::core
        end

        Route["Route/Registry Module"]:::core
        Alarm["Alarm Module"]:::core

        subgraph "Service & DAO Layer"
            direction TB
            Service["Service Interfaces/Impl"]:::backend
            DAO["DAOs (MyBatis)"]:::backend
        end
    end

    %% Database
    AdminApp -->|"JDBC"| DB[(RDBMS)]:::db

    %% Executors
    subgraph "Executors"
        direction TB
        ExecCore["XxlJobExecutor"]:::core
        RegistryThread["ExecutorRegistryThread"]:::core
        CallbackThread["TriggerCallbackThread"]:::core
        LogCleanThread["JobLogFileCleanThread"]:::core
    end

    AdminApp -->|"dispatch (REST)"| ExecCore
    ExecCore -->|"heartbeat/registry (REST)"| AdminApp
    ExecCore -->|"callback & logs (REST)"| AdminApp

    %% External Alarm Service
    AdminApp -->|"alarm (email/SMS)"| ExtAlarm["External Alarm Service"]:::ext

    %% Click events
    click AdminApp "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-admin/src/main/java/com/xxl/job/admin/XxlJobAdminApplication.java"
    click Controllers "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/controller"
    click Interceptor "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/controller/interceptor"
    click Resolver "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/controller/resolver"
    click Scheduler "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/scheduler/XxlJobScheduler.java"
    click TriggerPool "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/thread"
    click Trigger "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/trigger/XxlJobTrigger.java"
    click Route "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/route"
    click DAO "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-admin/src/main/java/com/xxl/job/admin/dao/XxlJobRegistryDao.java"
    click Alarm "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/alarm"
    click AdminApp "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-admin/src/main/java/com/xxl/job/admin/core/alarm/impl/EmailJobAlarm.java"
    click Service "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/java/com/xxl/job/admin/service"
    click DAO "https://github.com/xxl-job/xxl-job-admin/tree/master/xxl-job-admin/src/main/resources/mybatis-mapper"
    click ExecCore "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-core/src/main/java/com/xxl/job/core/executor/XxlJobExecutor.java"
    click RegistryThread "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-core/src/main/java/com/xxl/job/core/thread/ExecutorRegistryThread.java"
    click CallbackThread "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-core/src/main/java/com/xxl/job/core/thread/TriggerCallbackThread.java"
    click LogCleanThread "https://github.com/xxl-job/xxl-job-admin/blob/master/xxl-job-core/src/main/java/com/xxl/job/core/thread/JobLogFileCleanThread.java"

    %% Styles
    classDef user fill:#d0e1f9,stroke:#333,stroke-width:1px
    classDef frontend fill:#a6cee3,stroke:#333,stroke-width:1px
    classDef backend fill:#b2df8a,stroke:#333,stroke-width:1px
    classDef core fill:#33a02c,stroke:#333,stroke-width:1px
    classDef db fill:#fb9a99,stroke:#333,stroke-width:1px
    classDef ext fill:#fdbf6f,stroke:#333,stroke-width:1px
```
