SpringBoot 集成 ShedLock 分佈式鎖的示例詳解

CREATE TABLE shedlock(
    name VARCHAR(64), 
    lock_until TIMESTAMP(3) NULL, 
    locked_at TIMESTAMP(3) NULL, 
    locked_by  VARCHAR(255), 
    PRIMARY KEY (name)
)

<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依賴此 若項目中已經引入jedis 請忽略此步驟-->
        <!-- spring boot 2.0 的操作手冊有標註 大傢可以去看看 地址是：https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/ -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

 <!--spring2.0集成redis所需common-pool2 -->
        <!-- 必須加上，jedis依賴此 若項目中已經引入jedis 請忽略此步驟-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

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 指定在執行節點結束時應保留鎖的默認時間使用ISO8601 Duration格式
//作用就是在被加鎖的節點掛瞭時，無法釋放鎖，造成其他節點無法進行下一任務
//這裡默認55s
//關於ISO8601 Duration格式用的不到，具體可上網查詢下相關資料，應該就是一套規范，規定一些時間表達方式
@EnableSchedulerLock(defaultLockAtMostFor = "PT55S")
public class ShedLockRedisConfig {

    @Value("${spring.profiles.active}")
    private String env;

    @Bean
    public LockProvider lockProvider(RedisConnectionFactory connectionFactory) {
        //環境變量 -需要區分不同環境避免沖突，如dev環境和test環境，兩者都部署時，隻有一個實例進行，此時會造成相關環境未啟動情況
        return new RedisLockProvider(connectionFactory, env);
    }
}

@SpringBootApplication
@EnableScheduling
public class EpidemicMessageApplication {

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

//區分服務
    @Value("${server.port}")
    private String port;
    
    @Scheduled(cron = "0 */1 * * * ?")
    /**
     * lockAtLeastForString的作用是為瞭防止在任務開始之初由於各個服務器同名任務的服務器時間差，啟動時間差等這些造成的一些問題，有瞭這個時間設置後，
     *     就可以避免因為上面這些小的時間差造成的一些意外，保證一個線程在搶到鎖後，即便很快執行完，也不要立即釋放，留下一個緩沖時間。
     *     這樣等多個線程都啟動後，由於任務已經被鎖定，其他沒有獲得鎖的任務也不會再去搶鎖。註意這裡的時間不要設置幾秒幾分鐘，盡量大些
     *lockAtMostForString 這個設置的作用是為瞭防止搶到鎖的那個線程，因為一些意外死掉瞭，而鎖又始終不被釋放。
     *     這樣的話，雖然當前執行周期雖然失敗瞭，但以後的執行周期如果這裡一直不釋放的話，後面就永遠執行不到瞭。
     *     它的目的不在於隱藏任務，更重要的是，釋放鎖，並且查找解決問題。
     *至於是否帶有string後綴，隻是2種表達方式，數字類型的就是毫秒數，字符串類型的就有自己固定的格式 ，例如：PT30S  30s時間設置，單位可以是S,M,H
     */
    @SchedulerLock(name = "scheduledController_notice", lockAtLeastForString = "PT15M", lockAtMostForString = "PT14M")
    public StandardResult notice() {
        try {
            logger.info(port + "- 執行定時器 scheduledController_notice");
            return StandardResult.ok();
        } catch (Exception e) {
            logger.error("異常信息:", e);
            return StandardResult.faild("異常信息", e);
        }
    }