setnx分布式锁原理RedisTemplate实现setnx分布式锁

基于缓存（Redis等）实现分布式锁
 
 
1. 使用命令介绍：
（1）SETNX
SETNX key val：当且仅当key不存在时，set一个key为val的字符串，返回1；若key存在，则什么都不做，返回0。
（2）expire
expire key timeout：为key设置一个超时时间，单位为second，超过这个时间锁会自动释放，避免死锁。
（3）delete
delete key：删除key
 
在使用Redis实现分布式锁的时候，主要就会使用到这三个命令。
 
 
 
2. 实现思想：
（1）获取锁的时候，使用setnx加锁，并使用expire命令为锁添加一个超时时间，超过该时间则自动释放锁，锁的value值为一个随机生成的UUID，通过此在释放锁的时候进行判断。
（2）获取锁的时候还设置一个获取的超时时间，若超过这个时间则放弃获取锁。
（3）释放锁的时候，通过UUID判断是不是该锁，若是该锁，则执行delete进行锁释放。
 
/**
  2  * 分布式锁的简单实现代码  4  */
  5 public class DistributedLock {
  6 
  7     private final JedisPool jedisPool;
  8 
  9     public DistributedLock(JedisPool jedisPool) {
 10         this.jedisPool = jedisPool;
 11     }
 12 
 13     /**
 14      * 加锁
 15      * @param lockName       锁的key
 16      * @param acquireTimeout 获取超时时间
 17      * @param timeout        锁的超时时间
 18      * @return 锁标识
 19      */
 20     public String lockWithTimeout(String lockName, long acquireTimeout, long timeout) {
 21         Jedis conn = null;
 22         String retIdentifier = null;
 23         try {
 24             // 获取连接
 25             conn = jedisPool.getResource();
 26             // 随机生成一个value
 27             String identifier = UUID.randomUUID().toString();
 28             // 锁名，即key值
 29             String lockKey = "lock:" + lockName;
 30             // 超时时间，上锁后超过此时间则自动释放锁
 31             int lockExpire = (int) (timeout / 1000);
 32 
 33             // 获取锁的超时时间，超过这个时间则放弃获取锁
 34             long end = System.currentTimeMillis() + acquireTimeout;
 35             while (System.currentTimeMillis() < end) {
 36                 if (conn.setnx(lockKey, identifier) == 1) {
 37                     conn.expire(lockKey, lockExpire);
 38                     // 返回value值，用于释放锁时间确认
 39                     retIdentifier = identifier;
 40                     return retIdentifier;
 41                 }
 42                 // 返回-1代表key没有设置超时时间，为key设置一个超时时间
 43                 if (conn.ttl(lockKey) == -1) {
 44                     conn.expire(lockKey, lockExpire);
 45                 }
 46 
 47                 try {
 48                     Thread.sleep(10);
 49                 } catch (InterruptedException e) {
 50                     Thread.currentThread().interrupt();
 51                 }
 52             }
 53         } catch (JedisException e) {
 54             e.printStackTrace();
 55         } finally {
 56             if (conn != null) {
 57                 conn.close();
 58             }
 59         }
 60         return retIdentifier;
 61     }
 62 
 63     /**
 64      * 释放锁
 65      * @param lockName   锁的key
 66      * @param identifier 释放锁的标识
 67      * @return
 68      */
 69     public boolean releaseLock(String lockName, String identifier) {
 70         Jedis conn = null;
 71         String lockKey = "lock:" + lockName;
 72         boolean retFlag = false;
 73         try {
 74             conn = jedisPool.getResource();
 75             while (true) {
 76                 // 监视lock，准备开始事务
 77                 conn.watch(lockKey);
 78                 // 通过前面返回的value值判断是不是该锁，若是该锁，则删除，释放锁
 79                 if (identifier.equals(conn.get(lockKey))) {
 80                     Transaction transaction = conn.multi();
 81                     transaction.del(lockKey);
 82                     List<Object> results = transaction.exec();
 83                     if (results == null) {
 84                         continue;
 85                     }
 86                     retFlag = true;
 87                 }
 88                 conn.unwatch();
 89                 break;
 90             }
 91         } catch (JedisException e) {
 92             e.printStackTrace();
 93         } finally {
 94             if (conn != null) {
 95                 conn.close();
 96             }
 97         }
 98         return retFlag;
 99     }
100 }

package com.prison.common.util;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
 
import java.util.Objects;
 
/**
 * @ClassName RedisLockUtil
 * @Description 使用redis做锁
 * @Author WangJing
 * @Date 2020年6月8日
 * @Version V1.1.0
 */
@Component
public class RedisLockUtil {
 
    @Autowired
    RedisTemplate<String, Object> redisTemplate;
    /**
     * 任务锁前缀
     */
    public static final String TASK_LOCK_PREFIX = "t_l_prefix";
    /**
     * 任务锁过期时间 2000毫秒
     */
    public static final Integer TASK_LOCK_EXPIRE = 2000;
 
    /**
     * 获取锁，true 则得到锁，false 已被锁定
     * @param lockName       锁名称
     * @param lockExoire     锁时间
     * @return
     */
    public Boolean getLock(String lockName, Integer lockExoire) {
        return (Boolean) redisTemplate.execute((RedisCallback<?>) connection -> {
            // 获取时间毫秒值
            long expireAt = System.currentTimeMillis() + lockExoire + 1;
            // 获取锁
            Boolean acquire = connection.setNX(lockName.getBytes(), String.valueOf(expireAt).getBytes());
            if (acquire) {
                return true;
            } else {
                byte[] bytes = connection.get(lockName.getBytes());
                // 非空判断
                if (Objects.nonNull(bytes) && bytes.length > 0) {
                    long expireTime = Long.parseLong(new String(bytes));
                    // 如果锁已经过期
                    if (expireTime < System.currentTimeMillis()) {
                        // 重新加锁，防止死锁
                        byte[] set = connection.getSet(lockName.getBytes(),
                                String.valueOf(System.currentTimeMillis() + lockExoire + 1).getBytes());
                        return Long.parseLong(new String(set)) < System.currentTimeMillis();
                    }
                }
            }
            return false;
        });
    }
 
    /**
     * 删除锁
     * @param lockName
     */
    public void delLock(String lockName) {
        redisTemplate.delete(lockName);
    }
 
    /**
     * 获取锁Key
     * @param prefix    前缀
     * @param name      名称
     * @return
     */
    public static String getFullKey(String prefix, String name) {
        return prefix + "_" + name;
    }
 
}