解析SpringBoot框架如何配置ShedLock分布式定時(shí)任務(wù)

在 Java 中有一個(gè)叫做 timer 的定時(shí)器，在一定時(shí)間反復(fù)重復(fù)一件事情。那么在當(dāng)下最流行的微服務(wù)框架 SpringBoot 是否也有類(lèi)似的功能框架呢？答案是有的。下面我將為大家詳細(xì)介紹關(guān)于 SpringBoot 框架中的定時(shí)任務(wù)框架 ShedLock。

什么是ShedLock

ShedLock是一個(gè)在分布式環(huán)境中使用的定時(shí)任務(wù)框架，用于解決在分布式環(huán)境中的多個(gè)實(shí)例的相同定時(shí)任務(wù)在同一時(shí)間點(diǎn)重復(fù)執(zhí)行的問(wèn)題，解決思路是通過(guò)對(duì)公用的數(shù)據(jù)庫(kù)中的某個(gè)表進(jìn)行記錄和加鎖，使得同一時(shí)間點(diǎn)只有第一個(gè)執(zhí)行定時(shí)任務(wù)并成功在數(shù)據(jù)庫(kù)表中寫(xiě)入相應(yīng)記錄的節(jié)點(diǎn)能夠成功執(zhí)行而其他節(jié)點(diǎn)直接跳過(guò)該任務(wù)。當(dāng)然不只是數(shù)據(jù)庫(kù)，目前已經(jīng)實(shí)現(xiàn)的支持?jǐn)?shù)據(jù)存儲(chǔ)類(lèi)型除了經(jīng)典的關(guān)系型數(shù)據(jù)庫(kù)，還包括MongoDB，Zookeeper，Redis，Hazelcast。

如何使用

ShedLock采用非侵入式編程的思想，通過(guò)注解的方式來(lái)實(shí)現(xiàn)相應(yīng)的功能。

要使用ShedLock，請(qǐng)執(zhí)行以下操作

• 啟用并配置計(jì)劃鎖定
• 注釋您的計(jì)劃任務(wù)
• 配置鎖提供程序

1.啟用并配置計(jì)劃鎖定

首先，引入依賴

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

現(xiàn)在我們需要將庫(kù)集成到Spring中。為了啟用計(jì)劃鎖定，請(qǐng)使用@EnableSchedulerLock注釋

@Configuration 
@EnableScheduling 
@EnableSchedulerLock（defaultLockAtMostFor  =  “ PT30S ”）
 類(lèi) MySpringConfiguration {
     ... 
}

注釋您的計(jì)劃任務(wù)

import  net.javacrumbs.shedlock.core.SchedulerLock ;
 
...
 
@Scheduled（...）@
 SchedulerLock（name  =  “ scheduledTaskName ”）
 public  void scheduledTask（）{
    //做某事 
}

@SchedulerLock注解一共支持五個(gè)參數(shù)，分別是

name 用來(lái)標(biāo)注一個(gè)定時(shí)服務(wù)的名字，被用于寫(xiě)入數(shù)據(jù)庫(kù)作為區(qū)分不同服務(wù)的標(biāo)識(shí)，如果有多個(gè)同名定時(shí)任務(wù)則同一時(shí)間點(diǎn)只有一個(gè)執(zhí)行成功
lockAtMostFor 成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有獨(dú)占鎖的最長(zhǎng)時(shí)間，單位是毫秒ms
lockAtMostForString 成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有的獨(dú)占鎖的最長(zhǎng)時(shí)間的字符串表達(dá)，例如“PT14M”表示為14分鐘
lockAtLeastFor 成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有獨(dú)占所的最短時(shí)間，單位是毫秒ms
lockAtLeastForString 成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有的獨(dú)占鎖的最短時(shí)間的字符串表達(dá)，例如“PT14M”表示為14分鐘

與Spring進(jìn)行整合,ShedLock支持兩種Spring集成模式。

TaskScheduler代理

需要配置兩個(gè)Bean，一個(gè)是lockProvider，一個(gè)是scheduler

默認(rèn)情況下，ShedLock在Spring周?chē)鷦?chuàng)建AOP代理TaskScheduler。如果未指定任務(wù)計(jì)劃程序，則會(huì)為您創(chuàng)建默認(rèn)任務(wù)計(jì)劃程序。如果您有特殊需求，只需創(chuàng)建一個(gè)bean實(shí)現(xiàn)TaskScheduler接口，它將自動(dòng)包裝到AOP代理中。

由于ShedLock使用Mongo，JDBC數(shù)據(jù)庫(kù)，Redis，Hazelcast，ZooKeeper等外部存儲(chǔ)進(jìn)行協(xié)調(diào)。所以我選擇的是redis。

<dependency>
    <groupId> net.javacrumbs.shedlock </ groupId >
    <artifactId > shedlock-provider-redis-spring </ artifactId >
    <version> 2.5.0 </version>
</dependency >
 
  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>

@Configuration
@EnableScheduling
@EnableSchedulerLock(defaultLockAtMostFor = "PT5M")
public class ShedLockConfig {
 
 
    @Bean
    public LockProvider lockProvider(RedisTemplate redisTemplate){
        return new RedisLockProvider(redisTemplate.getConnectionFactory());
        
    }
    @Bean 
    public  TaskScheduler taskScheduler（）{
     return  new  MySpecialTask??Scheduler（）;
    }
    
}

預(yù)定方法代理

如果你有更多特殊需求，可以像這樣使用Scheduled Method代理

@EnableSchedulerLock（mode  =  PROXY_METHOD，defaultLockAtMostFor  =  “ PT30S ”）

如果PROXY_METHOD選擇了mode，則ShedLock會(huì)在每個(gè)帶@SchedulerLock注釋的方法周?chē)鷦?chuàng)建AOP代理。這種方法的主要優(yōu)點(diǎn)是它不依賴于Spring調(diào)度。缺點(diǎn)是即使您直接調(diào)用該方法也會(huì)應(yīng)用鎖定。還要注意，目前僅支持void返回方法，如果您注釋并調(diào)用具有非void返回類(lèi)型的方法，則會(huì)引發(fā)異常。

到此本篇關(guān)于 SpringBoot 配置 ShedLock 分布式定時(shí)任務(wù)的文章就介紹到這了,想要了解更多相關(guān) SpringBoot ShedLock分布式定時(shí)任務(wù)的其他內(nèi)容請(qǐng)搜索W3Cschool以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持我們！