1.什么是XXL-JOB
XXL-JOB 是由国人许雪里开发的一个 开源的轻量级分布式任务调度平台。
学习简单、轻量级、易扩展,开箱即用,现已开放源代码并接入200多家公司线上产品线
2.XXL-JOB设计思想
a.将调度行为抽象为调度中心公共平台,而平台本身不承担业务逻辑,调度中心负责发送调度请求。
b.将任务抽象成分散的JobHandler,交由执行器统一管理,执行器负责接收调度请求,并且执行对应的业务逻辑,调度和任务完全解耦
c.调度和任务完全解耦,提高了系统稳定性和扩展性
d.其中调度中心支持可视化的动态管理调度信息
3.XXL-JOB 系统组成
调度模块(调度中心):
a.负责管理调度信息,按照调度配置发出调度请求,自身不承担业务代码。调度系统与任务解耦,提高了系统可用性和稳定性,同时调度系统性能不再受限于任务模块;
b.支持可视化、简单且动态的管理调度信息,包括任务新建,更新,删除,GLUE开发和任务报警等,所有上述操作都会实时生效,同时支持监控调度结果以及执行日志,支持执行器Failover。
执行模块(执行器):
负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作,开发和维护更加简单和高效;
接收“调度中心”的执行请求、终止请求和日志请求等。
4.工程结构
xxl-job-admin:调度中心
xxl-job-core:公共依赖 xxl-job-executor-samples:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)
:xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器,推荐这种方式;
:xxl-job-executor-sample-frameless:无框架版本;
5.spring-boot项目集成XXL-JOB
5.1 部署XXL-JOB
a.下载地址
https://gitee.com/xuxueli0323/xxl-job
b.本地进行编译
c.修改配置xxl-job-admin中的application.properties
server.port=8080
server.servlet.context-path=/xxl-job-admin
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=xxx
spring.datasource.password=xxxxx
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
### xxl-job, access token
xxl.job.accessToken=xxxxxx
d.打包部署
部署完可以通过地址查看管理页面:http://127.0.0.1:8080/xxl-job-admin/
5.2 引入项目
a. pom文件中引入jar包
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
b.在配置文件中增加配置
xxl:
job:
accessToken: xxxxxx #修改的token秘钥
admin:
addresses: http://10.1.11.60:8080/xxl-job-admin/ #上面部署xxl-job-admin地址
executor:
appname: dayunmotor-tsp-gateway-xxl-job #本项目名称
ip: 10.1.5.27 #这个是本项目部署地址和端口
port: 30003 #注意这里不是本项目的端口是xxl-job执行请求的端口
logpath: /data/applogs/xxl-job/jobhandler
logretentiondays: 30
c.在项目中增加配置类
@Slf4j
@Configuration
public class XxlJobConfig {
@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.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;
@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;
}
}
d.增加定时任务
@Slf4j
@Component
public class RemoteUpgradeTask extends IJobHandler {
@XxlJob(value = "remoteUpgradeTask")
public ReturnT<String> execute(String s) throws Exception {
try {
log.info("执行任务");
return IJobHandler.SUCCESS;
} catch (Exception e) {
log.error("执行任务异常", e);
return new ReturnT<>(IJobHandler.FAIL.getCode(), "执行任务失败");
}
}
//执行初始化方法
@Override
public void init() throws InvocationTargetException, IllegalAccessException {
super.init();
}
//执行销毁方法
@Override
public void destroy() throws InvocationTargetException, IllegalAccessException {
super.destroy();
}
}
e.然后去xxl-job-admin中增加执行器,增加完启动项目,可以看到启动的执行器
(执行器管理中的appname与(xxl-job-executor-sample-springboot)的配置文件的xxl.job.executor.appname保持一致)
f.配置任务管理:新增任务
然后启动任务即可定时执行