目录
1 介绍
XXL-JOB是一个轻量级分布式任务调度平台
最大的特点就是简单易用
1.1 特性
1.2 整体架构
XXL-Job的调度中心可以监控多台机器下的任务执行状态,任务如果想被调度中心所管理,则需要进行任务注册,调度中心对任务进行任务状态心跳检查
总体来说,调度中心可以管理任务,配置任务计划,监测任务状态等等。
2 快速导入
2.1 测试工程导入
源码可以直接去官网下载XXL-JOB官网
之后导入idea:
2.1 初始化数据库
因为任务调度中心需要记录每个任务的工作状态,所以需要给它提供数据库
直接导入即可:
2.3 Docker安装任务管理中心
拉取xxl-job-admin任务中心镜像:
docker pull xuxueli/xxl-job-admin:2.3.0
启动xxl-job任务中心容器:
//在指定目录构建xxldata目录,然后运行如下docker指令:
docker run -e PARAMS=“–spring.datasource.url=jdbc:mysql://192.168.65.150:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=UTC --spring.datasource.username=root --spring.datasource.password=1234” -p 8099:8080 -v $PWD/xxldata:/data/applogs --name=xxl-job-admin -d xuxueli/xxl-job-admin:2.3.0
访问容器服务:
http://192.168.200.128:8093/xxl-job-admin
直接登录即可 初始账号密码为 admin 123456
3 XXL-JOB任务注册测试
3.1 引入xxl-job依赖
<!-- xxl-job-core -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${project.parent.version}</version>
</dependency>
3.2 配置xxljob相关信息
在配置文件xml里面进行配置信息:
# web服务端口
server.port=8081
# no web
#spring.main.web-environment=false
# log config
logging.config=classpath:logback.xml
#定义注册地址
xxl.job.admin.addresses=http://192.168.65.150:8099/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=
#任务工程的名字
xxl.job.executor.appname=xxl-job-exec-test
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
#配置监控平台与当前任务的心跳检查端口
xxl.job.executor.port=9999
# 日志文件路径
xxl.job.executor.logpath=./logs
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30
配置完毕后,工程底层通过XxlJobConfig配置类加载配置信息,实现xxljob相关资源的初始化工作:(代码不必深究)
/**
* 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.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
@Value("${xxl.job.executor.address}")
private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
/**
* Spring整合xxljob任务执行器
* 该执行器可以调用当前工程下的子任务
* @return
*/
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
3.3 定义定时任务执行方法
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
for (int i = 0; i < 5; i++) {
XxlJobHelper.log("beat at:" + i);
TimeUnit.SECONDS.sleep(2);
}
// default success
}
// ......此处省略其余代码
/**
* 5、生命周期任务示例:任务初始化与销毁时,支持自定义相关逻辑;
*/
@XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
public void demoJobHandler2() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
}
public void init(){
logger.info("init");
}
public void destroy(){
logger.info("destory");
}
@XxlJob中的value值就是定时任务的一个标识,注解作用的方法就是定时任务要执行逻辑的逻辑方法;
3.3 配置任务执行器
首先,新增一个执行器,手动录入地址,注意,执行器名字和配置文件一样,地址就是执行器机器的ip地址,端口号就是在执行器的配置文件中写的心跳检查端口
接下来点击任务列表,其中写上任务描述,负责人,(运行模式嘛,SpringBoot的Bean,所以不用管),Cron表示任务执行器周期表达式,下图是一秒执行一次,并且JobHander要和执行的调度任务中@XxlJob注解的value值相同:
新建任务成功后点击启动即可:
4 CRON表达式
4.1 cron表达式语法介绍
xxl-job同样支持通过cron表达式来控制任务周期性调度执行表达式包含7个部分:分别从秒、分、时、日、月、星期、年七个时间维度来定义任务执行的周期;
cron表达式时间取值范围:
cron表达式格式:
* * * * * * *
- - - - - - -
| | | | | | |
| | | | | | + year [optional]
| | | | | +----- day of week (1 - 7)
| | | | +---------- month (1 - 12)
| | | +--------------- day of month (1 - 31)
| | +-------------------- hour (0 - 23)
| +------------------------- min (0 - 59)
+------------------------------ second (0 - 59)
以下是这些特殊符号的作用,主要看一下前五个就行:
注:?有啥用呢,举个例子吧,比如我选了日,每日执行一次,那么星期几肯定就不重要了,可以用?代替了。
如果实在记不住,可以查看Corn在线生成器
4.2 cron练习
(1)0 0 2 1 * ? 表示在每月的1日的凌晨2点调整任务
(2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业 ★★★
(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作
(4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点
(5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
(6)0 0 12 ? * WED 表示每个星期三中午12点
(7)0 15 10 * * ? 每天上午10:15触发
(8)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发
(9)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
(10)0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
(12)0 15 10 L * ? 每月最后一日的上午10:15触发
(13)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发