springboot传统定时任务实现方式:
1.@EnableScheduling + @Scheduled(cron = "0/10 * * * * ?")
2.@EnableScheduling + 实现SchedulingConfigurer接口(代码如下)
/**
* 动态定时任务,定时表达式通过查询数据库获取,
* 在数据库中添加完新数据,需要重启服务,不能及时获取
*/
@Configuration
public class DynamicScheduleTask implements SchedulingConfigurer {
@Autowired
private CronDao cronDao;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
//查询所有定时表达式
List<Cron> all = cronDao.findAll();
if(!CollectionUtils.isEmpty(all)){
for (Cron cron : all) {
taskRegistrar.addTriggerTask(() -> System.out.println("定时任务执行了------->" + cron.getCron()),
triggerContext -> new CronTrigger(cron.getCron()).nextExecutionTime(triggerContext));
}
}
}
}
缺点:
不支持集群:集群情况下容易造成任务重复问题
不支持失败重试:失败即结束,不支持重试
不支持动态调整:修改任务参数时需要修改代码,并且要重启服务
无报警机制:任务失败后没有提醒功能
无统一管理:没有办法手动关闭或开启任务
XXL-JOB
源码地址:
官方文档:https://www.xuxueli.com/xxl-job/
github地址:https://github.com/xuxueli/xxl-job
gitee地址:http://gitee.com/xuxueli0323/xxl-job
XXL-JOB是一个开源的,具有丰富的任务管理功能以及高性能,高可用等特点的轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展、开箱即用!!!
主要分为3部分:调度中心(服务方)、执行器(客户方)、调度任务
目录结构:
可分为有四大模块
doc:存放相关文档
xxl-job-admin:调度中心管理后台
xxl-job-core:框架核心包
xxl-job-executor-samples:集成不同框架的案例代码
构建xxl-job所依赖的数据库:
运行sql文件,产生如下表结构
修改xxl-job-admin的数据库配置
启动后,访问 http://localhost:8080/xxl-job-admin 默认登录账户名:admin 登录密码:123456
登录后所展示的图形化界面
调度日志,查看任务执行的具体情况
执行器管理,用来配置哪个项目执行任务
任务管理,配置需要执行的定时任务
路由策略:多用于集群时的配置。这里属于本机测试,所以选第一个
Cron:执行规则
JobHandler:定义执行器的名字,和springboot中实例化的名字相对应
编写执行器代码并测试定时任务
请参考源码目录下的xxl-job-executor-sample-springboot项目进行编写:
1.新建springboot项目
2.pom.xml
<dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.3.1</version> </dependency>
3.application.properties
#xxl-job后台管理地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
#和xxl-job后台管理accessToken一致
xxl.job.accessToken=default_token
# xxl-job执行器名称
xxl.job.executor.appname=my-executor
#优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址
xxl.job.executor.address=
#默认为空表示自动获取IP
xxl.job.executor.ip=
#执行器端口
xxl.job.executor.port=9999
#执行器运行日志文件存储磁盘路径
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
#执行器日志文件保存天数
xxl.job.executor.logretentiondays=30
4.编写xxl-job的配置类
package cn.itcast.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
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.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;
@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;
}
/**
* 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
*
* 1、引入依赖:
* <dependency>
* <groupId>org.springframework.cloud</groupId>
* <artifactId>spring-cloud-commons</artifactId>
* <version>${version}</version>
* </dependency>
*
* 2、配置文件,或者容器启动变量
* spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
* 3、获取IP
* String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
*/
}
5.编写定时任务
package cn.itcast.jobhandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@Component
@Slf4j
public class SampleXxlJob {
@XxlJob("myJobHandler1")
public void demoJobHandler() throws Exception {
//获取执行时,后台管理页面所传递的执行参数,多个参数用逗号分割,然后使用split(",")分割
String param = XxlJobHelper.getJobParam();
log.info("param:{}",param);
log.info("你好啊!!!xxl-job");
}
}