XXL-JOB任务调度平台入门教程

一、简介

1.1 概述

XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

1.2 下载

文档地址

• 中文文档
• English Documentation

源码仓库地址

源码仓库地址	Release Download
https://github.com/xuxueli/xxl-job	Download
http://gitee.com/xuxueli0323/xxl-job	Download

中央仓库地址

截止于2022/4/2 最新版为2.3.0

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

1.3 环境

• Maven3+
• Jdk1.8+
• Mysql5.7+

---

二、快速入门

xxl-job主要分为调度中心、执行器两部分

2.1 初始化“调度数据库”（即xxl-job所依赖数据库）

请下载项目源码，获取 “调度数据库初始化SQL脚本” 并执行即可。

“调度数据库初始化SQL脚本” 位置为:

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

2.2 配置部署“调度中心”

调度中心项目：xxl-job-admin

作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

步骤一 调度中心配置

调度中心配置文件地址：

/xxl-job/xxl-job-admin/src/main/resources/application.properties

调度中心配置内容：

将数据库连接配置更改为自己的配置
其余配置默认或者按需配置即可

步骤二 部署调度中心

通过XxlJobAdminApplication启动类启动调度中心

调度中心客户端 http://localhost:8080/xxl-job-admin

默认登录账号 “admin/123456” , 登录后运行界面如下图所示。

至此“调度中心”项目已经部署成功。

2.3 配置部署“执行器”

“执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。
执行器其实就是具体定时任务的实现，换个角度讲也就是我们实际的项目，所以配置执行器就是在我们的项目中进行相关配置

步骤一：引入maven依赖

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

步骤二：执行器配置

执行器配置文件地址：

项目的配置文件

执行器配置内容：

配置中心地址如果不进行配置 可以在新增执行器时选择手动录入

步骤三：执行器组件配置

执行器组件配置内容:

@Slf4j
@ConditionalOnProperty(prefix = "job", value = "enable", matchIfMissing = true)
@Configuration
public class XxlJobConfig {

    @Value("${jhjcn.job.adminAddresses}")
    private String adminAddresses;

    @Value("${jhjcn.job.accessToken}")
    private String accessToken;

    @Value("${jhjcn.job.executor.appname}")
    private String appName;

    @Value("${jhjcn.job.executor.address}")
    private String address;

    @Value("${jhjcn.job.executor.ip}")
    private String ip;

    @Value("${jhjcn.job.executor.port}")
    private int port;

    @Value("${jhjcn.job.executor.logpath}")
    private String logPath;

    @Value("${jhjcn.job.executor.logretentiondays}")
    private int logRetentionDays;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appName);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        return xxlJobSpringExecutor;
    }
}

执行器组件是否开启：

### enable中的true||false来控制是否启用XxlJobConfig.java中的配置注入
job:
  enable: true

步骤四：添加执行任务

XxlJob简单任务示例（Bean模式）

@Component
public class 类名 {
    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
    }
}

步骤五：启动执行器

执行器启动成功 即执行器配置完成

步骤六：执行器集群（可选）

执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。

执行器集群部署时，几点要求和建议：

• 执行器回调地址即调度中心地址（xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作。
• 如果调度中心地址是集群 建议调度中心配置统一域名
• 同一个执行器集群内AppName（xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表。
• xxl-job客户端新增任务时在高级配置–>路由配置 选择相应集群策略

---

三、简要操作

登录任务调度中心

执行器管理 -》新建执行器

• AppName为项目中执行器配置属性appName 名
• 名称 自定义的执行器名称
• 注册方式 如果执行器配置xxl.job.admin.addresses中配置了 可以选择自动注册 否则手动录入

任务管理-》新建任务

• 执行器 选择所需执行器
• Cron 配置定时规则
• 运行模式默认选Bean
• JobHandler 执行器项目中@XxlJob注解中指定的名字
• 路由策略 执行器集群时 可以按需选择

调度日志 -》查看日志

• 默认当天日志 ，可按时间筛选

• 可以查看日志详情

• 项目中日志打印

  XxlJobHelper.log("XXL-JOB, Hello World.");
  

---

四、配置说明

4.1调度中心配置

### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
### 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN
## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

4.2 执行器配置（properties）

### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=
### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

4.3 执行器配置（yml）

jhjcn:
  job:
    ### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注		册"和"任务结果回调"；为空则关闭自动注册；
    adminAddresses: http://127.0.0.1:8080/xxl-job-admin
    ### 执行器通讯TOKEN [选填]：非空时启用；
    accessToken:
    executor:
      ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      appName: xxl-job-executor-sample
      ### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: 9999
      ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logPath: /data/applogs/xxl-job/jobhandler
      ### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logRetentionDays: 30

---

五、参考资料

调度中心报警邮箱配置参考