xxl-job分布式任务调度框架
xxl-job分布式任务调度框架
1、什么是XXL-JOB?
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
官方地址中文版:http://www.xuxueli.com/xxl-job
2、快速入门
github: https://github.com/xuxueli/xxl-job
解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下:
xxl-job-admin:调度中心
xxl-job-core:公共依赖
xxl-job-executor-samples:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)
:xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器,推荐这种方式;
:xxl-job-executor-sample-spring:Spring版本,通过Spring容器管理执行器,比较通用;
:xxl-job-executor-sample-frameless:无框架版本;
:xxl-job-executor-sample-jfinal:JFinal版本,通过JFinal管理执行器;
:xxl-job-executor-sample-nutz:Nutz版本,通过Nutz管理执行器;
请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。
“调度数据库初始化SQL脚本” 位置为:
/xxl-job/doc/db/tables_xxl_job.sql
调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例;
如果mysql做主从,调度中心集群节点务必强制走主库;
配置部署“调度中心”
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
调度中心访问地址:http://localhost:8080/xxl-job-admin (该地址执行器将会使用到,作为回调地址)
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

3、XXL-JOB与项目结合
以 springboot 框架为例:
1、添加Maven依赖:
<!--定时器xxljob-->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.0.1</version>
</dependency>
2、执行器配置文件:
在 resources 文件夹下新建配置文件 application.properties
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses= 192.168.22.67:8080/xxl-job-admin/
### xxl-job executor address
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=192.168.21.88
xxl.job.executor.port=9977
### xxl-job, access token
xxl.job.accessToken=/data/applogs/xxl-job/jobhandler/
### xxl-job log path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job log retention days
xxl.job.executor.logretentiondays=-1
XXL-JOB执行器的相关配置项的意义,如下所示:
-
xxl.job.admin.addresses
调度中心的部署地址。若调度中心采用集群部署,存在多个地址,则用逗号分隔。执行器将会使用该地址进行”执行器心跳注册”和”任务结果回调”。 -
xxl.job.executor.appname
执行器的应用名称,它是执行器心跳注册的分组依据。 -
xxl.job.executor.ip
执行器的IP地址,用于”调度中心请求并触发任务”和”执行器注册”。执行器IP默认为空,表示自动获取IP。多网卡时可手动设置指定IP,手动设置IP时将会绑定Host。 -
xxl.job.executor.port
执行器的端口号,默认值为9999。单机部署多个执行器时,注意要配置不同的执行器端口。 -
xxl.job.accessToken
执行器的通信令牌,非空时启用。 -
xxl.job.executor.logpath
执行器输出的日志文件的存储路径,需要拥有该路径的读写权限。 -
xxl.job.executor.logretentiondays
执行器日志文件的定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保存3天,否则功能不生效。
注意,XXL-JOB执行器的配置文件也可以交给Disconf进行托管。
4、执行器配置类
新建一个执行器配置类,用来读取执行器的配置信息。在config文件夹下新建一个名为 XxlJobConfig 的类,内容如下:
@Configuration
@ComponentScan(basePackages = "com.tfjybj.physical.provider.job")
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.executor.appname}")
private String appName;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean(initMethod = "start", destroyMethod = "destroy")
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 ;
}
}
XxlJobConfig
配置类有两点需要注意:
-
组件扫描使用 @ComponentScan 注解,扫描 com.example.demo.jobhandler 包,将其中的任务处理器加载至 Spring 容器。
-
获取执行器实例 xxlJobExecutor() 方法会实例化一个 XXL-JOB 执行器对象,执行器初始化时调用它的 start() 方法,执行器销毁时调用它的 destroy() 方法。
5、建立任务执行器:
在 provider 下的 job 下新建 job 测试文件:JobTest.java
@JobHandler(value = "JobTest")
@Component
@Slf4j
public class JobTest extends IJobHandler implements Serializable {
@Override
public ReturnT<String> execute(String s) throws Exception {
try {
System.out.println("测试~~~");
/*测试数据*/
return SUCCESS;
} catch (Exception e){
e.printStackTrace();
return FAIL;
}
}
}
6、执行器(任务调度中心):
访问地址: http://192.168.22.67:8080/xxl-job-admin/jobinfo,登录 XXL-JOB 调度中心
1、任务管理:
3、执行器管理:
注意,AppName的取值应该和示例工程的 application.properties 文件中的 xxl.job.executor.appname 字段的取值相同,注册方式应该选择自动注册。