1 概述
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。
1.1 下载
源码仓库地址
源码仓库地址 |
---|
https://github.com/xuxueli/xxl-job |
http://gitee.com/xuxueli0323/xxl-job |
maven依赖
com.xuxueli
xxl-job-core
1.9.2
1.2 环境
- JDK:1.7+
- Servlet/JSP Spec:3.1/2.3
- Tomcat:8.5.x/Jetty9.2.x
- Spring-boot:1.5.x/Spring4.x
- Mysql:5.6+
- Maven:3+
2 使用
2.1 安装
下载XXL-Job 源码
https://github.com/xuxueli/xxl-job 克隆项目至本地
初始化数据库
初始化项目数据库至本地数据库,SQL脚本位置如下:
/xxl-job/doc/db/tables_xxl_job.sql
部署调度中心
打开下载的源码编译,配置调度中心
调度中心配置文件地址:
/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties
配置信息详解:
### 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
xxl.job.db.driverClass=com.mysql.jdbc.Driver
xxl.job.db.url=jdbc:mysql://localhost:3306/xxl-job?useUnicode=true&characterEncoding=UTF-8
xxl.job.db.user=root
xxl.job.db.password=root_pwd
### 报警邮箱
xxl.job.mail.host=smtp.163.com
xxl.job.mail.port=25
xxl.job.mail.ssl=false
[email protected]
xxl.job.mail.password=asdfzxcv
[email protected]
xxl.job.mail.sendNick=《任务调度平台XXL-JOB》
### 登录账号
xxl.job.login.username=admin
xxl.job.login.password=123456
### 调度中心通讯TOKEN,非空时启用
xxl.job.accessToken=
### 调度中心国际化设置,默认为中文版本,值设置为“en”时切换为英文版本
xxl.job.i18n=
运行项目
运行源码中的xxl-job-admin项目,通过tomcat启动
2.2 编写分布式执行器
创建执行器项目
创建SpringBoot项目,引入了 "xxl-job-core" 的maven依赖;配置项目POM如下
4.0.0
xxl-job-taoran
xxl-job
1.0-SNAPSHOT
UTF-8
UTF-8
1.8
1.5.16.RELEASE
5.5.2
org.springframework.boot
spring-boot-starter-parent
1.5.16.RELEASE
com.sun.jna
jna
3.0.9
com.xuxueli
xxl-job-core
1.9.2
org.springframework.boot
spring-boot-starter-actuator
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-tomcat
org.springframework.boot
spring-boot-starter-test
test
mysql
mysql-connector-java
5.1.45
com.google.code.gson
gson
2.8.2
org.springframework.boot
spring-boot-maven-plugin
${spring-boot.version}
repackage
配置执行器
执行器配置文件:
/src/main/resources/xxl-job-executor.properties
配置参数详解:
### xxl-job admin address list:调度中心部署跟地址:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job executor address:执行器"AppName"和地址信息配置:AppName执行器心跳注册分组依据;地址信息用于"调度中心请求并触发任务"和"执行器注册"。执行器默认端口为9999,执行器IP默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用。单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job, access token:执行器通讯TOKEN,非空时启用
xxl.job.accessToken=
### xxl-job log path:执行器运行日志文件存储的磁盘位置,需要对该路径拥有读写权限
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/
### xxl-job log retention days:执行器Log文件定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保持3天,否则功能不生效;
xxl.job.executor.logretentiondays=-1
SpringBoot 集成
引入配置文件,或者将配置参数直接配置在application.properties文件中
@PropertySource(
value = {"classpath:xxl-job-executor.properties"})
配置JAVA Config,代码如下
package com.taoran.xxl.config;
import com.xxl.job.core.executor.XxlJobExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
//@Configuration
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 XxlJobExecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobExecutor xxlJobExecutor = new XxlJobExecutor();
xxlJobExecutor.setAdminAddresses(adminAddresses);
xxlJobExecutor.setAppName(appName);
xxlJobExecutor.setIp(ip);
xxlJobExecutor.setPort(port);
xxlJobExecutor.setAccessToken(accessToken);
xxlJobExecutor.setLogPath(logPath);
xxlJobExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobExecutor;
}
}
创建Demo Handler
创建演示Demo
@JobHandler(value="demoJobHandler")
@Component
public class DemoJobHandler extends IJobHandler {
@Override
public ReturnT execute(String param) throws Exception {
XxlJobLogger.log("XXL-JOB, Hello World.");
for (int i = 0; i < 5; i++) {
XxlJobLogger.log("beat at:" + i);
TimeUnit.SECONDS.sleep(2);
}
return SUCCESS;
}
}
启动SpringBoot
@SpringBootApplication
@ComponentScan(basePackages = "com.taoran")
//@PropertySource(
// value = {"classpath:xxl-job-executor.properties"})
//@EnableElasticsearchRepositories(basePackages = "com.taoran.es.repo")
public class AppLoader {
public static void main(String[] args) {
SpringApplication.run(AppLoader.class);
}
}
调度中心
启动执行器
XXL-Job将会自动将我们的Handler注册进调度中心,我们在任务调度列表中可以进行任务调度处理,如图
该死的有道会员