定时任务锁 - springboot使用shedlock 和 mongo

项目中使用的定时任务较多，基本都是通过Scheduled 来实现的，但是分布式部署，程序部署多份的话，在各个服务上全她丫的跑起来了，做着同样的事情，尤其是某些需要修改缓存或者修改数据库的定时任务。我们就需要一个锁来管理，让任务就只有一个在执行，其他任务在发现有其他任务在执行时，就放弃执行。有一个更方便的东西那就是shedlock。

shedlock就做一件事,就是确保计划任务最多同时执行一次;如果正在一个节点上执行任务,它将获取一个锁,以防止从另一个节点(或线程)执行相同任务。需要注意的是，过去一个任务已在某个节点上执行了，那么其他的节点上的任务就不会等待，会放弃本次的执行；目前支持Mongo、JDBC数据库、redis、hazelcast或zookeeper协调的spring scheduled task。

ShedLock采用非侵入式编程的思想，通过注解的方式来实现相应的功能。
以 mongo 为例
首先就需要引入需要的包,

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

<!-- 这里采用mongodb作为中间表用于记录任务信息-->
        <dependency>
            <groupId>net.javacrumbs.shedlock</groupId>
            <artifactId>shedlock-provider-mongo</artifactId>
            <version>3.0.0</version>
</dependency>

在启动类上加上注解

....
// ······ PT30S，是30秒的意思
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(Oms2RtocRtdcacheApplication.class, args);
    }
}

编写config
使用mongodb作为中间表，存储任务信息。配置类需要给它把连接实例放进去，使用其他数据库同理。

import com.mongodb.client.MongoCollection;
import net.javacrumbs.shedlock.core.LockProvider;
import net.javacrumbs.shedlock.provider.mongo.MongoLockProvider;
import org.bson.Document;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.core.MongoTemplate;

@Configuration
public class ShedLockConfig {
    @Autowired
    private MongoTemplate template;

    @Bean
    public LockProvider lockProvider(){
        MongoCollection<Document> mongo = template.getCollection("time_work");
        return new MongoLockProvider(mongo);
    }
}

然后，在需要控制的任务上添加注解

@Scheduled(cron = "* */10 * * * ?")
@SchedulerLock(name = "test1", lockAtLeastForString ="PT9M", lockAtMostFor = "PT10M")
public void test1()throws Exception{
       log.info("定时任务执行" );
}

执行定时任务时会在mongodb中写入一个任务执行的记录，通过时间来判断是否被执行锁，它保证集群或者分布式部署下，多个节点同时执行定时任务，只有一个节点能生效执行。所以必须保证多个(服务器)节点的时间是一致。
这里面有几个参数，以下是说明：
1.SchedulerLock：核心注解
2.lockAtMostForString：最大锁定时间，为了防止某个节点宕机导致不释放锁而引起的其它节点无法执行的问题，所以这里设置的时间必须大于任务执行时间，一般情况下需要设置的大一点。
3.lockAtLeastForString：最小锁定时间，一般设置的时间比定时任务稍微小一点，比如说定时任务是10分钟执行一次，就设置9分钟

表达式“PT10M”，前缀PT是固定的，最后的S代表秒，对应的还有M，分钟；H，小时；中间的数据就是具体的时间了，比如PT10S，就是10秒，PT10M就是10分钟。