SpringBoot定时任务及Quartz

一.通过@Scheduled实现定时任务

1.1 开启定时任务方法

Scheduled定时任务是Spring boot自身提供的功能,所以不需要引入Maven依赖包,在项目入口main方法上加注解:

//开启定时任务
@EnableScheduling

1.2 不同定时方式的解析

1.fixedDelay和fixedRate,单位是毫秒,它们的区别就是:

  • fixedRate就是每隔多长时间执行一次。(开始------->X时间------>再开始)。如果间隔时间小于任务执行时间,上一次任务执行完成下一次任务就立即执行。如果间隔时间大于任务执行时间,就按照每隔X时间运行一次。
  • 而fixedDelay是当任务执行完毕后一段时间再次执行。(开始--->结束(隔一分钟)开始----->结束)。上一次执行任务未完成,下一次任务不会开始。

2.cron表达式:灵活
举例说明

表达式 说明
0 0 3 * * ? 每天3点执行
0 5 3 * * ? 每天3点5分执行
0 5 3 ? * * 每天3点5分执行,与上面作用相同
0 5/10 3 * * ? 每天3点的 5分,15分,25分,35分,45分,55分这几个时间点执行
0 10 3 ? * 1 每周星期天,3点10分 执行,注:1表示星期天
0 10 3 ? * 1#3 每个月的第三个星期,星期天 执行,#号只能出现在星期的位置
  • 第一位,表示秒,取值0-59
  • 第二位,表示分,取值0-59
  • 第三位,表示小时,取值0-23
  • 第四位,日期天/日,取值1-31
  • 第五位,日期月份,取值1-12
  • 第六位,星期,取值1-7,星期一,星期二...,注:不是第1周,第二周的意思,另外:1表示星期天,2表示星期一。
  • 第七位,年份,可以留空,取值1970-2099

cron中,还有一些特殊的符号,含义如下:
()星号:可以理解为每的意思,每秒,每分,每天,每月,每年...
(?)问号:问号只能出现在日期和星期这两个位置。
(-)减号:表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10,11,12
(,)逗号:表达一个列表值,如在星期字段中使用“1,2,4”,则表示星期一,星期二,星期四
(/)斜杠:如:x/y,x是开始值,y是步长,比如在第一位(秒) 0/15就是,从0秒开始,每15秒,最后就是0,15,30,45,60 另:
/y,等同于0/y

1.3 实现定时任务

@Component
public class ScheduledJobs {
  
    //表示方法执行完成后5秒再开始执行
    @Scheduled(fixedDelay=5000)
    public void fixedDelayJob() throws InterruptedException{
        System.out.println("fixedDelay 开始:" + new Date());
        Thread.sleep(10 * 1000);
        System.out.println("fixedDelay 结束:" + new Date());
    }
    
    //表示每隔3秒
    @Scheduled(fixedRate=3000)
    public void fixedRateJob()throws InterruptedException{
        System.out.println("===========fixedRate 开始:" + new Date());
        Thread.sleep(5 * 1000);
        System.out.println("===========fixedRate 结束:" + new Date());
    }

    //表示每隔10秒执行一次
    @Scheduled(cron="0/10 * * * * ? ")
    public void cronJob(){
        System.out.println("=========================== ...>>cron...." + new Date());
    }
}

启动项目,输出结果如下:

===========fixedRate 开始:Mon Jul 10 15:06:46 CST 2023
===========fixedRate 结束:Mon Jul 10 15:06:51 CST 2023
fixedDelay 开始:Mon Jul 10 15:06:51 CST 2023
fixedDelay 结束:Mon Jul 10 15:07:01 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:01 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:06 CST 2023
=========================== ...>>cron....Mon Jul 10 15:07:06 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:06 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:11 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:11 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:17 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:17 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:22 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:22 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:27 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:27 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:32 CST 2023
fixedDelay 开始:Mon Jul 10 15:07:32 CST 2023
fixedDelay 结束:Mon Jul 10 15:07:42 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:42 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:47 CST 2023
=========================== ...>>cron....Mon Jul 10 15:07:47 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:47 CST 2023
===========fixedRate 结束:Mon Jul 10 15:07:52 CST 2023
===========fixedRate 开始:Mon Jul 10 15:07:52 CST 2023

从运行结果上看,并未按照预期的时间规律运行。仔细看线程打印,竟然所有的定时任务使用的都是一个线程,所以彼此互相影响。

1.4 解决定时任务单线程运行的问题

@Configuration
@EnableScheduling
public class ScheduleConfig implements SchedulingConfigurer {
 
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setScheduler(scheduledTaskExecutor());
    }
 
    @Bean
    public Executor scheduledTaskExecutor() {
        return Executors.newScheduledThreadPool(3); //指定线程池大小
    }
}

二.quartz简单定时任务

2.1 引入对应的 maven依赖

在 springboot2.0 后官方添加了 Quartz 框架的依赖,所以只需要在 pom 文件当中引入



    org.springframework.boot
    spring-boot-starter-quartz

2.2 创建一个任务类Job

首先,我们需要定义一个接口来实现计时功能。我们可以将其称为任务(或任务),例如:定期发送电子邮件的任务,重新启动机器的任务以及在优惠券到期时发送SMS提醒的任务。

public class QuartzSimpleTask implements Job {

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("quartz简单的定时任务执行时间:"+new Date().toLocaleString());
    }
}

通过实行Job接口或者继承QuartzJobBean类实现任务类。

2.3 创建 Quartz 定时配置类

还需要一个可以触发任务执行的触发器,触发器的基本功能是指定作业的执行时间,执行间隔和运行时间。如何分配触发器以执行指定的作业?此时,需要一个Schedule来实现此功能。
将之前创建的定时任务添加到定时调度里面:

@Configuration
public class QuartzSimpleConfig {
    //指定具体的定时任务类
    @Bean
    public JobDetail uploadTaskDetail() {
        return JobBuilder.newJob(QuartzSimpleTask.class)
                        .withIdentity("QuartzSimpleTask")
                        .storeDurably().build();
    }

    @Bean
    public Trigger uploadTaskTrigger() {
        //这里设定触发执行的方式
        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("*/5 * * * * ?");
        // 返回任务触发器
        return TriggerBuilder.newTrigger().forJob(uploadTaskDetail())
                .withIdentity("QuartzSimpleTask")
                .withSchedule(scheduleBuilder)
                .build();
    }
}

最后运行项目查看效果,"*/5 * * * * ?"表示定时任务,每隔5秒钟执行一次。

2.4 Quartz核心概念

  • Job:一个仅包含一个void execute(JobExecutionContext context)Abstract方法的简单接口。在实际开发中,要执行的任务是通过实现接口自定义实现的。JobExecutionContext提供调度上下文信息。

  • JobDetail:包含多个构造函数,最常用的是JobDetail(String name, String group, Class jobClass)jobClass是实现作业接口的类,name是调度程序中任务的名称,group是调度程序中任务的组名。默认组名称为Scheduler.DEFAULT_GROUP

  • Trigger:描述触发作业执行的时间规则的类。包含:
    1.SimpleTrigger:一次或固定间隔时间段的触发规则。可以在指定的时间段内执行一个Job任务,也可以在一个时间段内多次执行。
    2.CronTrigger:通过cron表达式描述更复杂的触发规则。它基于Calendar进行作业调度,并且可以比SimpleTrigger更精确地指定间隔。

  • Calendar:Quartz 提供的Calendar类。触发器可以与多个Calendar关联以排除特殊日期。

  • Scheduler:代表独立于Quartz 的运行容器。在Scheduler 中注册了Trigger和JobDetail。它们在调度程序中具有自己的名称(名称)和组名称(Group)。触发器和JobDetail名称和组名称的组合必须唯一,但是触发器名称和组名称的组合可以与JobDetail相同。一个Job可以绑定到多个触发器,也可以不绑定。

你可能感兴趣的:(SpringBoot定时任务及Quartz)