How xuxueli/xxl-job works
XXL-JOB is a distributed task-scheduling framework. Users configure and operate jobs through the admin web console; the admin schedules and routes triggers to registered executor instances, which run handlers and report completion for logs, monitoring, and failure alerting. The graph also includes the documented OpenAPI and registration capabilities, plus user/permission management. The README supports the major product flows; source excerpts show selected admin dispatch, executor-log access, and script execution details. Other links are limited to those documented capabilities rather than assumed from module names.
Main entry points: OpenApiController.java Registry API · XxlJobInfoMapper.java Admin Database · JobScheduleHelper.java Schedule Loop · JobInfoController.java Admin Web
Components 21
Admin Console
- Admin Web
xxl-job-admin/src/main/java/com/xxl/job/admin/business/controller/JobInfoController.java - Job Service
xxl-job-admin/src/main/java/com/xxl/job/admin/business/service/XxlJobService.java - Executor Groups
xxl-job-admin/src/main/java/com/xxl/job/admin/business/model/XxlJobGroup.java - User Access
xxl-job-admin/src/main/java/com/xxl/job/admin/framework/controller/JobUserController.java
Scheduling
- Schedule Loop
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/thread/JobScheduleHelper.java - Trigger Dispatch
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/trigger/JobTrigger.java - Executor Routing
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/route/ExecutorRouteStrategyEnum.java - Misfire Handling
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/misfire/MisfireHandler.java - Registry API
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/openapi/OpenApiController.java
Execution
- Executor Runtime
xxl-job-core/src/main/java/com/xxl/job/core/executor/XxlJobExecutor.java - Executor Server
xxl-job-core/src/main/java/com/xxl/job/core/server/EmbedServer.java - Job Handlers
xxl-job-core/src/main/java/com/xxl/job/core/handler/IJobHandler.java - Script Handler
xxl-job-core/src/main/java/com/xxl/job/core/handler/impl/ScriptJobHandler.java - Run Context
xxl-job-core/src/main/java/com/xxl/job/core/context/XxlJobContext.java
Operations
- Admin Database
xxl-job-admin/src/main/java/com/xxl/job/admin/business/mapper/XxlJobInfoMapper.java - Run Logs
xxl-job-admin/src/main/java/com/xxl/job/admin/business/controller/JobLogController.java - Failure Alerts
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/alarm/JobAlarmer.java - Run Reports
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/thread/JobLogReportHelper.java
Other components
- Operator
- Email Service
- Executor Instances
Connections 21
- Operator → Admin Web: configures jobs
README.md - Admin Web → Job Service: manages jobs
README.md - Job Service → Admin Database: persists job data
- Operator → User Access: manages access
README.md - Schedule Loop → Trigger Dispatch: dispatches due jobs
README.md - Schedule Loop → Misfire Handling: handles missed runs
README.md - Trigger Dispatch → Executor Routing: selects executor
README.md - Executor Routing → Executor Instances: routes triggers
README.md - Executor Instances → Registry API: registers addresses
README.md - Registry API → Executor Groups: validates app group
xxl-job-admin/src/main/java/com/xxl/job/admin/business/scheduler/openapi/OpenApiController.java - Executor Instances → Executor Server: hosts runtime
- Executor Server → Executor Runtime: receives job calls
- Executor Runtime → Job Handlers: runs handler
README.md - Job Handlers → Script Handler: supports script jobs
README.md - Script Handler → Run Context: reads run parameters
xxl-job-core/src/main/java/com/xxl/job/core/handler/impl/ScriptJobHandler.java - Executor Instances → Registry API: registers periodically
README.md - Executor Instances → Run Logs: provides rolling logs
README.md - Run Logs → Admin Database: reads run records
xxl-job-admin/src/main/java/com/xxl/job/admin/business/controller/JobLogController.java - Executor Instances → Failure Alerts: reports failures
README.md - Failure Alerts → Email Service: sends notifications
README.md - Run Reports → Admin Database: aggregates run data
README.md