分布式任务调度平台XXL-JOB搭建教程

　　关于分布式任务调度平台XXL-JOB，其实作者 许雪里 在其发布的中文教程中已经介绍的很清楚了，这里我就不做过多的介绍了，关于其搭建教程，本人依照其文档搭建起来基本上也没遇到啥问题，这里通过博客的形式记录下来。

1、源码下载地址

　　①、GitHub：https://github.com/xuxueli/xxl-job

　　②、码云：https://gitee.com/xuxueli0323/xxl-job

2、文档地址

　　①、中文文档：http://www.xuxueli.com/xxl-job/#/

　　②、英文文档：http://www.xuxueli.com/xxl-job/en/#/

3、源码结构

　　通过上面给出的源码下载地址，我们将源码clone到IDEA中，如下：

　　

4、初始化数据库

　　初始化脚本在上面源码目录的  /doc/db/tables_xxl_job.sql ，将此脚本在MySQL数据库中执行一遍。

　　执行完毕，会在MySQL数据库中生成如下 16 张表：

　　

5、配置调度中心

 　　调度中心就是源码中的 xxl-job-admin 工程，我们需要将其配置成自己需要的调度中心，通过该工程我们能够以图形化的方式统一管理任务调度平台上调度任务，负责触发调度执行。

①、修改调度中心配置文件

　　文件地址：/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties

　　配置文件说明：

 1 ### 1、调度中心项目的端口号以及访问路径
 2 server.port=8080
 3 server.context-path=/xxl-job-admin
 4 
 5 ### 2、配置静态文件的前缀
 6 spring.mvc.static-path-pattern=/static/**
 7 spring.resources.static-locations=classpath:/static/
 8 
 9 ### 3、配置模板文件
10 spring.freemarker.templateLoaderPath=classpath:/templates/
11 spring.freemarker.suffix=.ftl
12 spring.freemarker.charset=UTF-8
13 spring.freemarker.request-context-attribute=request
14 spring.freemarker.settings.number_format=0.##########
15 
16 ### 4、配置mybatis的mapper文件地址
17 mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
18 
19 ### 5、配置数据库的地址
20 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl-job?Unicode=true&characterEncoding=UTF-8
21 spring.datasource.username=root
22 spring.datasource.password=root_pwd
23 spring.datasource.driver-class-name=com.mysql.jdbc.Driver
24 
25 spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
26 spring.datasource.tomcat.max-wait=10000
27 spring.datasource.tomcat.max-active=30
28 spring.datasource.tomcat.test-on-borrow=true
29 spring.datasource.tomcat.validation-query=SELECT 1
30 spring.datasource.tomcat.validation-interval=30000
31 
32 ### 6、配置报警邮箱
33 spring.mail.host=smtp.qq.com
34 spring.mail.port=25
35 [email protected]
36 spring.mail.password=xxx
37 spring.mail.properties.mail.smtp.auth=true
38 spring.mail.properties.mail.smtp.starttls.enable=true
39 spring.mail.properties.mail.smtp.starttls.required=true
40 
41 
42 ### 7、管理界面的登录用户名密码
43 xxl.job.login.username=admin
44 xxl.job.login.password=123456
45 
46 ### 8、调度中心通讯TOKEN，非空时启用
47 xxl.job.accessToken=
48 
49 ### 9、调度中心国际化设置，默认为中文版本，值设置为“en”时切换为英文版本
50 xxl.job.i18n=

　　注意：基本上上面的配置文件我们需要修改的只有第 5 点，修改数据库的地址，这要与我们前面初始化的数据库名称径，用户名密码保持一致；

　　　　    第二个就是修改第 6 点，报警邮箱，因为该工程任务失败后有失败告警功能，可以通过邮件来提醒，如果我们需要此功能，可以配置一下。

②、部署调度中心

　　该工程是一个springboot项目，我们只需要在IDEA中执行 XxlJobAdminApplication 类即可运行该工程：

③、访问调度中心管理界面

　　在浏览器输入 http://localhost:8080/xxl-job-admin 然后输入用户名和密码（前面配置文件中配置的），即可看到如下管理界面。

 　　

6、创建执行器项目

　　其实在源码中，作者提供了各个版本的 执行器项目，下面我以创建一个 springboot 版本的执行器为例来介绍。

　　这个执行器的地址为：https://github.com/YSOcean/xxljobexecutordemo.git

①、添加maven依赖

　　在创建好的springboot 项目的pom.xml 文件中添加如下依赖：

1 
2 
3       com.xuxueli
4       xxl-job-core
5       2.0.1
6 

②、配置执行器

　　在创建好的springboot 项目的配置文件 application.yml 添加如下配置：

 1 server:
 2   #项目端口号
 3   port: 8081
 4 logging:
 5   #日志文件
 6   config: classpath:logback.xml
 7 
 8 xxl:
 9   job:
10     admin:
11       #调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。
12       #执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
13       addresses: http://127.0.0.1:8080/xxl-job-admin
14 
15     #分别配置执行器的名称、ip地址、端口号
16     #注意：如果配置多个执行器时，防止端口冲突
17     executor:
18       appname: executorDemo
19       ip: 127.0.0.1
20       port: 9999
21 
22       #执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
23       logpath: /data/applogs/xxl-job/jobhandler
24       #执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
25       #-1表示永不删除
26       logretentiondays: -1

　　这里需要注意的是：配置执行器的名称、IP地址、端口号，后面如果配置多个执行器时，要防止端口冲突。再就是执行器的名称，我们后面会到上一步的调度中心管理界面进行对应配置。

③、载入配置文件

　　在项目中创建 XxlJobConfig.class 文件：

 1 package com.ys.xxljobexecutordemo.config;
 2 
 3 import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
 4 import org.slf4j.Logger;
 5 import org.slf4j.LoggerFactory;
 6 import org.springframework.beans.factory.annotation.Value;
 7 import org.springframework.context.annotation.Bean;
 8 import org.springframework.context.annotation.Configuration;
 9 
10 /**
11  * Create by YSOcean
12  */
13 @Configuration
14 public class XxlJobConfig {
15     private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
16 
17     @Value("${xxl.job.admin.addresses}")
18     private String adminAddresses;
19 
20     @Value("${xxl.job.executor.appname}")
21     private String appName;
22 
23     @Value("${xxl.job.executor.ip}")
24     private String ip;
25 
26     @Value("${xxl.job.executor.port}")
27     private int port;
28 
29     @Value("${xxl.job.accessToken}")
30     private String accessToken;
31 
32     @Value("${xxl.job.executor.logpath}")
33     private String logPath;
34 
35     @Value("${xxl.job.executor.logretentiondays}")
36     private int logRetentionDays;
37 
38 
39     @Bean(initMethod = "start", destroyMethod = "destroy")
40     public XxlJobSpringExecutor xxlJobExecutor() {
41         logger.info(">>>>>>>>>>> xxl-job config init.");
42         XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
43         xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
44         xxlJobSpringExecutor.setAppName(appName);
45         xxlJobSpringExecutor.setIp(ip);
46         xxlJobSpringExecutor.setPort(port);
47         xxlJobSpringExecutor.setAccessToken(accessToken);
48         xxlJobSpringExecutor.setLogPath(logPath);
49         xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
50 
51         return xxlJobSpringExecutor;
52     }
53 
54 }

View Code

④、创建任务JobHandler

　　在项目中创建一个Handler，用于执行我们想要执行的东西，这里我只是简单的打印一行日志：

　　XXL-JOB, Hello World!!!

 1 package com.ys.xxljobexecutordemo.jobhandler;
 2 
 3 import com.xxl.job.core.biz.model.ReturnT;
 4 import com.xxl.job.core.handler.IJobHandler;
 5 import com.xxl.job.core.handler.annotation.JobHandler;
 6 import com.xxl.job.core.log.XxlJobLogger;
 7 import org.springframework.stereotype.Component;
 8 
 9 /**
10  * 任务Handler示例（Bean模式）
11  *
12  * 开发步骤：
13  * 1、继承"IJobHandler"：“com.xxl.job.core.handler.IJobHandler”；
14  * 2、注册到Spring容器：添加“@Component”注解，被Spring容器扫描为Bean实例；
15  * 3、注册到执行器工厂：添加“@JobHandler(value="自定义jobhandler名称")”注解，注解value值对应的是调度中心新建任务的JobHandler属性的值。
16  * 4、执行日志：需要通过 "XxlJobLogger.log" 打印执行日志；
17  */
18 @JobHandler(value="demoJobHandler")
19 @Component
20 public class JobHandlerDemo extends IJobHandler{
21     @Override
22     public ReturnT execute(String s) throws Exception {
23         XxlJobLogger.log("XXL-JOB, Hello World.");
24         return SUCCESS;
25     }
26 }

View Code

　　注意：这里有个注解 @JobHandler(value="demoJobHandler")，对于 value的值，我们会在下面进行相应配置。

7、在调度中心中配置执行器

　　调度中心前面我们已经配置好了，启动该配置中心，进入http://localhost:8080/xxl-job-admin 界面。

①、配置执行器

　　点击  执行器管理----》新增执行器---》，如下如下界面，然后填充此表格，点击保存即可。

　　下面是对这几个参数的介绍：

　　AppName：是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;

　　名称：执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;

　　排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;

　　注册方式：调度中心获取执行器地址的方式，

　　　　自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；

　　　　手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；

　　机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

②、创建任务

　　点击 任务管理---》新增任务---》

　　执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置。

　　任务描述：任务的描述信息，便于任务管理；

　　路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
　　　　　　FIRST（第一个）：固定选择第一个机器；
　　　　　　LAST（最后一个）：固定选择最后一个机器；
　　　　　　ROUND（轮询）：；
　　　　　　RANDOM（随机）：随机选择在线的机器；
　　　　　　CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
　　　　　　LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
　　　　　　LEAST_RECENTLY_USED（最近最久未使用）：最久为使用的机器优先被选举；
　　　　　　FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
　　　　　　BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
　　　　　　SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
　　Cron：触发任务执行的Cron表达式；
　　运行模式：
　　　　　　BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
　　　　　　GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
　　　　　　GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
　　　　　　GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
　　　　　　GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
　　　　　　GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
　　　　　　GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
　　JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
　　阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
　　　　　　单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
　　　　　　丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
　　　　　　覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
　　子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
　　任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
　　失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；
　　报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
　　负责人：任务的负责人；
　　执行参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入；

8、启动任务

　　配置完执行器以及任务，我们只需要启动该任务，便可以运行了。

　　

　　启动之后，我们查看日志：

　　我们上面配置任务时的cron表达式是每秒钟执行一次（0/1 * * * * ? *）：

　　打印日志如下：

　　

　　注意：在项目中，只有通过 XxlJobLogger.log() 代码才能将日志打印到上面。

　　

参考文档：https://www.cnblogs.com/xuxueli/p/5021979.html  这是xxl-job作者的博客地址。

　　　　　http://www.xuxueli.com/xxl-job/#  这是中文教程。