官方文档: https://www.xuxueli.com/xxl-job/
github源码地址: https://github.com/xuxueli/xxl-job/
xxl-job压缩包下载地址: https://github.com/xuxueli/xxl-job/releases
使用【github源码地址】 和【 xxl-job压缩包下载地址】都可以
第一步: 通过idea导入项目后,修改如下几个地方
第二步:启动类中进行启动
第三步:访问xxl-job后台管理系统
http://localhost:8080/xxl-job-admin项目中引入xxl-job依赖 第一步:添加依赖
第二步:pom文件配置(注意:xxl.job.accessToken要和源码中的token一致)com.xuxueli xxl-job-core2.3.0
#----------xxl-job配置-------------- logging.config=classpath:logback.xml #调度中心部署地址,多个配置逗号分隔 "http://address01,http://address02" xxl.job.admin.addresses=http://localhost:8080/xxl-job-admin #执行器token,非空时启用 xxl-job, access token xxl.job.accessToken=hbz # 执行器app名称,和控制台那边配置一样的名称,不然注册不上去 xxl.job.executor.appname=hbz-xxljob-first # [选填]执行器注册:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。 #从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。 xxl.job.executor.address= #[选填]执行器IP :默认为空表示自动获取IP(即springboot容器的ip和端口,可以自动获取,也可以指定),多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务", xxl.job.executor.ip= # [选填]执行器端口号:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口; xxl.job.executor.port=9998 #执行器日志文件存储路径,需要对该路径拥有读写权限;为空则使用默认路径 xxl.job.executor.logpath=./data/logs/xxl-job/executor #执行器日志保存天数 xxl.job.executor.logretentiondays=1
第四步:写配置文件configlogback %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n ${log.path} ${log.path}.%d{yyyy-MM-dd}.zip %date %level [%thread] %logger{36} [%file : %line] %msg%n
package com.example.demo_xxljob.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@Slf4j
public class XxlJobConfig {
@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;
//旧版的有bug
//@Bean(initMethod = "start", destroyMethod = "destroy")
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
log.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;
}
}
第五步:编写执行器
package com.example.demo_xxljob.job;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@Component
@Slf4j
public class DemoJob {
// 注意:hbzXxljobFirst要和后台管理执行器中的handlerJob的值一致
@XxlJob(value = "hbzXxljobFirst",init = "init",destroy = "destroy")
public ReturnT execute(String param){
log.info("hbz-JOB案例 execute 任务方法触发成功");
return ReturnT.SUCCESS;
}
private void init(){
log.info("hbz-JOB案例 DemoJob init >>>>>");
}
private void destroy(){
log.info("hbz-JOB案例 DemoJob destroy >>>>>");
}
}
第六步:启动xxl-job源码 与 自己的程序,并启动执行器看结果
String jobParam = XxlJobHelper.getJobParam();
log.info("参数值: param = ", jobParam);
程序中需要写如下代码
XxlJobHelper.handleFail("自定义错误信息:程序运行失败了");
程序中这样写
XxlJobHelper.log("自定义日志:可定义程序中的日志,比如参数param = " + jobParam);
#----------xxl-job配置-------------- logging.config=classpath:logback.xml #调度中心部署地址,多个配置逗号分隔 "http://address01,http://address02" xxl.job.admin.addresses=http://localhost:8079/xxl-job-admin,http://localhost:8080/xxl-job-admin #执行器token,非空时启用 xxl-job, access token xxl.job.accessToken=hbz # 执行器app名称,和控制台那边配置一样的名称,不然注册不上去 xxl.job.executor.appname=hbz-xxljob-first # [选填]执行器注册:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。 #从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。 xxl.job.executor.address= #[选填]执行器IP :默认为空表示自动获取IP(即springboot容器的ip和端口,可以自动获取,也可以指定),多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务", xxl.job.executor.ip= # [选填]执行器端口号:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口; xxl.job.executor.port=9999 #执行器日志文件存储路径,需要对该路径拥有读写权限;为空则使用默认路径 xxl.job.executor.logpath=./data/logs/xxl-job/executor #执行器日志保存天数 xxl.job.executor.logretentiondays=1
当某个调度中心挂了,定时任务依然会正常运行,由另一个节点的调度中心提供服务



