(1)cron 表达式是一个用于指定定时任务执行时间的字符序列。它由 6 个或 7 个域组成,中间使用空格分开,每个域分别表示秒、分、小时、日期、月份、星期和年(可省略)。cron 表达式有如下两种语法格式:
(2)每一个域可出现的字符如下:
Seconds
:可出现", - * /"
四个字符,有效范围为 0-59 的整数;Minutes
:可出现", - * /"
四个字符,有效范围为 0-59 的整数;Hours
:可出现", - * /"
四个字符,有效范围为 0-23 的整数;DayofMonth
:可出现", - * / ? L W C"
八个字符,有效范围为 0-31 的整数;Month
:可出现", - * /"
四个字符,有效范围为 1-12 的整数或 JAN-DEC;DayofWeek
:可出现", - * / ? L C #"
八个字符,有效范围为 1-7 的整数或 SUN-SAT 两个范围。1 表示星期天,2 表示星期一, 依次类推;Year
:可出现", - * /"
四个字符,有效范围为 1970-2099 年;(3)每一个域都使用数字,但还可以出现如下特殊字符,它们的含义是:
*
:表示匹配该域的任意值,假如在 Minutes
域使用 *,即表示每分钟都会触发事件。?
:只能用在 DayofMonth
和 DayofWeek
两个域。它也匹配域的任意值,但实际不会。因为 DayofMonth
和 DayofWeek
会相互影响。例如想在每月的 20 日触发调度,不管 20 日到底是星期几,则只能使用如下写法:13 13 15 20 * ?
,其中最后一位只能用 ?,而不能使用 *
,如果使用 *
表示不管星期几都会触发,实际上并不是这样。-
:表示范围,例如在 Minutes 域使用 5-20,表示从 5 分到 20 分钟每分钟触发一次。/
:表示数值的增量,简单来说,比如分写上 0/5 表示从0分开始,每隔 5 分钟。,
:表示列出枚举值值。例如:在 Minutes 域使用5,20,则意味着在第 5 和第 20 分钟分别触发一次。L
:表示最后,只能出现于 DayofWeek 和 DayofMonth 域,如果在 DayofWeek
域使用5L,意味着在最后的一个星期四触发。W
:表示有效工作日(周一到周五),只能用于 DayofMonth 域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth
使用 5W,如果 5 日是星期六,则将在最近的工作日:星期五,即 4 日触发。如果 5 日是星期天,则在 6 日(周一)触发;如果 5 日在星期一到星期五中的一天,则就在 5 日触发。另外一点,W 的最近寻找不会跨过月份。LW
:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个非周六周末的日期。#
:用于确定每个月第几个星期几,只能用于 DayofWeek 域,例如在 4#2
,表示某月的第二个星期三。(4)通过这些符号的组合,cron 表达式可以非常灵活地指定任务的执行时间。例如,0 0 12 * * ?
表示每天中午 12 点执行任务,0 0/5 * * * ?
表示每隔 5 分钟执行任务。cron 表达式的格式非常有规律,因此很容易书写和修改,同时也非常强大和灵活。在 Java 中,可以使用类库Quartz 和 Spring 的 @Scheduled 注解等来支持 cron 表达式。
① 参考自cron 百度百科。
② 有时编写复杂的 cron 表达式比较麻烦,因此我们可以通过在线 cron 表达式生成器来辅助我们。
(1)@Scheduled
注解用于创建定时任务,通过使用该注解,可以在指定的时间间隔内反复执行带有注解的方法。@Scheduled 注解支持 cron 表达式、固定速率和固定延迟等方式来指定任务的执行时间。
(2)@Scheduled 注解有以下属性:
(3)这些属性可以在 @Scheduled 中任意组合使用,来达到定制定时任务的目的。需要注意的是,@Scheduled 注解要求其所在的类必须是 Spring 管理的 Bean,因此一般需要将类定义为 @Component
或 @Service
等注解的组件类。同时,如果需要使用到 cron 表达式来执行任务,则需要手动配置 cron 表达式。
spring-boot-starter-quartz 是一个 Spring Boot 的快速启动器 (Starter),它提供了在 Spring Boot 应用程序中添加 Quartz 定时任务的依赖和自动配置。Quartz 是一个用于创建和管理定时任务的框架,它提供了非常丰富的功能,例如支持 cron 表达式设定执行时间、支持任务优先级、并且具有失败重试机制等。Quartz 自带线程池,可以高效地执行大量任务,而且支持分布式处理。因此,在 Spring Boot 应用程序中使用 Quartz 是很常见的。
(1)我们可以使用 @Schedule
注解创建一个定时任务:
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
//这个任务会在每天的中午 12 点执行,输出一行文字
@Component
public class MyTask {
@Scheduled(cron = "0 0 12 * * ?")
public void execute() {
System.out.println("定时任务执行了!");
}
}
然后,在启动类上添加 @Enablescheduling
注解,该注解的作用是发现注解@Scheduled
的任务并在后台执行该任务。在 Spring Boot 应用程序中,默认情况下是关闭计划任务的,通过添加 @EnableScheduling 注解,Spring 就会扫描注解的 Bean 并将其注册在使用了 @Scheduled 注解的方法上。在使用 @EnableScheduling 注解之前,需要确保 Spring Boot 项目中已经添加了 spring-boot-starter
或 spring-boot-starter-web
依赖,因为这两个依赖默认引入了 Spring 的计划任务依赖 spring-context-support
。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling //开启定时任务
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
(2)需要注意的是,@EnableScheduling 注解只是开启了 Spring 的计划任务功能。如果需要使用 Quartz
框架等更强大的定时任务工具,还需要在应用程序中添加相应的依赖和配置。最后,除了使用 @Scheduled 注解,还可以使用 Spring Boot 提供的 ScheduledExecutorService
或实现 Runnable
接口来创建定时任务。首先,在应用程序中导入 java.util.concurrent.ScheduledExecutorService
类,然后创建一个 ScheduledExecutorService
对象,并且按照需要设置延迟时间和间隔时间即可。
使用 Spring Boot 搭建的应用程序,默认提供了 Spring 自带的定时任务功能,但是,如果需要更加丰富、复杂的任务调度功能,推荐使用 Quartz 框架。而 spring-boot-starter-quartz 是Spring Boot提供的一个构建基于 Quartz 的应用程序的启动器。下面是使用 spring-boot-starter-quartz 进行任务调度的步骤:
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-quartzartifactId>
dependency>
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.stereotype.Component;
@Component
public class MyJob implements Job {
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
System.out.println("定时任务开始执行...");
}
}
import org.quartz.JobDetail;
import org.quartz.SimpleTrigger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.quartz.JobDetailFactoryBean;
import org.springframework.scheduling.quartz.SimpleTriggerFactoryBean;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
@Configuration
public class QuartzConfig {
@Autowired
private MyJob myJob;
@Bean
public JobDetailFactoryBean jobDetailFactoryBean() {
JobDetailFactoryBean factory = new JobDetailFactoryBean();
factory.setJobClass(MyJob.class);
factory.setDurability(true);
return factory;
}
@Bean
public SimpleTriggerFactoryBean triggerFactoryBean() {
SimpleTriggerFactoryBean factory = new SimpleTriggerFactoryBean();
factory.setJobDetail(jobDetailFactoryBean().getObject());
factory.setStartDelay(0L);
factory.setRepeatInterval(5000);
factory.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
return factory;
}
@Bean
public SchedulerFactoryBean schedulerFactoryBean() {
SchedulerFactoryBean factory = new SchedulerFactoryBean();
factory.setJobDetails(new JobDetail[]{jobDetailFactoryBean().getObject()});
factory.setTriggers(triggerFactoryBean().getObject());
return factory;
}
}
在上述代码中,我们使用 JobDetailFactoryBean
、SimpleTriggerFactoryBean
和 SchedulerFactoryBean
来配置 Quartz 的相关参数。其中,JobDetailFactoryBean
用于将 Job 类绑定到 Quartz 上下文中,SimpleTriggerFactoryBean
用于定义执行该 Job 的调度策略,而SchedulerFactoryBean
则是将前面的两个 Bean 组合成一个调度工厂实例。
@SpringBootApplication
启动类中加上 @EnableQuartz
注解开启 Quartz。import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.scheduling.annotation.EnableQuartz;
@SpringBootApplication
@EnableScheduling
@EnableAsync
@Configuration
@EnableQuartz
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}
这样就可以使用 Quartz 进行任务调度了。在上述配置中,我们定义了一个名为 MyJob 的任务,该任务将定期执行。同时,我们还定义了调度间隔等参数,以满足复杂的需求。