关于@Scheduled参数及cron表达式解释

  • Z时代
  • 2024-01-10
  • 分类：IT

@Scheduled参数及cron表达式解释

@Scheduled支持以下8个参数

  • 1.cron：表达式，指定任务在特定时间执行；

  • 2.fixedDelay：表示上一次任务执行完成后多久再次执行，参数类型为long，单位ms；

  • 3.fixedDelayString：与fixedDelay含义一样，只是参数类型变为String；

  • 4.fixedRate：表示按一定的频率执行任务，即每次开始执行的时间间隔一致，参数类型为long，单位ms；

  • 5.fixedRateString：与fixedRate的含义一样，只是将参数类型变为String；

  • 6.initialDelay：表示延迟多久再第一次执行任务，参数类型为long，单位ms；

  • 7.initialDelayString：与initialDelay的含义一样，只是将参数类型变为String；

  • 8.zone：时区，默认为当前时区。

cron表达式是一个字符串，以空格分开共6个域

  • [秒] [分] [时] [日] [月] [周]

  • spring自带的定时任务cron表达式不支持年

如图：

在这里插入图片描述

上图类中有如下源代码：

private void parse(String expression) throws IllegalArgumentException {
	String[] fields = StringUtils.tokenizeToStringArray(expression, " ");
	if (!areValidCronFields(fields)) {
		throw new IllegalArgumentException(String.format(
				"Cron expression must consist of 6 fields (found %d in \"%s\")", fields.length, expression));
	}
	doParse(fields);
}
private static boolean areValidCronFields(String[] fields) {
	return (fields != null && fields.length == 6);
}

代码中expression参数即cron表达式，所以在spring自带的定时任务中正确的cron表达式只能是6个域，否则会抛出IllegalArgumentException提示：Cron expression must consist of 6 fields（cron表达式必须由6个域组成）。

域必填允许值允许的通配符
秒（seconds）是0-59整数, - * /
分（minutes）是0-59整数, - * /
时（hours）是0-23整数, - * /
日（daysOfMonth）是1-31整数（需要考虑月的天数）, - * ? / L W
月（months）是1-12整数 或 JAN-DEC, - * /
周 （daysOfWeek）是1-7整数 或 SUN-SAT, - * ? / L #

通配符说明

  • *：表示匹配该域的任意值。在minutes域使用 * 表示每分钟。在months里表示每个月。在daysOfWeek域表示一周的每一天。

  • ?：只能用在daysofMonth和daysofWeek两个域，表示不指定值，当两个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为 ？。因为daysofMonth和daysofWeek会相互影响。例如想在每月的2号触发调度，不管2号是周几，则只能使用如下写法：0 0 0 2 * ?, 其中最后一位只能用?，而不能使用*，如果使用*表示不管周几都会触发。

  • -：表示范围。例如在minutes域使用5-20，表示从5分到20分钟每分钟触发一次

  • /：表示起始时间开始触发，然后每隔固定时间触发一次。例如在minutes域使用5/20，则意味着从当前小时的第5分钟开每20分钟触发一次。

  • ,：表示列出枚举值。例如：在minutes域使用5,20，则意味着在5分和20分时各触发一次。

  • L：表示最后，是单词“last”的缩写，只能出现在daysofWeek和dayofMonth域。在daysofWeek域使用5L意思是在指定月的最后的一个星期四触发。在dayofMonth域使用5L或者FRIL意思是在指定月的倒数第5天触发。在使用L参数时，不要指定列表或范围。

  • W：表示有效工作日(周一到周五),只能出现在daysofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在daysofMonth使用5W，如果5号是周六，则将在最近的工作日周五，即4号触发。如果5号是周日，则在6日(周一)触发。如果5日在星期一到星期五中的一天，则就在5日触发。另外，W的最近寻找不会跨过月份 。

  • LW：这两个字符可以连用，表示指定月的最后一个工作日。

  • #：用于确定每个月第几个周几，只能出现在daysofMonth域。例如在4#2，表示某月的第二个周三。

常用表达式示例

  • 0/2 * * * * ? 表示每2秒 执行任务

  • 0 0/2 * * * ? 表示每2分钟 执行任务

  • 0 0 2 1 * ? 表示在每月的1日的凌晨2点调整任务

  • 0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业

  • 0 0 10,14,16 * * ? 每天上午10点，下午2点，4点

  • 0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时

  • 0 0 12 ? * WED 表示每个星期三中午12点

  • 0 0 12 * * ? 每天中午12点触发

  • 0 15 10 ? * * 每天上午10:15触发

  • 0 15 10 * * ? 每天上午10:15触发

  • 0 15 10 * * ? 每天上午10:15触发

  • 0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发

  • 0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发

  • 0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

  • 0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发

  • 0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发

  • 0 15 10 ? * MON-WED,SAT 周一至周三和周六的上午10:15触发

  • 0 15 10 15 * ? 每月15日上午10:15触发

  • 0 15 10 L * ? 每月最后一日的上午10:15触发

  • 0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发

  • 0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

@Scheduled 定时任务总结

@Scheduled

  • 作用：spring定时器(定时执行一次或定时轮询执行一段代码)

  • 使用场景：注解在方法上

  • 参数说明：常用参数

@Scheduled 参数说明

  • String cron:cron表达式定义了方法执行的时间规则(网上对这个的说明很多就不墨迹了)

生成器工具地址-http://cron.qqe2.com/

  • Long fixedDelay：定时任务每隔多久执行一次，单位是毫秒，上一次任务结束后开始计算下次执行的时间。

例子：@Scheduled(fixedDelay = 1000 * 10) //10秒发送一次

······················scheduled1开始执行·······················2018-07-27 14:00:00

······················scheduled1结束执行·······················2018-07-27 14:00:05

······················scheduled2开始执行·······················2018-07-27 14:00:15

······················scheduled2结束执行·······················2018-07-27 14:00:20

······················scheduled3开始执行·······················2018-07-27 14:00:30

······················scheduled3结束执行·······················2018-07-27 14:00:35

  • Long fixedRate：与fixedDelay一样表示定时任务的执行时间间隔，不同的是fixedRate的不会受到上一次任务结束时间的影响

例子：@Scheduled(fixedRate = 1000 * 10) //10秒发送一次

······················scheduled1开始执行·······················2018-07-27 14:00:00

······················scheduled1结束执行·······················2018-07-27 14:00:05

······················scheduled2开始执行·······················2018-07-27 14:00:10

······················scheduled2结束执行·······················2018-07-27 14:00:15

······················scheduled3开始执行·······················2018-07-27 14:00:20

······················scheduled3结束执行·······················2018-07-27 14:00:25

  • Long initialDelay：项目启动后不马上执行定时器，根据initialDelay的值延时执行。

注意事项

1.定时器的参数有两种写法是用cron表达式，或者使用fixedDelay、fixedRate等参数直接配置

需要注意的是 使用cron表达式的方法，在项目首次启动后不会直接运行，而是等到执行周期才会执行

而使用第二种方式的定时器方法，在项目启动成功后会马上开始执行一次，再按照时间周期执行。

测试说明：

使用第一种配置方式，项目启动后方法不会执行，而是等到执行周期到了才会执行方法

使用第二种参数方式的方法，项目启动成功后马上执行了一次

2.定时器默认为单线程，所以如果项目中使用多个定时器要配置线程池

注意这里的@EnableScheduling，使用它来开启定时器注解

@Configuration
@EnableScheduling
public class SchedulingConfig implements SchedulingConfigurer { 
	@Override
	public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
		taskRegistrar.setScheduler(taskExecutor());
	}
	@Bean(destroyMethod="shutdown")
    public Executor taskExecutor() {
        return Executors.newScheduledThreadPool(5 ,new ThreadFactory() {
        	private final AtomicLong counter = new AtomicLong();
			@Override
			public Thread newThread(Runnable r) {
				Thread thread = new Thread(r);
				thread.setName("test-scheduler-" + counter.incrementAndGet());
				return thread;
			}			
		});
    }	
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。

以上是 关于@Scheduled参数及cron表达式解释 的全部内容， 来源链接： utcz.com/p/251786.html

回到顶部