(spring 分布式鎖 SchedulerLock，整合redis沖突慨菱、jdbc異常問題)

簡(jiǎn)介

ShedLock的作用焰络，確保任務(wù)在同一時(shí)刻最多執(zhí)行一次。如果一個(gè)任務(wù)正在一個(gè)節(jié)點(diǎn)上執(zhí)行符喝，則它將獲得一個(gè)鎖闪彼，該鎖將阻止從另一個(gè)節(jié)點(diǎn)（或線程）執(zhí)行同一任務(wù)。如果一個(gè)任務(wù)已經(jīng)在一個(gè)節(jié)點(diǎn)上執(zhí)行协饲，則在其他節(jié)點(diǎn)上的執(zhí)行不會(huì)等待备蚓，只需跳過它即可 课蔬。
ShedLock使用Mongo，JDBC數(shù)據(jù)庫(kù)郊尝，Redis，Hazelcast战惊，ZooKeeper或其他外部存儲(chǔ)進(jìn)行協(xié)調(diào)流昏，即通過外部存儲(chǔ)來實(shí)現(xiàn)鎖機(jī)制。

用法

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

此處以jdbc數(shù)據(jù)庫(kù)方式為例吞获，如需要使用其他外部存儲(chǔ)方式况凉，對(duì)應(yīng)修改shedlock-provider。

啟用和配置計(jì)劃的鎖定

• 導(dǎo)入schedulerLock項(xiàng)目

gradle方式

// shedlock 項(xiàng)目 , 2.1.0穩(wěn)定版
compile('net.javacrumbs.shedlock:shedlock-provider-jdbc-template:2.1.0')
// JDBC 各拷，匹配shedlock的2.2.0版
compile('net.javacrumbs.shedlock:shedlock-spring:2.2.0')

Maven方式

// shedlock 項(xiàng)目 , 2.1.0穩(wěn)定版
<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-spring</artifactId>
    <version>2.1.0</version>
</dependency>
// JDBC 刁绒，匹配shedlock的2.2.0版
<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-provider-jdbc-template</artifactId>
    <version>2.2.0</version>
</dependency>

• 啟用SchedulerLock

  使用@EnableSchedulerLock注釋將庫(kù)集成到Spring中。

import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.transaction.annotation.EnableTransactionManagement;
// 開啟定時(shí)任務(wù)注解
@EnableScheduling
// 開啟定時(shí)任務(wù)鎖烤黍，默認(rèn)設(shè)置鎖最大占用時(shí)間為30s
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")
@MapperScan(basePackages="cn.pilipa.finance.salary.persistence")
@ServletComponentScan
public class SalaryApplication {

    public static void main(String[] args) {
        SpringApplication.run(SalaryApplication.class, args);
    }
}

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

• 在定時(shí)任務(wù)上添加@SchedulerLock注解

import net.javacrumbs.shedlock.core.SchedulerLock;

...

@Scheduled(...)
@SchedulerLock(name = "scheduledTaskName")
public void scheduledTask() {
   // do something
}

配置鎖提供者

• 創(chuàng)建提供鎖的外部存儲(chǔ)（jdbc知市、redis、MongoDB...）
  例 ： JDBC 速蕊，創(chuà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)
) 

說明

DB形式的外部存儲(chǔ)需要?jiǎng)?chuàng)建表結(jié)構(gòu)，redis等非結(jié)構(gòu)形式的外部存儲(chǔ)template會(huì)根據(jù)@SchedulerLock聲明的鎖名稱自動(dòng)創(chuàng)建對(duì)應(yīng)的鍵值對(duì)规哲，提供鎖跟啤。

• 配置Bean

import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;
...
@Bean
public LockProvider lockProvider(DataSource dataSource) {
    return new JdbcTemplateLockProvider(dataSource);
}

SchedulerLock 參數(shù)

• @SchedulerLock
  只有帶注釋的方法被鎖定，庫(kù)忽略所有其他計(jì)劃的任務(wù)唉锌。您還必須指定鎖的名稱隅肥。同一時(shí)間只能執(zhí)行一個(gè)任務(wù)。
• name
  分布式鎖名稱袄简，注意 鎖名稱必須唯一腥放。
• lockAtMostFor & lockAtMostForString
  指定在執(zhí)行節(jié)點(diǎn)死亡時(shí)應(yīng)將鎖保留多長(zhǎng)時(shí)間。這只是一個(gè)備用選項(xiàng)痘番，在正常情況下捉片，任務(wù)完成后立即釋放鎖定。 您必須將其設(shè)置lockAtMostFor為比正常執(zhí)行時(shí)間長(zhǎng)得多的值汞舱。如果任務(wù)花費(fèi)的時(shí)間超過 lockAtMostFor了所導(dǎo)致的行為伍纫，則可能無法預(yù)測(cè)（更多的進(jìn)程將有效地持有該鎖）。
  lockAtMostFor 單位 毫秒
  lockAtMostForString 使用“ PT14M” 意味著它將被鎖定不超過14分鐘昂芜。
• lockAtLeastFor & lockAtLeastForString
  該屬性指定應(yīng)保留鎖定的最短時(shí)間莹规。其主要目的是在任務(wù)很短且節(jié)點(diǎn)之間的時(shí)鐘差的情況下，防止從多個(gè)節(jié)點(diǎn)執(zhí)行泌神。

例：假設(shè)您有一個(gè)任務(wù)良漱，每15分鐘執(zhí)行一次舞虱，通常需要花費(fèi)幾分鐘才能運(yùn)行。此外母市，您希望每15分鐘最多執(zhí)行一次矾兜。在這種情況下，您可以像這樣配置

@Scheduled(fixedDelay = 1000*60*15)
    @SchedulerLock(name = "queryRechargeBill", lockAtMostFor = 1000*60*15, lockAtLeastFor = 1000*60*5)
    public void queryRechargeBill(){
    // do something
}

該鎖將持有5分鐘患久，5分鐘釋放椅寺，當(dāng)節(jié)點(diǎn)異常或者死亡蒋失，該鎖默認(rèn)在15分鐘后自動(dòng)釋放返帕。在正常情況下，ShedLock在任務(wù)完成后立即釋放鎖定篙挽。實(shí)際上荆萤，我們不必這樣做，因?yàn)锧EnableSchedulerLock中提供了默認(rèn)值铣卡， 但我們選擇在此處覆蓋它链韭。

版本沖突問題

• jdbc外部存儲(chǔ)實(shí)現(xiàn) 啟動(dòng)報(bào)錯(cuò)
  nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.data.redis.connection.RedisConnectionFactory' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
  該問題是因?yàn)轫?xiàng)目中的redis自定義bean造成的，使用的redis jar（org.springframework.data:spring-data-redis）算行，造成版本沖突梧油。解決方法：
  更換redis庫(kù)

compile('org.springframework.boot:spring-boot-starter-parent:2.0.2.RELEASE')
compile('org.springframework.boot:spring-boot-starter-data-redis')

• redis 外部存儲(chǔ)實(shí)現(xiàn) 啟動(dòng)報(bào)錯(cuò)
  shedlock-provider-redis-spring 與 org.springframework.data:spring-data-redis 沖突，
  java.lang.NoSuchMethodError: org.springframework.data.redis.connection.RedisConnection.set([B[BLorg/springframework/data/redis/core/types/Expiration;Lorg/springframework/data/redis/connection/RedisStringCommands$SetOption;)Ljava/lang/Boolean;

  解決方法州邢，更換低版本的 shedlock儡陨，這里我選擇的是1.8.2版本

  • 如果您依賴spring-data-redis 2-請(qǐng)使用ShedLock 1.xx
  • 如果您依賴spring-data-redis 1-請(qǐng)使用ShedLock 0.xx
  • 在所有其他情況下，您可以使用兩個(gè)版本量淌，最好是1.xx

• 要求和依賴性
  Java 8
  SLF4J的API
  Spring框架（可選）

故障排除

1. 檢查存儲(chǔ)骗村。如果使用的是JDBC，請(qǐng)檢查ShedLock表呀枢。如果為空胚股，則未正確配置ShedLock。如果有多個(gè)同名記錄裙秋，則您缺少主鍵琅拌。
2. 使用ShedLock調(diào)試日志。ShedLock使用記錄器名稱在DEBUG級(jí)別記錄有趣的信息net.javacrumbs.shedlock摘刑。它應(yīng)該可以幫助您了解正在發(fā)生的事情进宝。
3. 對(duì)于短期任務(wù)，請(qǐng)考慮使用lockAtLeastFor枷恕。如果任務(wù)是短期運(yùn)行的党晋，它們可以一個(gè)接一個(gè)地執(zhí)行，lockAtLeastFor可以防止執(zhí)行。
4. 如果遇到奇怪的錯(cuò)誤未玻，抱怨代理不是proxy類灾而，ThreadPoolTaskScheduler請(qǐng)檢查https://github.com/lukas-krecan/ShedLock/issues/115或 此StackOverflow問題

總結(jié)

ShedLock支持兩種模式的Spring集成，分別是 預(yù)定方法代理扳剿、TaskScheduler代理旁趟。我們默認(rèn)選擇最簡(jiǎn)單也是最實(shí)用的方式：預(yù)定方法代理（即 @SchedulerLock 的形式），ShedLock會(huì)圍繞每個(gè)帶有@SchedulerLock注釋的方法創(chuàng)建AOP代理舞终。這種方法的主要優(yōu)點(diǎn)是它不依賴于Spring調(diào)度轻庆。缺點(diǎn)是即使直接調(diào)用該方法也會(huì)應(yīng)用鎖定。還應(yīng)注意敛劝，當(dāng)前僅支持返回void的方法，如果您注釋并調(diào)用具有非void返回類型的方法纷宇，則會(huì)引發(fā)異常夸盟。

預(yù)定方法代理

預(yù)定方法代理 流程圖