定時(shí)任務(wù)鎖 - springboot使用shedlock 和 mongo

項(xiàng)目中使用的定時(shí)任務(wù)較多艰赞，基本都是通過Scheduled 來實(shí)現(xiàn)的佣谐，但是分布式部署，程序部署多份的話方妖，在各個(gè)服務(wù)上全她丫的跑起來了狭魂，做著同樣的事情，尤其是某些需要修改緩存或者修改數(shù)據(jù)庫的定時(shí)任務(wù)党觅。我們就需要一個(gè)鎖來管理雌澄，讓任務(wù)就只有一個(gè)在執(zhí)行，其他任務(wù)在發(fā)現(xiàn)有其他任務(wù)在執(zhí)行時(shí)杯瞻，就放棄執(zhí)行镐牺。有一個(gè)更方便的東西那就是shedlock。

shedlock就做一件事,就是確保計(jì)劃任務(wù)最多同時(shí)執(zhí)行一次;如果正在一個(gè)節(jié)點(diǎn)上執(zhí)行任務(wù),它將獲取一個(gè)鎖,以防止從另一個(gè)節(jié)點(diǎn)(或線程)執(zhí)行相同任務(wù)魁莉。需要注意的是睬涧，過去一個(gè)任務(wù)已在某個(gè)節(jié)點(diǎn)上執(zhí)行了，那么其他的節(jié)點(diǎn)上的任務(wù)就不會等待沛厨，會放棄本次的執(zhí)行宙地；目前支持Mongo、JDBC數(shù)據(jù)庫逆皮、redis宅粥、hazelcast或zookeeper協(xié)調(diào)的spring scheduled task。

ShedLock采用非侵入式編程的思想电谣，通過注解的方式來實(shí)現(xiàn)相應(yīng)的功能秽梅。
以 mongo 為例
首先就需要引入需要的包,

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

<!-- 這里采用mongodb作為中間表用于記錄任務(wù)信息-->
        <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作為中間表剿牺，存儲任務(wù)信息企垦。配置類需要給它把連接實(shí)例放進(jìn)去，使用其他數(shù)據(jù)庫同理晒来。

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);
    }
}

然后钞诡，在需要控制的任務(wù)上添加注解

@Scheduled(cron = "* */10 * * * ?")
@SchedulerLock(name = "test1", lockAtLeastForString ="PT9M", lockAtMostFor = "PT10M")
public void test1()throws Exception{
       log.info("定時(shí)任務(wù)執(zhí)行" );
}

執(zhí)行定時(shí)任務(wù)時(shí)會在mongodb中寫入一個(gè)任務(wù)執(zhí)行的記錄，通過時(shí)間來判斷是否被執(zhí)行鎖湃崩，它保證集群或者分布式部署下荧降，多個(gè)節(jié)點(diǎn)同時(shí)執(zhí)行定時(shí)任務(wù)，只有一個(gè)節(jié)點(diǎn)能生效執(zhí)行攒读。所以必須保證多個(gè)(服務(wù)器)節(jié)點(diǎn)的時(shí)間是一致朵诫。
這里面有幾個(gè)參數(shù)，以下是說明：
1.SchedulerLock：核心注解
2.lockAtMostForString：最大鎖定時(shí)間薄扁，為了防止某個(gè)節(jié)點(diǎn)宕機(jī)導(dǎo)致不釋放鎖而引起的其它節(jié)點(diǎn)無法執(zhí)行的問題剪返，所以這里設(shè)置的時(shí)間必須大于任務(wù)執(zhí)行時(shí)間废累，一般情況下需要設(shè)置的大一點(diǎn)。
3.lockAtLeastForString：最小鎖定時(shí)間脱盲，一般設(shè)置的時(shí)間比定時(shí)任務(wù)稍微小一點(diǎn)邑滨，比如說定時(shí)任務(wù)是10分鐘執(zhí)行一次，就設(shè)置9分鐘

表達(dá)式“PT10M”宾毒，前綴PT是固定的驼修，最后的S代表秒，對應(yīng)的還有M诈铛，分鐘乙各；H，小時(shí)幢竹；中間的數(shù)據(jù)就是具體的時(shí)間了耳峦，比如PT10S，就是10秒焕毫，PT10M就是10分鐘蹲坷。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者