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

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

什么是ShedLock

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

如何使用

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

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

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

1.啟用并配置計劃鎖定

首先，引入依賴

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

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

@Configuration 
@EnableScheduling 
@EnableSchedulerLock（defaultLockAtMostFor  =  “ PT30S ”）
 類 MySpringConfiguration {
     ... 
}

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

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

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

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

與Spring進行整合,ShedLock支持兩種Spring集成模式。

TaskScheduler代理

需要配置兩個Bean，一個是lockProvider，一個是scheduler

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

由于ShedLock使用Mongo，JDBC數(shù)據(jù)庫，Redis，Hazelcast，ZooKeeper等外部存儲進行協(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會在每個帶@SchedulerLock注釋的方法周圍創(chuàng)建AOP代理。這種方法的主要優(yōu)點是它不依賴于Spring調(diào)度。缺點是即使您直接調(diào)用該方法也會應(yīng)用鎖定。還要注意，目前僅支持void返回方法，如果您注釋并調(diào)用具有非void返回類型的方法，則會引發(fā)異常。

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