Java-Redis-Redisson分散式鎖的功能使用及實現

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RedissonLock {
    int lockTime() default 3; //加鎖的時間預設3秒,  如果任務在3秒內執行完畢那麼自動釋放鎖,如果任務3秒內沒有執行完畢也會釋放鎖, 所以內容執行時間過長適當加大鎖的時間
    String key() default "" ;  //唯一標識,如果沒有那麼預設為token->sessionId
    String doc() default "重複提交請求,請稍後再試";
    boolean repeatLock() default false; //可重複加鎖直到加鎖成功,預設為false不能重複加鎖
    int repeatLockCount() default -1; //可重複加鎖限制加鎖的次數, 預設-1直到成功,設定10那麼加鎖10次都沒成功就直接返回
    int lockWaitTimeMs() default 100; //重複加鎖預設的阻塞時間100毫秒,可以自己定義
}

import com.application.Result;
import com.commonutils.NullUtils;
import com.redis.utils.DistributedRedisLock;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
@Aspect
@Component
public class RepeatSubmitAspect {
    @Value("${spring.redis.redisson.tokenName}")
    private  String tokenName;
    @Autowired
    private DistributedRedisLock redisLock;
    @Pointcut("@annotation(noRepeatSubmit)")
    public void pointCut(RedissonLock noRepeatSubmit) {
    }
    public static HttpServletRequest getRequest() {
        ServletRequestAttributes ra= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        return ra.getRequest();
    }
    @Around("pointCut(noRepeatSubmit)")
    public Object around(ProceedingJoinPoint pjp, RedissonLock noRepeatSubmit) throws Throwable {
        int lockSeconds = noRepeatSubmit.lockTime();
        String doc = noRepeatSubmit.doc();
        String keyName = noRepeatSubmit.key();
        boolean b = noRepeatSubmit.repeatLock();
        int repeatLockCount = noRepeatSubmit.repeatLockCount();
        int lockWaitTimeMs = noRepeatSubmit.lockWaitTimeMs();
        HttpServletRequest request = getRequest();
        Assert.notNull(request, "request can not null");
        //如果沒有唯一表示那麼就使用token或者sessionID來唯一表示
        if(!NullUtils.notEmpty(keyName)){
            String token = request.getHeader(tokenName);
            if(NullUtils.notEmpty(token)){
                keyName=token;
            }else{
                //使用sessionID (注意保證分散式session共用)
                keyName = request.getSession().getId();
            }
            System.out.println("tokenName:"+keyName);
        }
        String path = request.getServletPath();
        String key = getKey(keyName, path);
        //加鎖
        boolean isSuccess = redisLock.acquire(key, lockSeconds,b,repeatLockCount,lockWaitTimeMs);
        if (isSuccess) {
            // 獲取鎖成功
            Object result;
            try {
                // 執行
                result = pjp.proceed();
            } finally {
                // 解鎖
                redisLock.release(key);
            }
            return result;
        } else {
            // 獲取鎖失敗，認為是重複提交的請求
            return Result.Error(doc);
        }
    }
    private String getKey(String token, String path) {
        return token + path;
    }
}

/**
 * 簡要描述
 *
 * @Author: huanmin
 * @Date: 2022/8/1 17:39
 * @Version: 1.0
 * @Description: 檔案作用詳細描述....
 */

import com.multithreading.utils.SleepTools;
import lombok.SneakyThrows;
import org.redisson.api.RLock;
import org.redisson.api.RedissonClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;

@Component
public class DistributedRedisLock {
    private static final Logger logger = LoggerFactory.getLogger(DistributedRedisLock.class);
    //從設定類中獲取redisson物件
    @Autowired
    private RedissonClient redissonClient;
    private final String LOCK_TITLE = "redisLock_";
    private final ThreadLocal<Integer> count = new ThreadLocal<>();//計數

    //加鎖 , 執行緒加鎖的時候發現,鎖有人用了 ,那麼就會進入自旋等待
    @SneakyThrows
    public boolean acquire(String lockKey, long seconds, boolean repeatLock, int repeatLockCount, int lockWaitTimeMs) {
        count.set(0); //初始化值
        //獲取鎖物件
        RLock mylock = redissonClient.getLock((LOCK_TITLE + lockKey));
        do {
            //嘗試加鎖
            boolean b = mylock.tryLock(0, seconds, TimeUnit.SECONDS);;
            if (b) {
                logger.info("獲取鎖成功");
                return true;
            }
            logger.info("嘗試獲取鎖" + Thread.currentThread().getName());
            //獲取加鎖的次數,如果是-1那麼持續加鎖,如果滿足加鎖次數那麼結束加鎖
            if (repeatLockCount != -1 && count.get().equals(repeatLockCount)) {
                logger.warn(Thread.currentThread().getName() + "嘗試加鎖失敗以嘗試了:" + count.get() + "次");
                return false;
            }
            SleepTools.ms(lockWaitTimeMs);
            //加鎖次數增加
            count.set(count.get() + 1);
        } while (repeatLock);
        logger.warn("重複提交");
        return false;
    }

    //手動鎖的釋放
    public void release(String lockKey) {
        //獲取所物件
        RLock mylock = redissonClient.getLock((LOCK_TITLE + lockKey));
        // 這裡判斷下當前key是否上鎖，不然業務執行時間大於鎖自動釋放時間後，解鎖報異常
        if (mylock.isLocked()&&mylock.isHeldByCurrentThread()) { // 是否還是鎖定狀態並且鎖是當前執行緒的
                mylock.unlock(); // 釋放鎖
                logger.info("解鎖:" + lockKey);
        }

    }
}

    /***
     *預設加鎖3秒
     * 加鎖的key為token->sessionId
     * 加鎖失敗不可重複加鎖
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock
    @GetMapping(value = "/updateAgeAsyncLock" )
    public Result updateAgeAsyncLock() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }

    /***
     * 預設加鎖3秒
     * 加鎖失敗不可重複加鎖
     * 加鎖的key為token->sessionId
     * 提示:  加鎖失敗
     */
    @RedissonLock(doc = "加鎖失敗")
    @GetMapping(value = "/updateAgeAsyncLockDoc" )
    public Result updateAgeAsyncLockDoc() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }
    /***
     * 預設加鎖15秒
     * 加鎖失敗不可重複加鎖
     * 加鎖的key為token->sessionId
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15)
    @GetMapping(value = "/updateAgeAsyncLock0" )
    public Result updateAgeAsyncLock0() {
         userService.updateAgeAsyncLock();
         return Result.Ok();
    }

    /***
     * 預設加鎖15秒
     * 加鎖失敗不可重複加鎖
     * 加鎖的key為updateAgeAsyncLock
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15,key = "updateAgeAsyncLock")
    @GetMapping(value = "/updateAgeAsyncLock1" )
    public Result updateAgeAsyncLock1() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }
    /***
     * 預設加鎖15秒
     * 加鎖失敗可重複加鎖,直到加鎖成功
     * 加鎖的key為updateAgeAsyncLock
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15,key = "updateAgeAsyncLock",repeatLock = true)
    @GetMapping(value = "/updateAgeAsyncLock2" )
    public Result updateAgeAsyncLock2() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }

    /***
     * 預設加鎖15秒
     * 加鎖失敗可重複加鎖10次,每次預設間隔100毫秒
     * 加鎖的key為updateAgeAsyncLock
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15,key = "updateAgeAsyncLock",repeatLock = true,repeatLockCount = 10)
    @GetMapping(value = "/updateAgeAsyncLock3" )
    public Result updateAgeAsyncLock3() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }
    /***
     * 預設加鎖15秒
     * 加鎖失敗可重複加鎖10次,每次預設間隔500毫秒
     * 加鎖的key為updateAgeAsyncLock
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15,key = "updateAgeAsyncLock",repeatLock = true,repeatLockCount = 10,lockWaitTimeMs = 500)
    @GetMapping(value = "/updateAgeAsyncLock4" )
    public Result updateAgeAsyncLock4() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }
    /***
     * 預設加鎖15秒
     * 加鎖失敗可重複加鎖,直到成功,每次嘗試間隔500毫秒
     * 加鎖的key為updateAgeAsyncLock
     * 預設提示:  重複提交請求,請稍後再試
     */
    @RedissonLock(lockTime = 15,key = "updateAgeAsyncLock",repeatLock = true,lockWaitTimeMs = 500)
    @GetMapping(value = "/updateAgeAsyncLock4" )
    public Result updateAgeAsyncLock4() {
        userService.updateAgeAsyncLock();
        return Result.Ok();
    }

public class DistributedRedisLock {
    //從設定類中獲取redisson物件
    @Autowired
    private RedissonClient redissonClient;
    private  final String LOCK_TITLE = "redisLock_";
    //加鎖 , 執行緒加鎖的時候發現,鎖有人用了 ,那麼就會進入自旋等待
    public  boolean acquire(String lockName){
        //宣告key物件
        String key = LOCK_TITLE + lockName;

        //獲取鎖物件
        RLock mylock = redissonClient.getLock(key);
        //一直等待直到加鎖成功後，並且設定鎖過期時間，防止死鎖的產生
        mylock.lock(10, TimeUnit.SECONDS);
        System.err.println("======lock======"+Thread.currentThread().getName());
        //加鎖成功
        return  true;
    }
    //鎖的釋放
    public    void release(String lockName){
        //必須是和加鎖時的同一個key
        String key = LOCK_TITLE + lockName;
        //獲取所物件
        RLock mylock = redissonClient.getLock(key);
     // 這裡判斷下當前key是否上鎖，不然業務執行時間大於鎖自動釋放時間後，解鎖報異常
        if(mylock.isLocked()){ // 是否還是鎖定狀態
            if(mylock.isHeldByCurrentThread()){ // 時候是當前執行執行緒的鎖
                mylock.unlock(); // 釋放鎖
                System.err.println("======unlock======"+Thread.currentThread().getName());
            }
        }
    }
}