简介

一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。
工作中有很多需要定时执行的任务，比如（每分钟扫描超时支付的订单、每天提醒用户未完成的任务）等等…
在分布式技术横行的时代，选择一个优秀的分布式的任务调度平台尤为重要。
今天介绍的XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

为什么要选择XXL-JOB

对比图

基础概念

  • 调度中心: XXL-JOB-ADMIN 官网提供的调度中心（页面管理）应用
  • 执行器： 开发中实际业务项目

开始使用

配置调度中心

建议使用docker-compose部署，docker-compose文件请点击这里
docker 部署命令如下(摘至官方文档)

1
2
3
4
5
6
7
docker run -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}
/**
* 如需自定义 mysql 等配置，可通过 "-e PARAMS" 指定，参数格式 PARAMS="--key=value  --key2=value2" ；
* 配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties
* 如需自定义 JVM内存参数 等配置，可通过 "-e JAVA_OPTS" 指定，参数格式 JAVA_OPTS="-Xmx512m" ；
*/
docker run -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  -d xuxueli/xxl-job-admin:{指定版本}

如需传统模式安装请查阅官方安装文档

配置执行器项目

依赖引入

在项目pom文件中添加以下依赖

1
2
3
4
5
6
<!-- xxl-job-core -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${xxl-job.version}</version>
</dependency>

执行器配置

在项目的配置文件application.properties or application.yml 中添加以下配置

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

执行器组件配置

向spring托管bean

1
2
3
4
5
6
7
8
9
10
11
12
13
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
    logger.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;
}

创建执行器启动类

1
2
3
4
5
6
7
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

启动应用

注意：启动前需要保证配置文件中xxl.job.admin.addresses 配置项为正确的xxl-job-admin 地址(浏览器访问连接可以看到控制界面)

检查应用是否启动成功

浏览器打开调度中心地址（配置文件中xxl.job.admin.addresses项）,登录查看（默认账号密码为admin/123456）执行器管理中Online机器地址是否有你的应用访问地址
成功后如图所示

如果online没有出现你的机器，请检查配置文件中的appname项与页面中的appname项是否一致，如果不一致，在页面添加一个即可

开始使用

XXL-JOB支持多种任务模式

  • Bean模式
    • Bean模式（类形式）： 优点是兼容性好（无架构项目也可以使用）；缺点是一个任务占用一个Java类，造成类的浪费，且不支持自动注入，需要手动调用注入到执行器容器中（不常用）
    • Bean模式（方法形式）: 优点是自动注入，只需要添加@XxlJob注解即可；缺点是需要Spring容器环境
  • GLUE模式：任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。支持多种语言

Bean模式（类形式）

代码如下

1
2
3
4
5
6
7
public class DemoExecutorClass1JobHandler extends IJobHandler {
    @Override
    public ReturnT<String> execute(String s) throws Exception {
        XxlJobLogger.log("XXL-JOB, DemoExecutorClass1JobHandler 执行."+System.currentTimeMillis());
        return ReturnT.SUCCESS;
    }
}

注意:这种方式需要在main方法中添加XxlJobExecutor.registJobHandler("demoJobHandler", new DemoExecutorClass1JobHandler()); 注册到执行器容器中
这种方式实在不常用，这里不再赘述(没有spring实在是太麻烦了，懒得写)，需要的请查看官方文档

Bean模式（方法形式）

需要注意以下几点：

  • 在Spring Bean实例中，开发Job方法，方式格式要求为public ReturnT<String> execute(String param)
  • 为Job方法添加注解 @XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法") ，注解value值对应的是调度中心新建任务的JobHandler属性的值。
  • 执行日志：需要通过 “XxlJobLogger.log” 打印执行日志；

代码如下

1
2
3
4
5
6
7
8
9
// 注册为bean，被xxl-job发现
@Component
public class DemoExecutorMethodJobHandler {
    @XxlJob(value = "printHelloWorldJobHandler")
    public ReturnT<String> printHelloWorldJobHandler(String param){
        XxlJobLogger.log("DemoExecutorMethodJobHandler Hello World");
        return ReturnT.SUCCESS;
    }
}

GLUE模式(Java)

任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：

  1. 在调度中心新建任务，运行模式选择GLUE模式(Java)
  2. 在任务管理 -> 操作 -> GLUE IDE 中修改代码

测试

任务管理界面添加任务，配置如下

需要注意的几点

  • 执行器请选择正确的执行器（有Online的）
  • JobHandler 对应@XxlJob注解中的value值

启动任务并查看日志，是否正常执行
正常截图如下

参考链接