XXL-JOB

https://www.xuxueli.com/xxl-job
Admin
XXL-JOB is a distributed task scheduling platform that enables rapid development, simple learning,...
Tokens:22,436
Snippets:229
Trust Score:8.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start XXL-JOB with Docker Compose

Source: https://www.xuxueli.com/xxl-job

Starts and stops the XXL-JOB services using Docker Compose. Ensure you have configured the .env file in the ./docker directory.

```bash
// 启动 
docker compose up -d
  
// 停止
docker compose down
```

--------------------------------

### Executor Configuration Example

Source: https://www.xuxueli.com/xxl-job

This example shows the configuration properties for an executor in XXL-Job, including AppName, Name, Sort, Registration Method, and Machine Address.

```text
1.     AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
2.     名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
3.     排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
4.     注册方式：调度中心获取执行器地址的方式；
5.         自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
6.         手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
7.     机器地址:"注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；注册地址格式可参考“http://127.0.0.1:9999/”，为执行器内嵌服务地址；
```

--------------------------------

### Docker Compose for XXL-JOB

Source: https://www.xuxueli.com/xxl-job

This snippet shows the commands to download, build, configure, and run XXL-JOB using Docker Compose. Ensure you have Docker and Maven installed.

```bash
// Download XXL-JOB
git clone --branch "$(curl -s https://api.github.com/repos/xuxueli/xxl-job/releases/latest | jq -r .tag_name)" https://github.com/xuxueli/xxl-job.git
// Build XXL-JOB
mvn clean package -Dmaven.test.skip=true
// Configure XXL-JOB (go to docker directory, customize .env)
cd ./docker
cat .env
// Start XXL-JOB
docker compose up -d
// Stop XXL-JOB
docker compose down
```

--------------------------------

### XXL-Job Project Structure Overview

Source: https://www.xuxueli.com/xxl-job

This outlines the main modules within the XXL-Job source code. The 'xxl-job-executor-samples' directory contains examples for creating executor instances.

```text
1. xxl-job-admin：调度中心
2. xxl-job-core：公共依赖
3. xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
4.     ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
5.     ：xxl-job-executor-sample-frameless：无框架版本；
```

--------------------------------

### Configure HTTP Job Handler Parameters

Source: https://www.xuxueli.com/xxl-job

Example configuration for the generic HTTP job handler, demonstrating how to set various request parameters including URL, method, content type, headers, cookies, timeout, data, form parameters, and authentication.

```json
{
    "url": "http://www.baidu.com",
    "method": "POST",
    "contentType": "application/json",
    "headers": {
        "header01": "value01"
    },
    "cookies": {
        "cookie01": "value01"
    },
    "timeout": 3000,
    "data": "request body data",
    "form": {
        "key01": "value01"
    },
    "auth": "auth data"
}
```

--------------------------------

### NodeJS Script Task Example

Source: https://www.xuxueli.com/xxl-job

Example of a NodeJS script task. The executor manages the script execution, output logging, and success/failure determination via exit code.

```javascript
console.log("Running NodeJS Task");
process.exit(0);
```

--------------------------------

### Get Sharding Parameters in Java

Source: https://www.xuxueli.com/xxl-job

Demonstrates how to retrieve sharding parameters within a Java task (Bean or GLUE mode). Use XxlJobHelper to get the current shard index and total shard count.

```java
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();
```

--------------------------------

### PHP Script Task Example

Source: https://www.xuxueli.com/xxl-job

Example of a PHP script task. The executor handles the execution, logging, and status determination based on the script's exit code.

```php
<?php
echo "Running PHP Task";
exit(0);
?>
```

--------------------------------

### Ollama Chat Job Handler Parameters

Source: https://www.xuxueli.com/xxl-job

Configure OllamaChat tasks by specifying input, prompt, and model. Ensure the specified model is installed locally via Ollama.

```json
{
  "input": "{输入信息，必填信息}",
  "prompt": "{模型prompt，可选信息}",
  "model": "{模型实现，如qwen3.5:0.8b，可选信息}"
}
```

--------------------------------

### XXL-Job Scheduler Center Configuration Properties

Source: https://www.xuxueli.com/xxl-job

This file contains essential configurations for the XXL-Job scheduler center, including database connection, email settings, and performance tuning parameters. Ensure the JDBC URL matches your database setup.

```properties
1. ### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
2. spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
3. spring.datasource.username=root
4. spring.datasource.password=root_pwd
5. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
6.   7. ### 报警邮箱
8. spring.mail.host=smtp.qq.com
9. spring.mail.port=25
10. spring.mail.username=xxx@qq.com
11. spring.mail.from=xxx@qq.com
12. spring.mail.password=xxx
13. spring.mail.properties.mail.smtp.auth=true
14. spring.mail.properties.mail.smtp.starttls.enable=true
15. spring.mail.properties.mail.smtp.starttls.required=true
16. spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
17.   18. ### 调度中心通讯TOKEN [必填]：安全性校验；
19. xxl.job.accessToken=
20.   21. ### 调度中心通讯超时时间[选填]，单位秒；默认3s；
22. xxl.job.timeout=3
23.   24. ### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
25. xxl.job.i18n=zh_CN
26.   27. ## 调度线程池最大线程配置【必填】
28. xxl.job.triggerpool.fast.max=300
29. xxl.job.triggerpool.slow.max=200
30.   31. ### 调度触发后，批量更新任务批次数量【必填】
32. xxl.job.schedule.batchsize=100
33.   34. ### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
35. xxl.job.logretentiondays=30
```

--------------------------------

### Shell Script Task Example

Source: https://www.xuxueli.com/xxl-job

Example of a Shell script task. The script is executed by the executor, and its output is logged. The exit code determines the task's success or failure.

```shell
#!/bin/bash
echo "Running Shell Task"
exit 0
```

--------------------------------

### Python Script Task Example

Source: https://www.xuxueli.com/xxl-job

Example of a Python script task. Similar to Shell, the executor runs the script, logs its output, and uses the exit code for status.

```python
print("Running Python Task")
exit(0)
```

--------------------------------

### HTTP Job Handler Custom Parameters

Source: https://www.xuxueli.com/xxl-job

Example of configuring custom parameters for the generic HTTP task handler (httpJobHandler). This allows for flexible integration with external HTTP services.

```text
1. url: http://www.xxx.com
2. method: get 或 post
3. data: post-data
```

--------------------------------

### PowerShell Script Task Example

Source: https://www.xuxueli.com/xxl-job

Example of a PowerShell script task. The executor executes the script, captures its output for logging, and uses the exit code to determine the task's outcome.

```powershell
Write-Host "Running PowerShell Task"
exit 0
```

--------------------------------

### Get Sharding Parameters in Script Tasks

Source: https://www.xuxueli.com/xxl-job

Shows how to access sharding parameters in script-based tasks (Shell, Python, etc.). The parameters are passed as command-line arguments: task parameters, shard index, and total shards.

```shell
echo "分片序号 index = $2"
echo "分片总数 total = $3"
```

--------------------------------

### AI Executor Configuration Properties

Source: https://www.xuxueli.com/xxl-job

Configure AI executor properties, including Ollama base URL, chat enablement, model options, and Dify API settings. Ensure local model installation for Ollama and obtain correct API keys and URLs from Dify.

```properties
// ollama 配置
spring.ai.ollama.base-url=http://localhost:11434
spring.ai.ollama.chat.enabled=true
// Model模型配置；注意，此处配置模型版本、必须本地先通过ollama进行安装运行。
spring.ai.ollama.chat.options.model=qwen2.5:1.5b
spring.ai.ollama.chat.options.temperature=0.8
  
// dify 配置；选择相关 workflow 应用，切换 “访问API” 页面获取 url 地址信息. 
dify.base-url=http://localhost/v1
// dify api-key；选择相关 workflow 应用并进入 “访问API” 页面，右上角 “API 密钥” 入口获取 api-key。
dify.api-key={自行获取并修改}
```

--------------------------------

### Dify Workflow Job Handler Parameters

Source: https://www.xuxueli.com/xxl-job

For DifyWorkflow tasks, provide inputs, user identifier, Dify base URL, and API key. The 'inputs' parameter is workflow-specific and should be defined in the Dify workflow's 'Start' node.

```json
{
  "inputs":{
      "input":"{用户输入信息}"          // 该参数为示例变量，需要 workflow 的“开始”节点 自定义参数 “input”，可自行调整或删除。
  },
  "user": "xxl-job",                  // 用户标识，选填
  "baseUrl": "http://localhost/v1",   // Dify应用的 访问API 地址，需要从 Dify 系统获取；
  "apiKey": "xxx"                     // Dify应用的 API-Key，需要从 Dify 系统获取；
}
```

--------------------------------

### View Execution Log API

Source: https://www.xuxueli.com/xxl-job

Retrieves the execution logs for a specific task, supporting incremental loading. The request requires log ID, log date time, and the starting line number for the log content. Access token and AppName are required in the header. The response includes the log content and status.

```json
{
    "logId":0,          // 本次调度日志ID
    "logDateTime":0,    // 本次调度日志时间
    "fromLineNum":0     // 日志开始行号，滚动加载日志
}
```

```json
{
    "code":200,         // 200 表示正常、其他失败
    "msg": null,        // 错误提示消息
    "content":{
        "fromLineNum":0,        // 本次请求，日志开始行数
        "toLineNum":100,        // 本次请求，日志结束行号
        "logContent":"xxx",     // 本次请求日志内容
        "isEnd":true            // 日志是否全部加载完
    }
}
```

--------------------------------

### XXL-Job Scheduler Database Initialization SQL Script

Source: https://www.xuxueli.com/xxl-job

This is the SQL script required to initialize the database for the XXL-Job scheduler. Ensure your MySQL instance is configured correctly before execution.

```sql
1. /xxl-job/doc/db/tables_xxl_job.sql
```

--------------------------------

### Task Development with XxlJobHelper

Source: https://www.xuxueli.com/xxl-job

Illustrates the modern approach to task development using XxlJobHelper for parameter retrieval and result handling. This replaces older components like ShardingUtil and XxlJobLogger.

```java
1. @XxlJob("demoJobHandler")
2. public void execute() {
3. String param = XxlJobHelper.getJobParam();    // 获取参数
4. XxlJobHelper.handleSuccess();                 // 设置任务结果
5. }
```

--------------------------------

### AI Executor Sample Initialization SQL

Source: https://www.xuxueli.com/xxl-job

SQL script to insert the AI Executor sample into the xxl_job_group table. This is used for initializing the AI Executor in the system.

```sql
1.   INSERT INTO `xxl_job_group`(`app_name`, `title`, `address_type`, `address_list`, `update_time`)
       VALUES ('xxl-job-executor-sample-ai', 'AI执行器Sample', 0, NULL, now());
```

--------------------------------

### Build XXL-JOB Admin Docker Image

Source: https://www.xuxueli.com/xxl-job

Commands to build the XXL-JOB admin Docker image. Customize application properties, JVM memory, and log directories using environment variables.

```bash
mvn clean package
```

```bash
docker build -t xuxueli/xxl-job-admin:{指定版本} ./xxl-job-admin
```

```bash
docker run -d \
-e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" \
-p 8080:8080 \
-v /tmp:/data/applogs \
--name xxl-job-admin \
xuxueli/xxl-job-admin:{指定版本}
```

--------------------------------

### Build XXL-JOB Project

Source: https://www.xuxueli.com/xxl-job

Builds the XXL-JOB project using Maven. It's recommended to run this command from the project's root directory and skip tests.

```bash
// 注意：如下命令需要在项目仓库根目录执行
mvn clean package -Dmaven.test.skip=true
```

--------------------------------

### Initialize User Passwords to '123456' (SHA256 Encrypted)

Source: https://www.xuxueli.com/xxl-job

SQL command to update existing user passwords to a default value ('123456') using SHA256 encryption. This is part of the security upgrade from MD5 to Sha256 for password hashing. The username placeholder needs to be replaced with the actual username.

```sql
UPDATE xxl_job_user t SET t.password = '8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92' WHERE t.username = {用户名};
```

--------------------------------

### XXL-Job Executor Configuration Properties

Source: https://www.xuxueli.com/xxl-job

Configure the executor's connection to the admin center, app name, and other operational parameters. Ensure these properties are set correctly in your application.properties file.

```properties
xxl.job.admin.addresses=http://127.0.0.1:8080
xxl.job.admin.timeout=3
xxl.job.executor.enabled=true
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.accessToken=default_token
xxl.job.executor.ip=
xxl.job.executor.port=9999
xxl.job.executor.address=
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
xxl.job.executor.logretentiondays=30
xxl.job.executor.excludedpackage=org.springframework,spring
xxl.job.executor.glueenabled=true
```

--------------------------------

### Method-based Task Development in Xxl-Job

Source: https://www.xuxueli.com/xxl-job

Demonstrates how to develop tasks using a method-based approach with the @XxlJob annotation. This replaces the older JobHandler class-based development.

```java
1. @XxlJob("demoJobHandler")
2. public ReturnT<String> execute(String param) {
3.   XxlJobLogger.log("hello world");
4.   return ReturnT.ofSuccess();
5. }
```

--------------------------------

### Database Upgrade Scripts for Executor Access Token

Source: https://www.xuxueli.com/xxl-job

SQL scripts for upgrading the XXL-JOB database to support executor access tokens, including adding a new column and creating a unique index.

```sql
-- 1. Add access_token column
ALTER TABLE `xxl_job_group` 
ADD COLUMN `access_token` varchar(255) DEFAULT NULL COMMENT '执行器AccessToken' AFTER `address_list`;

-- 2. Create unique index for app_name
ALTER TABLE `xxl_job_group` 
ADD UNIQUE KEY `i_app_name` (`app_name`) USING BTREE;

-- 3. Update access_token for a specific AppName
UPDATE `xxl_job_group`
SET `access_token` = '<新Token值>'
WHERE `app_name` = '<目标AppName>';

```

--------------------------------

### Run XXL-Job Admin Docker Container

Source: https://www.xuxueli.com/xxl-job

This command runs the XXL-Job admin Docker container. You can customize configurations using the -e PARAMS argument and JVM options with -e JAVA_OPTS. Log directory can be specified with -e LOG_HOME.

```bash
1. /**
2. * 如需自定义 “项目配置文件” 中配置项，比如 mysql 配置，可通过 "-e PARAMS" 指定，参数格式: -e PARAMS="--key=value --key2=value2"；
3. * （配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties）
4. * 如需自定义 “JVM内存参数”，可通过 "-e JAVA_OPTS" 指定，参数格式: -e JAVA_OPTS="-Xmx512m"
5. * 如需自定义 “日志文件目录”，可通过 "-e LOG_HOME" 指定，参数格式: -e LOG_HOME=/data/applogs
6. */
7. docker run -d \
8. -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" \
9. -p 8080:8080 \
10. -v /tmp:/data/applogs \
11. --name xxl-job-admin \
12. xuxueli/xxl-job-admin:{指定版本}
```

--------------------------------

### Clone XXL-JOB Repository

Source: https://www.xuxueli.com/xxl-job

Clones the XXL-JOB repository using the latest release tag fetched from GitHub.

```bash
git clone --branch "$(curl -s https://api.github.com/repos/xuxueli/xxl-job/releases/latest | jq -r .tag_name)" https://github.com/xuxueli/xxl-job.git
```

--------------------------------

### XXL-JOB Source Code Directory Structure

Source: https://www.xuxueli.com/xxl-job

This snippet outlines the main directories within the XXL-JOB project, indicating the purpose of each directory for documentation, database scripts, scheduler center, core dependencies, and sample executors.

```plaintext
1. - /doc :文档资料
2. - /db :“调度数据库”建表脚本
3. - /xxl-job-admin :调度中心，项目源码
4. - /xxl-job-core :公共Jar依赖
5. - /xxl-job-executor-samples :执行器，Sample示例项目（大家可以在该项目上进行开发，也可以将现有项目改造生成执行器项目）
```

--------------------------------

### Database Upgrade Scripts for XXL-JOB

Source: https://www.xuxueli.com/xxl-job

SQL scripts for upgrading the XXL-JOB database, including adding indexes, modifying field lengths, and changing data types for improved performance and capacity.

```sql
-- 1. Add index to job log table
create index I_jobgroup on xxl_job_log (job_group);

-- 2. Modify field length for executor table
alter table xxl_job_group
    modify title varchar(64) not null comment '执行器名称';

-- 3. Modify auto-increment ID type for executor registry table
alter table xxl_job_registry
    modify id bigint(20)   NOT NULL AUTO_INCREMENT;

-- 4. Modify field length for job table
alter table xxl_job_info
    modify executor_param text null comment '任务参数';

-- 5. Modify field length for log table
alter table xxl_job_log
    modify executor_param text null comment '任务参数';
```

--------------------------------

### OpenClaw Job Handler Parameters

Source: https://www.xuxueli.com/xxl-job

Configure OpenClaw tasks by providing input and prompt information. This handler is suitable for tasks requiring custom prompts and inputs.

```json
{
  "input": "{输入信息，必填信息}",
  "prompt": "{模型prompt，可选信息}"
}
```

--------------------------------

### GLUE Mode (Java) Task Handler

Source: https://www.xuxueli.com/xxl-job

Illustrates a GLUE mode task in Java. The code is loaded and instantiated by the executor, with Spring services injected if declared. The execute method runs the task logic.

```java
public class MyGlueJobHandler extends IJobHandler {
    @Override
    public ReturnT<String> execute(String... params) throws Exception {
        // Task logic here
        return ReturnT.SUCCESS;
    }
}
```

--------------------------------

### XXL-JOB Database Table Descriptions

Source: https://www.xuxueli.com/xxl-job

This snippet lists and briefly describes the purpose of each table in the XXL-JOB scheduling database, essential for configuring and understanding the system's data storage.

```plaintext
1. - xxl_job_lock：任务调度锁表；
2. - xxl_job_group：执行器信息表，维护任务执行器信息；
3. - xxl_job_info：调度扩展信息表： 用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
4. - xxl_job_log：调度日志表： 用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
5. - xxl_job_log_report：调度日志报表：用户存储XXL-JOB任务调度日志的报表，调度中心报表功能页面会用到；
6. - xxl_job_logglue：任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
7. - xxl_job_registry：执行器注册表，维护在线的执行器和调度中心机器地址信息；
8. - xxl_job_user：系统用户表；
```

--------------------------------

### Task Scheduling Log Details

Source: https://www.xuxueli.com/xxl-job

This details the fields and their meanings within the task scheduling log in XXL-Job, including timestamps, results, parameters, and execution information.

```text
1.     调度时间:"调度中心"触发本次调度并向"执行器"发送任务执行信号的时间；
2.     调度结果:"调度中心"触发本次调度的结果，200表示成功，500或其他表示失败；
3.     调度备注:"调度中心"触发本次调度的日志信息；
4.     执行器地址：本次任务执行的机器地址
5.     运行模式：触发调度时任务的运行模式，运行模式可参考章节 "三、任务详解"；
6.     任务参数：本地任务执行的入参
7.     执行时间:"执行器"中本次任务执行结束后回调的时间；
8.     执行结果:"执行器"中本次任务执行的结果，200表示成功，500或其他表示失败；
9.     执行备注:"执行器"中本次任务执行的日志信息；
10.     操作：
11.         "执行日志"按钮：点击可查看本地任务执行的详细日志信息；详见“4.8 查看执行日志”；
12.         "终止任务"按钮：点击可终止本地调度对应执行器上本任务的执行线程，包括未执行的阻塞任务一并被终止；
```

--------------------------------

### Trigger Task API

Source: https://www.xuxueli.com/xxl-job

Initiates the execution of a specific task on the executor. This API requires detailed parameters in the request body, including Job ID, handler, parameters, block strategy, timeout, log details, glue type, and sharding information. Access token and AppName are required in the header.

```json
{
    "jobId":1,                                  // 任务ID
    "executorHandler":"demoJobHandler",         // 任务标识
    "executorParams":"demoJobHandler",          // 任务参数
    "executorBlockStrategy":"COVER_EARLY",      // 任务阻塞策略，可选值参考 com.xxl.job.core.constant.ExecutorBlockStrategyEnum
    "executorTimeout":0,                        // 任务超时时间，单位秒，大于零时生效
    "logId":1,                                  // 本次调度日志ID
    "logDateTime":1586629003729,                // 本次调度日志时间
    "glueType":"BEAN",                          // 任务模式，可选值参考 com.xxl.job.core.glue.GlueTypeEnum
    "glueSource":"xxx",                         // GLUE脚本代码
    "glueUpdatetime":1586629003727,             // GLUE脚本更新时间，用于判定脚本是否变更以及是否需要刷新
    "broadcastIndex":0,                         // 分片参数：当前分片
    "broadcastTotal":0                          // 分片参数：总分片
}
```

```json
{
  "code": 200,      // 200 表示正常、其他失败
  "msg": null       // 错误提示消息
}
```

--------------------------------

### View Execution Log

Source: https://www.xuxueli.com/xxl-job

Retrieves job logs, supporting scroll loading. Requires log details and line number in the request body.

```APIDOC
## View Execution Log

### Description
Retrieves job logs, supporting scroll loading.

### Method
POST

### Endpoint
{executor_root_address}/log

### Headers
- **XXL-JOB-ACCESS-TOKEN** (string) - Request token
- **XXL-JOB-APPNAME** (string) - Executor AppName

### Request Body
- **logId** (integer) - Required - The log ID for this scheduling.
- **logDateTime** (integer) - Required - The timestamp for this scheduling.
- **fromLineNum** (integer) - Required - The starting line number for log retrieval (for scroll loading).

### Response
#### Success Response (200)
- **code** (integer) - 200 for success, other values indicate failure.
- **msg** (string) - Error message if any.
- **content** (object)
  - **fromLineNum** (integer) - The starting line number for this request.
  - **toLineNum** (integer) - The ending line number for this request.
  - **logContent** (string) - The log content for this request.
  - **isEnd** (boolean) - Indicates if all logs have been loaded.
```

--------------------------------

### Maven Dependency for XXL-JOB Core

Source: https://www.xuxueli.com/xxl-job

Add this dependency to your Maven project to include the XXL-JOB core library. Replace ${最新稳定版本} with the latest stable version.

```xml
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${最新稳定版本}</version>
</dependency>
```

--------------------------------

### HTTP Job Handler Task Parameters

Source: https://www.xuxueli.com/xxl-job

For the HTTP Job Handler, provide request details such as URL, method, content type, headers, cookies, timeout, and data. This handler is language and platform agnostic.

```json
// 1、简单示例：
{
    "url": "http://www.baidu.com",
    "method": "GET",
    "data": "hello world"
}
  
// 2、完整参数示例：
{
    "url": "http://www.baidu.com",              // 请求URL
    "method": "POST",                           // 请求方法，支持：GET、POST、HEAD、OPTIONS、PUT、DELETE、TRACE
    "contentType": "application/json",          // 请求内容类型，支持：application/json、application/x-www-form-urlencoded、application/xml、text/html、text/xml、text/plain
    "headers": {                                // 请求Header，key-value结构
        "header01": "value01"
    },
    "cookies": {                                // 请求Cookie，key-value结构
        "cookie01": "value01"
    },
    "timeout": 3000,                            // 请求超时时间，默认 3000；单位：毫秒；
    "data": "request body data",                // 请求Body数据，仅针对 POST 请求有效
    "form": {                                   // 请求Form数据，仅针对 GET 请求有效
        "key01": "value01"
    },
    "auth": "auth data"                         // 请求认证信息, 通过Basic Auth方式认证
}
```

--------------------------------

### GLUE Mode (Python) Task Code

Source: https://www.xuxueli.com/xxl-job

This is a Python script used for GLUE mode tasks in XXL-Job. It's developed and managed via the GLUE task's Web IDE.

```python
# Example Python script for GLUE mode
print("Hello from Python GLUE task!")
```

--------------------------------

### Define a BEAN Mode Job Method

Source: https://www.xuxueli.com/xxl-job

In your Spring Bean instance, develop a Job method and annotate it with @XxlJob. The 'value' attribute corresponds to the JobHandler name in the scheduling center. Use XxlJobHelper.log for logging and XxlJobHelper.handleFail/handleSuccess to manage task results.

```java
// 可参考Sample示例执行器中的 "com.xxl.job.executor.jobhandler.SampleXxlJob" ，如下：
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
    XxlJobHelper.log("XXL-JOB, Hello World.");
}
```

--------------------------------

### Scheduler Center RESTful API

Source: https://www.xuxueli.com/xxl-job

Provides API endpoints for managing tasks and executors within the XXL-JOB scheduler center.

```APIDOC
## Scheduler Center RESTful API

### Description
APIs for the scheduler center to manage tasks and executors.

### Endpoints

#### a) Task Callback

##### Description
Endpoint for the executor to report task execution status back to the scheduler center.

##### Method
POST

##### Endpoint
`/callback` (Example, actual endpoint may vary)

#### b) Executor Registration

##### Description
Endpoint for an executor to register itself with the scheduler center.

##### Method
POST

##### Endpoint
`/register` (Example, actual endpoint may vary)

#### c) Executor Registration Removal

##### Description
Endpoint for an executor to de-register itself from the scheduler center.

##### Method
POST

##### Endpoint
`/remove` (Example, actual endpoint may vary)

```

--------------------------------

### GLUE Mode (NodeJS) Task Code

Source: https://www.xuxueli.com/xxl-job

This is a NodeJS script used for GLUE mode tasks in XXL-Job. It's developed and managed via the GLUE task's Web IDE.

```javascript
// Example NodeJS script for GLUE mode
console.log('Hello from NodeJS GLUE task!');
```

--------------------------------

### XXL-JOB Callback Service API Location

Source: https://www.xuxueli.com/xxl-job

This snippet indicates the specific Java controller class and method within the xxl-job-admin module that handles the callback service API for logging results from executors to the scheduler center.

```plaintext
1. xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback
```
Tokens:
Raw