定时任务常见的使用场景
常见的定时任务框架
使用建议:简单的单机定时任务用springboot自带的,复杂的单机任务用quartz,分布式任务用xxl-job。
1、编写定时任务
/** * 继承抽象类TimerTask,实现run()方法 */
public class MyTask extends TimerTask {
@Override
public void run() {
//要定时执行的代码
}
}
2、调度、执行
Timer timer = new Timer();
MyTask myTask = new MyTask();
//一个timer实例会用一个单独的后台线程来执行此timer所有的任务
timer.schedule(myTask, 5000L, 1000L);
// timer.scheduleAtFixedRate(myTask, 5000L, 1000L);
//当前线程继续往下执行
//取消指定的定时任务
// myTask.cancel();
//取消此timer中所有的定时任务
// timer.cancel();
timer提供了多个方法来执行定时任务,schedule()、scheduleAtFixedRate()的区别
说的是多个任务并发执行、或者单个任务的多个场次并发执行,但实际只有一个线程来执行,是交替执行的。
如果执行某个任务时抛出异常,会终止此timer所有的任务,可靠性差。
不需要额外添加依赖
1、引导类上加 @EnableScheduling
2、编写定时任务
@Component //放到spring容器中
public class XxxTask {
@Scheduled(fixedRate = 5000) //指定执行时间。每5000ms执行1次,间隔是距上次执行开始
public void task1(){
//要执行的代码
}
@Scheduled(fixedDelay = 5000) //每5000ms执行1次,间隔是距上次执行结束
public void task2(){
//要执行的代码
}
@Scheduled(fixedRateString = "5000") //fixedRateString、fixedDelayString 分别对应以上2种,只是把值写成字符串形式
public void task3(){
//要执行的代码
}
@Scheduled(cron = "0 0/10 * * * ?") //使用cron表达式指定
public void task4(){
//要执行的代码
}}
把定时|异步任务抽出来,统一放在单独的包、类中,方便维护。
3、yml中配置定时任务的线程池
spring:
task:
scheduling:
pool:
#定时任务线程池中的线程数。默认值1,线程池中只有1个线程来执行springboot的定时任务
size: 10
如果不手动修改值,有多个springboot定时任务时,会出现只执行一个定时任务的情况。
springboot的定时任务、异步任务都是使用单独的线程池来执行,如果公司有线程池的使用规范、觉得内置的线程池不满足需求,可以使用自定义的线程池。
异步任务可分为2类
异步任务都是启动一条新线程来执行,不阻塞当前线程,可以提高效率。
1、引导类上加 @EnableAsync
2、编写要执行的异步任务
@Component //放到spring容器中
@Async //将类中的方法都标识为异步方法。如果不需要标注全部方法,在需要标注的方法上标注@Async即可
public class XxxAsyncTask {
//不需要返回结果的
public void task1(){
//......
}
//需要返回结果的,泛型指定要返回的数据类型
public Future<String> task2(){
//......
//参数是要返回的数据
return new AsyncResult<>("success");
}
public Future<String> task3(){
//......
return new AsyncResult<>("fail");
}
}
3、使用异步任务
@Service
public class XxxService {
@Autowired
private XxxAsyncTask xxxAsyncTask;
public void xxx() {
//......
//都是启动新线程来执行task
xxxAsyncTask.task1();
Future<String> task2 = xxxAsyncTask.task2();
Future<String> task3 = xxxAsyncTask.task3();
//...... //当前线程继续往下执行
//当前线程需要使用异步任务的返回结果时,使用get()阻塞当前线程等待异步任务执行完毕
try {
//能指定超时时间的方法都尽量指定超时时间,避免发生异常时一直阻塞线程
String r2 = task2.get(1, TimeUnit.MINUTES);
String r3 = task3.get(1, TimeUnit.MINUTES);
} catch (ExecutionException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
} catch (TimeoutException e) {
e.printStackTrace();
}
//...... //当前线程继续往下执行
}
}
4、yml中配置异步任务的线程池
spring:
task:
execution:
#线程名称前缀,默认task-
thread-name-prefix: async-task-thread-
#异步线程池配置
pool:
#默认值 8
core-size: 6
#默认值 2147483647
max-size: 20
#异步任务队列的容量,默认值 2147483647
queue-capacity: 300
3个核心概念
quartz提供了2种作业存储类型
1、依赖
创建项目时勾选 I/O -> Quartz Scheduler,也可以手动添加依赖
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-quartzartifactId>
dependency>
2、编写任务
/** * 继承QuartzJobBean,重写executeInternal(),一个类对应一个任务 * 不需要放到spring容器中 */
public class XxxJob extends QuartzJobBean {
@Override
protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
//要执行的代码
}
}
3、quartz的配置类
@Configuration
public class QuartzConfig {
/** * 创建JobDetail实例,放到spring容器中 * 一个job对应一个JobDetail实例,有多个job时copy下来改一下 */
@Bean
public JobDetail xxxJobDetail() {
return JobBuilder.newJob(XxxJob.class) //绑定要Job
.withIdentity("xxxJob", "defaultJobGroup") //指定job的名称、所属的组
.storeDurably() //如果此JobDetail实例没有关联Trigger,也不删除此JobDetail实例
.build();
}
/** * 创建trigger实例,放到spring容器中 * 一个job对应一个trigger实例,有多个job时copy下来改一下 */
@Bean
public Trigger xxxTrigger() {
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("*/10 * * * * ?");
return TriggerBuilder.newTrigger()
.withIdentity("xxxTrigger", "defaultTriggerGroup") //指定trigger实例的name、所属的group
.forJob(xxxJobDetail()) //调用获取JobDetail的方法,关联JobDetail
.startNow()
.withSchedule(scheduleBuilder)
.build();
}
}
在yml中输入quartz即可查看quartz的配置项,一般使用springboot提供的默认配置即可,不用修改。
官方文档地址:https://www.xuxueli.com/xxl-job
1、下载最新稳定版的压缩包,解压,在IDEA中导入
用于生产时不要直接检出最新的源码,最新的源码中可能含有已提交但尚未发布的部分,不稳定,尽量使用已发布的版本。包含的模块如下
2、在navicat中,执行doc/db下的sql脚本初始化xxl-job的数据库
3、xxl-job-admin 调度中心(web控制台)
xxl-job-admin集群部署时,各xxl-job-admin节点务必连接同一个mysql数据库、节点机器的时钟务必保持一致;如果mysql做主从,xxl-job-admin各节点务必强制走主库。
启动应用后,登录系统,初始化系统数据
4、在xxl-job-executor-sample-springboot 执行器中编写定时任务
server.port=8081
#调度中心的访问地址,有多个url时逗号分隔
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
#要注册到调度中心的哪个执行器上,执行器要是
xxl.job.executor.appname=xxx
#与调度中心通信使用的端口
xxl.job.executor.port=9999
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
/** * 简单任务示例(Bean模式) */
@XxlJob("demoJobHandler") //@XxlJob将方法标识为一个job(定时任务),指定此job的name
public ReturnT<String> demoJobHandler(String param) throws Exception { //参数是调度中心控制台创建任务实例时指定的任务参数
//.....
XxlJobLogger.log("xxx"); //XxlJobLogger.log()打印的是日志只显示在调度中心->调度日志->执行日志中,不会输出到std、file之类的logger终端
return ReturnT.FAIL; //ReturnT.SUCCESS是任务执行成功,ReturnT.FAIL是任务执行失败
}
#执行器集群部署时,调度中心支持的路由策略如下
ROUND(轮询)
FIRST(第一个):固定选择第一个节点
LAST(最后一个):固定选择最后一个节点
RANDOM(随机):随机选择在线的节点
CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某个节点,且所有任务均匀散列在不同节点上。
LEAST_FREQUENTLY_USED(最不经常使用):优先选择使用频率最低的节点
LEAST_RECENTLY_USED(最近最久未使用):优先选择最久未使用的节点
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的节点选定为目标执行器并发起调度
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的节点选定为目标执行器并发起调度
SHARDING_BROADCAST(分片广播):广播触发对应集群中所有节点执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务
#调度过于密集,执行器来不及处理任务实例时,调度中心提供的阻塞处理策略如下
单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO队列并以串行方式运行
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务
一共7个字段,依次是
前6个必填,第7个选填、可以缺省。
使用示例
# ?表示不关心该字段的值,用于第六个(day of week)字段
# 一般前面写0,后面写*,*表示任意值
#直接写数字表示在指定时间执行。如果年月日时分秒都写死,则只在指定时间执行一次
0 0 10 * * ? # 每天10点执行1次
0 0 0 1 * ? #每月1号凌晨执行1次
# */n 表示每隔n执行1次,也可以写成0/n
0 0 */2 * * ? #每隔2小时执行1次
# -表示区间
0 0 10-14 * * ? # 每天的10、11、12、13、14点各执行1次
# ,表示或者
0 0 9,15,21 * * ? #每天9点、15点、21点各执行1次