SpringBoot 集成 ShedLock 分布式鎖的示例詳解
一:ShedLock 簡(jiǎn)介
ShedLock是一個(gè)在分布式環(huán)境中使用的定時(shí)任務(wù)框架,用于解決在分布式環(huán)境中的多個(gè)實(shí)例的相同定時(shí)任務(wù)在同一時(shí)間點(diǎn)重復(fù)執(zhí)行的問(wèn)題。ShedLock確保計(jì)劃的任務(wù)最多同時(shí)執(zhí)行一次。如果一個(gè)任務(wù)正在一個(gè)節(jié)點(diǎn)上執(zhí)行,它會(huì)獲得一個(gè)鎖,該鎖將阻止從另一個(gè)節(jié)點(diǎn)(或線程)執(zhí)行同一任務(wù)。請(qǐng)注意,如果一個(gè)任務(wù)已經(jīng)在一個(gè)節(jié)點(diǎn)上執(zhí)行,則在其他節(jié)點(diǎn)上的執(zhí)行不會(huì)等待,只是將其跳過(guò)。。簡(jiǎn)單來(lái)說(shuō),ShedLock本身只做一件事情:保證一個(gè)任務(wù)最多同時(shí)執(zhí)行一次。所以如官網(wǎng)所說(shuō)的,ShedLock不是一個(gè)分布式調(diào)度器,只是一個(gè)鎖!
注意:ShedLock支持Mongo,Redis,Hazelcast,ZooKeeper以及任何帶有JDBC驅(qū)動(dòng)程序的東西。本例子使用的是基于Redis的方式。之所以不適用基于jdbc存儲(chǔ)的主要原因是考慮到大量數(shù)據(jù)下的數(shù)據(jù)庫(kù)壓力的原因,若本身基于jdbc等,可直接參考官網(wǎng)給出的提示:
創(chuàng)建對(duì)應(yīng)的表結(jié)構(gòu)。
CREATE TABLE shedlock( name VARCHAR(64), lock_until TIMESTAMP(3) NULL, locked_at TIMESTAMP(3) NULL, locked_by VARCHAR(255), PRIMARY KEY (name) )
二:配置maven 依賴(lài)
<dependency> <groupId>net.javacrumbs.shedlock</groupId> <artifactId>shedlock-spring</artifactId> <version>2.3.0</version> </dependency> <dependency> <groupId>net.javacrumbs.shedlock</groupId> <artifactId>shedlock-provider-redis-spring</artifactId> <version>2.3.0</version> </dependency> <!--spring2.0集成redis所需common-pool2 --> <!-- 必須加上,jedis依賴(lài)此 若項(xiàng)目中已經(jīng)引入jedis 請(qǐng)忽略此步驟--> <!-- spring boot 2.0 的操作手冊(cè)有標(biāo)注 大家可以去看看 地址是:https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/ --> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-pool2</artifactId> </dependency>
添加jedis 依賴(lài) 若項(xiàng)目中已經(jīng)引入jedis 請(qǐng)忽略此步驟
<!--spring2.0集成redis所需common-pool2 --> <!-- 必須加上,jedis依賴(lài)此 若項(xiàng)目中已經(jīng)引入jedis 請(qǐng)忽略此步驟--> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-pool2</artifactId> </dependency>
三:SchedulerLock 基于 Redis 的配置
配置 lockProvider 并且開(kāi)啟 @EnableSchedulerLock 標(biāo)簽
import net.javacrumbs.shedlock.core.LockProvider; import net.javacrumbs.shedlock.provider.redis.spring.RedisLockProvider; import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnectionFactory; /** * @Description SchedulerLock 基于 Redis 的配置 * @Author * @Date 2020/2/22 18:27 **/ @Configuration //defaultLockAtMostFor 指定在執(zhí)行節(jié)點(diǎn)結(jié)束時(shí)應(yīng)保留鎖的默認(rèn)時(shí)間使用ISO8601 Duration格式 //作用就是在被加鎖的節(jié)點(diǎn)掛了時(shí),無(wú)法釋放鎖,造成其他節(jié)點(diǎn)無(wú)法進(jìn)行下一任務(wù) //這里默認(rèn)55s //關(guān)于ISO8601 Duration格式用的不到,具體可上網(wǎng)查詢(xún)下相關(guān)資料,應(yīng)該就是一套規(guī)范,規(guī)定一些時(shí)間表達(dá)方式 @EnableSchedulerLock(defaultLockAtMostFor = "PT55S") public class ShedLockRedisConfig { @Value("${spring.profiles.active}") private String env; @Bean public LockProvider lockProvider(RedisConnectionFactory connectionFactory) { //環(huán)境變量 -需要區(qū)分不同環(huán)境避免沖突,如dev環(huán)境和test環(huán)境,兩者都部署時(shí),只有一個(gè)實(shí)例進(jìn)行,此時(shí)會(huì)造成相關(guān)環(huán)境未啟動(dòng)情況 return new RedisLockProvider(connectionFactory, env); } }
四:在啟動(dòng)類(lèi)中添加 @EnableScheduling 標(biāo)簽
注意,要在啟動(dòng)類(lèi)上添加 @EnableScheduling ,表明開(kāi)啟定時(shí)器服務(wù)。若不加定時(shí)器是不會(huì)起效的。
@SpringBootApplication @EnableScheduling public class EpidemicMessageApplication { public static void main(String[] args) { SpringApplication.run(EpidemicMessageApplication.class, args); } }
五:test 測(cè)試案例
//區(qū)分服務(wù) @Value("${server.port}") private String port; @Scheduled(cron = "0 */1 * * * ?") /** * lockAtLeastForString的作用是為了防止在任務(wù)開(kāi)始之初由于各個(gè)服務(wù)器同名任務(wù)的服務(wù)器時(shí)間差,啟動(dòng)時(shí)間差等這些造成的一些問(wèn)題,有了這個(gè)時(shí)間設(shè)置后, * 就可以避免因?yàn)樯厦孢@些小的時(shí)間差造成的一些意外,保證一個(gè)線程在搶到鎖后,即便很快執(zhí)行完,也不要立即釋放,留下一個(gè)緩沖時(shí)間。 * 這樣等多個(gè)線程都啟動(dòng)后,由于任務(wù)已經(jīng)被鎖定,其他沒(méi)有獲得鎖的任務(wù)也不會(huì)再去搶鎖。注意這里的時(shí)間不要設(shè)置幾秒幾分鐘,盡量大些 *lockAtMostForString 這個(gè)設(shè)置的作用是為了防止搶到鎖的那個(gè)線程,因?yàn)橐恍┮馔馑赖袅?,而鎖又始終不被釋放。 * 這樣的話,雖然當(dāng)前執(zhí)行周期雖然失敗了,但以后的執(zhí)行周期如果這里一直不釋放的話,后面就永遠(yuǎn)執(zhí)行不到了。 * 它的目的不在于隱藏任務(wù),更重要的是,釋放鎖,并且查找解決問(wèn)題。 *至于是否帶有string后綴,只是2種表達(dá)方式,數(shù)字類(lèi)型的就是毫秒數(shù),字符串類(lèi)型的就有自己固定的格式 ,例如:PT30S 30s時(shí)間設(shè)置,單位可以是S,M,H */ @SchedulerLock(name = "scheduledController_notice", lockAtLeastForString = "PT15M", lockAtMostForString = "PT14M") public StandardResult notice() { try { logger.info(port + "- 執(zhí)行定時(shí)器 scheduledController_notice"); return StandardResult.ok(); } catch (Exception e) { logger.error("異常信息:", e); return StandardResult.faild("異常信息", e); } }
SchedulerLock注解說(shuō)明
@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分鐘,單位可以是S,M,H
lockAtLeastFor:成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有獨(dú)占所的最短時(shí)間,單位是毫秒ms
lockAtLeastForString:成功執(zhí)行任務(wù)的節(jié)點(diǎn)所能擁有的獨(dú)占鎖的最短時(shí)間的字符串表達(dá),例如“PT14M”表示為14分鐘,單位可以是S,M,H
到此這篇關(guān)于SpringBoot 集成 ShedLock 分布式鎖的文章就介紹到這了,更多相關(guān)SpringBoot 分布式鎖ShedLock內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
使用Java的Lucene搜索工具對(duì)檢索結(jié)果進(jìn)行分組和分頁(yè)
這篇文章主要介紹了使用Java的搜索工具Lucene對(duì)檢索結(jié)果進(jìn)行分組和分頁(yè)的方法,Luence是Java環(huán)境中的一個(gè)全文檢索引擎工具包,需要的朋友可以參考下2016-03-03java中int轉(zhuǎn)string與string轉(zhuǎn)int的效率對(duì)比
這篇文章主要介紹了java中int轉(zhuǎn)string與string轉(zhuǎn)int的效率對(duì)比,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03java基本教程之java線程等待與java喚醒線程 java多線程教程
這篇文章主要介紹了對(duì)線程等待/喚醒方法,文中使用了多個(gè)示例,大家參考使用吧2014-01-01Spring?AOP操作的相關(guān)術(shù)語(yǔ)及環(huán)境準(zhǔn)備
這篇文章主要為大家介紹了Spring?AOP操作的相關(guān)術(shù)語(yǔ)及環(huán)境準(zhǔn)備學(xué)習(xí),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-05-05Java設(shè)計(jì)模式之橋模式(Bridge模式)介紹
這篇文章主要介紹了Java設(shè)計(jì)模式之橋模式(Bridge模式)介紹,本文講解了為什么使用橋模式、如何實(shí)現(xiàn)橋模式、Bridge模式在EJB中的應(yīng)用等內(nèi)容,需要的朋友可以參考下2015-03-03springdata jpa使用Example快速實(shí)現(xiàn)動(dòng)態(tài)查詢(xún)功能
這篇文章主要介紹了springdata jpa使用Example快速實(shí)現(xiàn)動(dòng)態(tài)查詢(xún)功能,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11如何將IDEA打成jar包并在windows后臺(tái)運(yùn)行
在本篇文章里小編給大家分享的是關(guān)于如何將IDEA打成jar包并在windows后臺(tái)運(yùn)行知識(shí)點(diǎn),需要的朋友們可以學(xué)習(xí)參考下。2019-08-08