Java中@Scheduled定时任务详解

一、@Scheduled注解

1. cron属性

Cron表达式是一个字符串，字符串以5或6个空格隔开，分为6或7个域，每一个域代表一个含义，Cron有如下两种语法格式：

（1） Seconds Minutes Hours DayofMonth Month DayofWeek Year

（2）Seconds Minutes Hours DayofMonth Month DayofWeek

一、结构

corn从左到右（用空格隔开）：

格式：秒 分 小时 月份中的日期 月份 星期中的日期 年份

二、各字段的含义

星期：1~7的整数,1为SUN-依次为1 SUN，2 MON，3 TUE，4 WED，5 THU，6 FRI，7 SAT

注意事项：

每一个域都使用数字，但还可以出现如下特殊字符，它们的含义是：

（1）*：表示匹配该域的任意值。假如在Minutes域使用*, 即表示每分钟都会触发事件。

（2）?：只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?, 其中最后一位只能用？，而不能使用*，如果使用*表示不管星期几都会触发，实际上并不是这样。

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

（4）/：表示起始时间开始触发，然后每隔固定时间触发一次。例如在Minutes域使用5/20,则从第5分钟开始，每隔20分钟触发一次，即25，45等分别触发一次.

（5）,：表示列出枚举值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次。

（6）L：表示最后，只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。

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

（8）LW:这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。

（9）#:用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的第二个星期三。

三、常用表达式例子

注：

（1）有些子表达式能包含一些范围或列表

例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”

*字符代表所有可能的值

因此，*在子表达式（月）里表示每个月的含义，*在子表达式（天（星期））表示星期的每一天

/字符用来指定数值的增量
例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟
在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样

？字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值
　　当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”

L字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写
　　但是它在两个子表达式里的含义是不同的。
　　在天（月）子表达式中，“L”表示一个月的最后一天
　　在天（星期）子表达式中，“L”表示一个星期的最后一天，也就是SAT

如果在“L”前有具体的内容，它就具有其他的含义了

例如：“6L”表示这个月的倒数第６天，“FRIL”表示这个月的最一个星期五
注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题

2. fixedRate属性[不推荐使用]

fixedRate属性是上一个调用开始后再次调用的延时（不用等待上一次调用完成），这样就会存在重复执行的问题，不推荐使用。

3. fixedDelay属性

fixedDelay属性的效果与上面的fixedRate则是相反的，配置了该属性后会等到方法执行完成后延迟配置的时间再次执行该方法。

@Scheduled(fixedDelay = 5000)
public void doSomething() {
   // something that should execute periodically
}

说明：上面的配置将以一个固定延迟时间5秒钟调用一次执行，这个周期是以上一个调用任务的完成时间为基准，在上一个任务完成之后，5s后再次执行

4. initialDelay属性

initialDelay属性跟上面的fixedDelay、fixedRate有着密切的关系，该属性的作用是第一次执行延迟时间，只是做延迟的设定，并不会控制其他逻辑，所以要配合fixedDelay或者fixedRate来使用。

二、@SchedulerLock注解

1.@SchedulerLock分布式锁简介

ShedLock是一个在分布式环境中使用的定时任务框架，用于解决在分布式环境中的多个实例的相同定时任务在同一时间点重复执行的问题。ShedLock确保计划的任务最多同时执行一次。如果一个任务正在一个节点上执行，它会获得一个锁，该锁将阻止从另一个节点（或线程）执行同一任务。请注意，如果一个任务已经在一个节点上执行，则在其他节点上的执行不会等待，只是将其跳过。。简单来说，ShedLock本身只做一件事情：保证一个任务最多同时执行一次。所以如官网所说的，ShedLock不是一个分布式调度器，只是一个锁!

注意：ShedLock支持Mongo，Redis，Hazelcast，ZooKeeper以及任何带有JDBC驱动程序的东西

2.@SchedulerLock注解说明

@SchedulerLock注解一共支持五个参数，分别是

• name：用来标注一个定时服务的名字，被用于写入数据库作为区分不同服务的标识，如果有多个同名定时任务则同一时间点只有一个执行成功
• lockAtMostFor：成功执行任务的节点所能拥有独占锁的最长时间，单位是毫秒ms
• lockAtMostForString：成功执行任务的节点所能拥有的独占锁的最长时间的字符串表达，例如“PT14M”表示为14分钟，单位可以是S,M,H
• lockAtLeastFor：成功执行任务的节点所能拥有独占所的最短时间，单位是毫秒ms
• lockAtLeastForString：成功执行任务的节点所能拥有的独占锁的最短时间的字符串表达，例如“PT14M”表示为14分钟,单位可以是S,M,H

一般这么配置：

	/**
	 * 活动结束定时任务
	 */
	@Scheduled(cron = "0 10 * * * ?")
	@SchedulerLock(name = "endGameEconomyActivity", lockAtMostFor = "5m", lockAtLeastFor = "1m")
	public void endGameEconomyActivity() {
		gameEconomyActivityService.endUserActivity();
	}
		

三、定时任务实例

说明：此例子是基于Redis方式实现的
第一步：maven中引入以下jia包

		<dependency>
            <groupId>net.javacrumbs.shedlock</groupId>
            <artifactId>shedlock-spring</artifactId>
            <version>2.3.0</version>
        </dependency>
        <dependency>
            <groupId>net.javacrumbs.shedlock</groupId>
            <artifactId>shedlock-provider-redis-spring</artifactId>
            <version>2.3.0</version>
        </dependency>
        
        <!--spring2.0集成redis所需common-pool2 -->
        <!-- 必须加上，jedis依赖这个， 若项目中已经引入jedis 请忽略此步骤-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

第二步：SchedulerLock 基于 Redis 的配置

/*
*defaultLockAtMostFor 指定在执行节点结束时应保留锁的默认时间，时间使用ISO8601 Duration格式
*作用就是在被加锁的节点挂了时，无法释放锁，造成其他节点无法进行下一任务
*/
@Configuration
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")  //这里我设置的是30秒
public class TaskLockConfiguration {
	
	
	@Bean
    public LockProvider lockProvider(RedisTemplate redisTemplate) {
        return new RedisLockProvider(redisTemplate.getConnectionFactory());
    }

}

第三步：开启定时任务服务
在启动类上添加@EnableScheduling ，表明开启定时器服务。若不加定时器是不会起效的。

@SpringBootApplication
@EnableScheduling  //加上这个注解
public class EpidemicMessageApplication {

    public static void main(String[] args) {
        SpringApplication.run(EpidemicMessageApplication.class, args);
    }
}

第四步：开始写定时任务

	/**
	 * 处理卡包过期任务
	 */
	@Scheduled(cron = "0 10 * * * ?")  //10分钟执行一次
	@SchedulerLock(name = "dealCardOverdue", lockAtMostFor = "5m", lockAtLeastFor = "1m")
	public void dealCardOverdue() {
		cardBagService.dealCardOverdue();
	}

注意：我的定时任务业务逻辑是写在cardBagService里的，所有还是那套service调dao，这里不做展示，根据自己的业务而定