JAVA-定时任务@Scheduled && 解决定时任务执行多次@SchedulerLock 加锁

文章目录

记录JAVA项目中利用@Scheduled 配置定时任务，并利用@SchedulerLock加锁解决多实例部署定时任务多次执行的问题。

@Scheduled 定时任务

@Scheduled 可直接在所需函数上配置使用，超级简单便捷。

使用方法

@Scheduled(fixedDelay = 1000)
上一个任务结束到下一个任务开始的时间间隔为固定的1秒，任务的执行总是要先等到上一个任务的执行结束后再执行。这里单位为毫秒，所以为1000
@Scheduled(fixedRate = 1000)
每间隔1秒钟就会执行任务（如果任务执行的时间超过1秒，则下一个任务在上一个任务结束之后立即执行）。
@Scheduled(fixedDelay = 1000, initialDelay = 2000)
initialDelay第一次执行的任务将会延迟2秒钟后才会启动，
@Scheduled(cron = “0 * * * * ?”)
Cron表达式，每分钟执行一次

Cron表达式

Cron表达式在线工具，类型选择“ Java(Quartz)”：https://tool.lu/crontab/

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

（1） Seconds Minutes Hours DayofMonth Month DayofWeek Year
（2）Seconds Minutes Hours DayofMonth Month DayofWeek
在这里插入图片描述
（1）*：表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。

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

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

（4）/：表示起始时间开始触发，然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次，而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，表示某月的第二个星期三。

Cron表达式范例：
每隔5秒执行一次：/5 * ?
每隔1分钟执行一次：0 /1 ?
每天23点执行一次：0 0 23 ?
每天凌晨1点执行一次：0 0 1 ?
每月1号凌晨1点执行一次：0 0 1 1 * ?
每月最后一天23点执行一次：0 0 23 L * ?
每周星期天凌晨1点实行一次：0 0 1 ? * L

@SchedulerLock 加锁

遇到了在起多实例的情况会造成定时任务的多次执行，可以使用锁来解决该问题@SchedulerLock

shedlock提供了mongo、redis、zookeeper、jdbc等的锁实现，这里使用jdbc。

使用步骤

1、在pom.xml引入相关依赖

       <dependency>
			<groupId>net.javacrumbs.shedlock</groupId>
			<artifactId>shedlock-spring</artifactId>
			<version>4.42.0</version>
		</dependency>

		<dependency>
			<groupId>net.javacrumbs.shedlock</groupId>
			<artifactId>shedlock-provider-jdbc-template</artifactId>
			<version>4.42.0</version>
		</dependency>

2、在数据库建表shedlock

CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until TIMESTAMP(3) NOT NULL,
    locked_at TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3), locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

@SchedulerLock声明的锁名称自动创建对应的键值对，提供锁。
@SchedulerLock(name = “xx”）name值对应的是库里的name的赋值。
定时任务执行会在shedlock表里有锁的信息，如果该表为空则表示配置未生效，需检查自己的配置了

属性说明:
name 锁名称，name必须是主键
lock_until 释放锁时间
locked_at 获取锁时间
locked_by 锁提供者

3、配置类

package com.xx.config;

import net.javacrumbs.shedlock.core.LockProvider;
import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;
import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.scheduling.annotation.EnableScheduling;

import javax.sql.DataSource;
import java.time.Duration;

@Configuration
@EnableScheduling
@EnableSchedulerLock(defaultLockAtMostFor = "10m")
public class ShedlockConfig {
    
    
    @Bean
    public LockProvider lockProvider(DataSource dataSource) {
    
    
        return new JdbcTemplateLockProvider(
                JdbcTemplateLockProvider.Configuration.builder()
                        .withJdbcTemplate(new JdbcTemplate(dataSource))
                        .usingDbTime() // Works on Postgres, MySQL, MariaDb, MS SQL, Oracle, DB2, HSQL and H2
                        .build()
        );
    }
}

4、在所需任务函数添加相应注解

例如: 这儿配置每10分钟执行一次，该锁将持有5分钟，5分钟后释放; 当节点异常或者死亡，该锁默认在15分钟后自动释放。
在正常情况下，ShedLock在任务完成后立即释放锁定。@EnableSchedulerLock中也提供了默认值，我们也可以直接只填写name即可,在这配置了的话会覆盖默认配置

	@Scheduled(cron = "0 0 * * * ?")
    @SchedulerLock(name = "test",
            lockAtMostFor = 15 * 60 * 1000, lockAtLeastFor = 5 * 60 * 1000)
    public void test(){
    
    
        log.info(String.format("EXECUTE:%s",true));
    }

lockAtMostFor 单位毫秒
lockAtMostForString 使用“ PT14M” 意味着它将被锁定不超过14分钟。

lockAtLeastFor 单位毫秒
lockAtLeastForString 使用“ PT14M” 或"PT30S”

注解参数说明：
● name: 锁名称,锁名称必须是唯一的,同时在一个时间内只能执行一个任务。
● lockAtMostFor: 指定在执行节点死亡时应将锁保留多长时间。这只是一个备用选项，在正常情况下，任务完成后立即释放锁定。使用时必须将其设置lockAtMostFor为比正常执行时间长得多的值。如果任务花费的时间超过 lockAtMostFor了所导致的行为，则可能无法预测（更多的进程将有效地持有该锁）。
● lockAtLeastFor: 保留锁的最短时间，防止如果定时的执行时间短，不同节点之间的服务器时间存在差异，导致定时重复执行

线程

scheduled默认是所有定时任务都在一个线程中执行。也就是说定时任务1一直在执行，定时任务2一直在等待定时任务1执行完成。为了避免相互等待的情况，可以为定时任务配置线程池

@Configuration
public class ScheduleConfig implements SchedulingConfigurer {
    
    
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
    
    
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(50));
    }
}

在程序启动后，会逐步启动50个线程，放在线程池中。每个定时任务会占用1个线程。但是相同的定时任务，执行的时候，还是在同一个线程中。

也可配置异步执行，相同的任务也不会相互影响。

配置类

@Configuration
@EnableAsync
public class ScheduleConfig {
    
    
    @Bean
    public TaskScheduler taskScheduler() {
    
    
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
        taskScheduler.setPoolSize(50);
        return taskScheduler;
    }
}

在方法上添加注解@Async 即可, 同一个定时任务也会启动多个线程处理

	@Async
	@Scheduled(cron = "0 0 * * * ?")
    @SchedulerLock(name = "test",
            lockAtMostFor = 15 * 60 * 1000, lockAtLeastFor = 5 * 60 * 1000)
    public void test(){
    
    
        log.info(String.format("EXECUTE:%s",true));
    }

参考：https://github.com/lukas-krecan/ShedLock
https://blog.csdn.net/reinsunshine/article/details/126094351