如何在springcloud分佈式系統中實現分佈式鎖？

時間 2019-11-17

原文原文鏈接

最近在看分佈式鎖的資料，看了 Josial L的《Redis in Action》的分佈式鎖的章節。實現思路是利用springcloud結合redis實現分佈式鎖。java

1、簡介

通常來講，對數據進行加鎖時，程序先經過acquire獲取鎖來對數據進行排他訪問，而後對數據進行一些列的操做，最後須要釋放鎖。Redis 自己用 watch命令進行了加鎖，這個鎖是樂觀鎖。使用 watch命令對於頻繁訪問的鍵會引發性能的問題。web

2、redis命令介紹

SETNX命令（SET if Not eXists）

當且僅當 key 不存在，將 key 的值設爲 value ，並返回1；若給定的 key 已經存在，則 SETNX 不作任何動做，並返回0。redis

SETEX命令

設置超時時間spring

GET命令

返回 key 所關聯的字符串值，若是 key 不存在那麼返回特殊值 nil 。apache

DEL命令

刪除給定的一個或多個 key ,不存在的 key 會被忽略。springboot

3、實現思路

因爲redis的setnx命令天生就適合用來實現鎖的功能，這個命令只有在鍵不存在的狀況下爲鍵設置值。獲取鎖以後，其餘程序再設置值就會失敗，即獲取不到鎖。獲取鎖失敗。只需不斷的嘗試獲取鎖，直到成功獲取鎖，或者到設置的超時時間爲止。分佈式

另外爲了防治死鎖，即某個程序獲取鎖以後，程序出錯，沒有釋放，其餘程序沒法獲取鎖，從而致使整個分佈式系統沒法獲取鎖而致使一系列問題，甚至致使系統沒法正常運行。這時須要給鎖設置一個超時時間，即setex命令，鎖超時後，從而其它程序就能夠獲取鎖了。spring-boot

4、編碼實現

本文采用springboot結合redis 取實現的，因此你須要裝一個redis。性能

首先引入建立springboot工程，引入redis 。

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 開啓web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

2.建立一個鎖類ui

/**
 * 全局鎖，包括鎖的名稱
 * Created by fangzhipeng on 2017/4/1.
 */
public class Lock {
    private String name;
    private String value;

    public Lock(String name, String value) {
        this.name = name;
        this.value = value;
    }

    public String getName() {
        return name;
    }

    public String getValue() {
        return value;
    }

}

3.建立分佈式鎖的具體方法,思路已經說清楚了，代碼註釋也寫好了，就不講解了。

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;

/**
 * Created by fangzhipeng on 2017/4/1.
 */
@Component
public class DistributedLockHandler {

    private static final Logger logger = LoggerFactory.getLogger(DistributedLockHandler.class);
    private final static long LOCK_EXPIRE = 30 * 1000L;//單個業務持有鎖的時間30s，防止死鎖
    private final static long LOCK_TRY_INTERVAL = 30L;//默認30ms嘗試一次
    private final static long LOCK_TRY_TIMEOUT = 20 * 1000L;//默認嘗試20s

    @Autowired
    private StringRedisTemplate template;

    /**
     * 嘗試獲取全局鎖
     *
     * @param lock 鎖的名稱
     * @return true 獲取成功，false獲取失敗
     */
    public boolean tryLock(Lock lock) {
        return getLock(lock, LOCK_TRY_TIMEOUT, LOCK_TRY_INTERVAL, LOCK_EXPIRE);
    }

    /**
     * 嘗試獲取全局鎖
     *
     * @param lock    鎖的名稱
     * @param timeout 獲取超時時間 單位ms
     * @return true 獲取成功，false獲取失敗
     */
    public boolean tryLock(Lock lock, long timeout) {
        return getLock(lock, timeout, LOCK_TRY_INTERVAL, LOCK_EXPIRE);
    }

    /**
     * 嘗試獲取全局鎖
     *
     * @param lock        鎖的名稱
     * @param timeout     獲取鎖的超時時間
     * @param tryInterval 多少毫秒嘗試獲取一次
     * @return true 獲取成功，false獲取失敗
     */
    public boolean tryLock(Lock lock, long timeout, long tryInterval) {
        return getLock(lock, timeout, tryInterval, LOCK_EXPIRE);
    }

    /**
     * 嘗試獲取全局鎖
     *
     * @param lock           鎖的名稱
     * @param timeout        獲取鎖的超時時間
     * @param tryInterval    多少毫秒嘗試獲取一次
     * @param lockExpireTime 鎖的過時
     * @return true 獲取成功，false獲取失敗
     */
    public boolean tryLock(Lock lock, long timeout, long tryInterval, long lockExpireTime) {
        return getLock(lock, timeout, tryInterval, lockExpireTime);
    }


    /**
     * 操做redis獲取全局鎖
     *
     * @param lock           鎖的名稱
     * @param timeout        獲取的超時時間
     * @param tryInterval    多少ms嘗試一次
     * @param lockExpireTime 獲取成功後鎖的過時時間
     * @return true 獲取成功，false獲取失敗
     */
    public boolean getLock(Lock lock, long timeout, long tryInterval, long lockExpireTime) {
        try {
            if (StringUtils.isEmpty(lock.getName()) || StringUtils.isEmpty(lock.getValue())) {
                return false;
            }
            long startTime = System.currentTimeMillis();
            do{
                if (!template.hasKey(lock.getName())) {
                    ValueOperations<String, String> ops = template.opsForValue();
                    ops.set(lock.getName(), lock.getValue(), lockExpireTime, TimeUnit.MILLISECONDS);
                    return true;
                } else {//存在鎖
                    logger.debug("lock is exist!！！");
                }
                if (System.currentTimeMillis() - startTime > timeout) {//嘗試超過了設定值以後直接跳出循環
                    return false;
                }
                Thread.sleep(tryInterval);
            }
            while (template.hasKey(lock.getName())) ;
        } catch (InterruptedException e) {
            logger.error(e.getMessage());
            return false;
        }
        return false;
    }

    /**
     * 釋放鎖
     */
    public void releaseLock(Lock lock) {
        if (!StringUtils.isEmpty(lock.getName())) {
            template.delete(lock.getName());
        }
    }

}

4.用法：

@Autowired
DistributedLockHandler distributedLockHandler;
Lock lock=new Lock("lockk","sssssssss);
if(distributedLockHandler.tryLock(lock){
    doSomething();
    distributedLockHandler.releaseLock();
}