redis单机模式下和集群模式下使用分布式锁处理项目搭建负载定时器重复启动问题

一.redis单机模式下的redis分布式锁的处理方式

这是项目中没有使用redis集群，仅在一台服务器部署redis的情况下使用
这里我们使用jedis来处理
首先，为了确保分布式锁可用，我们至少要确保锁的实现同时满足以下四个条件：

1. 互斥性。在任意时刻，只有一个客户端能持有锁。
2. 不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其他客户端能加锁。
3. 具有容错性。只要大部分的Redis节点正常运行，客户端就可以加锁和解锁。
4. 解铃还须系铃人。加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给解了。

接下来进行代码实现和其他用例的分析

组件依赖

添加相关jar包，这里使用的是
jedis-2.9.0.jar
jedis-2.9.0-javadoc.jar
jedis-2.9.0-sources.jar
如果使用的是maven项目那么直接在pom文件中加入以下依赖

    redis.clients
    jedis
    2.9.0

cache.properties内配置的redis单机ip和端口

## connection
redis.host = 127.0.0.1
redis.port = 6379
redis.timeout = 2000

spring的xml文件配置

redis单机模式下加锁和解锁代码

public class RedisTool {
    /*
    * qsh
    * jedis单机模式
    * */
    private static final String LOCK_SUCCESS = "OK";
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * qsh
     * jedis单机模式
     * 尝试获取分布式锁
     * @param jedis Redis客户端
     * @param lockKey 锁
     * @param requestId 请求标识
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public static boolean tryGetDistributedLock(Jedis jedis, String lockKey, String requestId, int expireTime) {

        String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);

        if (LOCK_SUCCESS.equals(result)) {
            return true;
        }
        return false;
    }

    /**
     * qsh
     * jedis单机模式
     * 释放分布式锁
     * @param jedis Redis客户端
     * @param lockKey 锁
     * @param requestId 请求标识
     * @return 是否释放成功
     */
    public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String requestId) {

        //启动lua脚本
        String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
        Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));

        if (RELEASE_SUCCESS.equals(result)) {
            return true;
        }
        return false;

    }
 }

对于加锁代码部分解释

可以看到，我们加锁就一行代码：jedis.set(String key, String value, String nxxx, String expx, int time)，这个set()方法一共有五个形参：

• 第一个为key，我们使用key来当锁，因为key是唯一的。
• 第二个为value，我们传的是requestId，很多童鞋可能不明白，有key作为锁不就够了吗，为什么还要用到value？原因就是我们在上面讲到可靠性时，分布式锁要满足第四个条件解铃还须系铃人，通过给value赋值为requestId，我们就知道这把锁是哪个请求加的了，在解锁的时候就可以有依据。requestId可以使用UUID.randomUUID().toString()方法生成。
• 第三个为nxxx，这个参数我们填的是NX，意思是SET IF NOT
  EXIST，即当key不存在时，我们进行set操作；若key已经存在，则不做任何操作；
• 第四个为expx，这个参数我们传的是PX，意思是我们要给这个key加一个过期的设置，具体时间由第五个参数决定。
• 第五个为time，与第四个参数相呼应，代表key的过期时间。

总的来说，执行上面的set()方法就只会导致两种结果：1. 当前没有锁（key不存在），那么就进行加锁操作，并对锁设置个有效期，同时value表示加锁的客户端。2. 已有锁存在，不做任何操作。

心细的童鞋就会发现了，我们的加锁代码满足我们可靠性里描述的三个条件。首先，set()加入了NX参数，可以保证如果已有key存在，则函数不会调用成功，也就是只有一个客户端能持有锁，满足互斥性。其次，由于我们对锁设置了过期时间，即使锁的持有者后续发生崩溃而没有解锁，锁也会因为到了过期时间而自动解锁（即key被删除），不会发生死锁。最后，因为我们将value赋值为requestId，代表加锁的客户端请求标识，那么在客户端在解锁的时候就可以进行校验是否是同一个客户端。由于我们只考虑Redis单机部署的场景，所以容错性我们暂不考虑。

而解锁代码部分我们使用lua脚本，保证其原子性

可以看到，我们解锁只需要两行代码就搞定了！第一行代码，我们写了一个简单的Lua脚本代码。第二行代码，我们将Lua代码传到jedis.eval()方法里，并使参数KEYS[1]赋值为lockKey，ARGV[1]赋值为requestId。eval()方法是将Lua代码交给Redis服务端执行。

那么这段Lua代码的功能是什么呢？其实很简单，首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁）。那么为什么要使用Lua语言来实现呢？因为要确保上述操作是原子性的。关于非原子性会带来什么问题，可以阅读【解锁错误示例2】 。那么为什么执行eval()方法可以确保原子性，源于Redis的特性，下面是官网对eval命令的部分解释：

反正简单的解释，就是在eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令。

加锁错误示例1

比较常见的错误示例就是使用jedis.setnx()和jedis.expire()组合实现加锁，代码如下：

public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) {

    Long result = jedis.setnx(lockKey, requestId);
    if (result == 1) {
        // 若在这里程序突然崩溃，则无法设置过期时间，将发生死锁
        jedis.expire(lockKey, expireTime);
    }

}

setnx()方法作用就是SET IF NOT EXIST，expire()方法就是给锁加一个过期时间。乍一看好像和前面的set()方法结果一样，然而由于这是两条Redis命令，不具有原子性，如果程序在执行完setnx()之后突然崩溃，导致锁没有设置过期时间。那么将会发生死锁。网上之所以有人这样实现，是因为低版本的jedis并不支持多参数的set()方法。

加锁错误示例2

public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) {

    long expires = System.currentTimeMillis() + expireTime;
    String expiresStr = String.valueOf(expires);

    // 如果当前锁不存在，返回加锁成功
    if (jedis.setnx(lockKey, expiresStr) == 1) {
        return true;
    }

    // 如果锁存在，获取锁的过期时间
    String currentValueStr = jedis.get(lockKey);
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
        // 锁已过期，获取上一个锁的过期时间，并设置现在锁的过期时间
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
            // 考虑多线程并发的情况，只有一个线程的设置值和当前值相同，它才有权利加锁
            return true;
        }
    }
        
    // 其他情况，一律返回加锁失败
    return false;

}

这一种错误示例就比较难以发现问题，而且实现也比较复杂。实现思路：使用jedis.setnx()命令实现加锁，其中key是锁，value是锁的过期时间。执行过程：1. 通过setnx()方法尝试加锁，如果当前锁不存在，返回加锁成功。2. 如果锁已经存在则获取锁的过期时间，和当前时间比较，如果锁已经过期，则设置新的过期时间，返回加锁成功。代码如下：

那么这段代码问题在哪里？1. 由于是客户端自己生成过期时间，所以需要强制要求分布式下每个客户端的时间必须同步。 2. 当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖。3. 锁不具备拥有者标识，即任何客户端都可以解锁。

解锁错误示例1

最常见的解锁代码就是直接使用jedis.del()方法删除锁，这种不先判断锁的拥有者而直接解锁的方式，会导致任何客户端都可以随时进行解锁，即使这把锁不是它的。

public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {
        
    // 判断加锁与解锁是不是同一个客户端
    if (requestId.equals(jedis.get(lockKey))) {
        // 若在此时，这把锁突然不是这个客户端的，则会误解锁
        jedis.del(lockKey);
    }

}

解锁错误示例2

这种解锁代码乍一看也是没问题，甚至我之前也差点这样实现，与正确姿势差不多，唯一区别的是分成两条命令去执行，代码如下：

public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {
        
    // 判断加锁与解锁是不是同一个客户端
    if (requestId.equals(jedis.get(lockKey))) {
        // 若在此时，这把锁突然不是这个客户端的，则会误解锁
        jedis.del(lockKey);
    }

}

如代码注释，问题在于如果调用jedis.del()方法的时候，这把锁已经不属于当前客户端的时候会解除他人加的锁。那么是否真的有这种场景？答案是肯定的，比如客户端A加锁，一段时间之后客户端A解锁，在执行jedis.del()之前，锁突然过期了，此时客户端B尝试加锁成功，然后客户端A再执行del()方法，则将客户端B的锁给解除了。

redis单机的测试用例：

@Autowired
    public JedisPool jedisPool;

    //@Scheduled(cron = "0 0 0 * * ?")
    @Scheduled(fixedDelay = 3*60*1000)
    public void getData(){
        String uuid = UUID.randomUUID().toString();
        Jedis jedis = jedisPool.getResource();
        boolean status=false;
        try {
            status = RedisTool.tryGetDistributedLock(jedis,"xxx",uuid,3*60*1000);
            if (status){
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，获取redis锁成功！");
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，开始执行方法！");
                //这里写你的定时器逻辑
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，执行方法结束！");
            }else {
                System.out.println("当前进程:"+Thread.currentThread().getName()+"，获取redis锁失败！");
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，不执行定时任务！");
            }
        } catch (Exception e) {
            System.out.println("当前进程:"+Thread.currentThread().getName()+"，获取redis锁发生异常！立即释放redis锁");
            RedisTool.releaseDistributedLock(jedis,"xxx",uuid);
            e.printStackTrace();
        }
    }

二.redis集群模式下的redis分布式锁的处理方式

这里是项目中部署的是redis集群的情况下使用，经过单机模式的阅读肯定你已经很清楚加锁和解锁的意思了，那么下面直接上加锁和解锁的配置以及相关代码：
（ps：如果需要本机linux部署redis集群的话可以查看我上一篇文章，链接： https://blog.csdn.net/weixin_43977799/article/details/97276657
）

cache.properties内配置的redis集群ip和端口

redis.clusterHosts1=172.16.3.195
redis.clusterPorts1=7001
redis.clusterHosts2=172.16.3.195
redis.clusterPorts2=7002
redis.clusterHosts3=172.16.3.195
redis.clusterPorts3=7003
redis.clusterHosts4=172.16.3.195
redis.clusterPorts4=7004
redis.clusterHosts5=172.16.3.195
redis.clusterPorts5=7005
redis.clusterHosts6=172.16.3.195
redis.clusterPorts6=7006

spring的xml文件配置

redis集群加锁和解锁代码：

public class RedisTool {
    /*
    * qsh
    * jedis集群模式
    * */
    private static final String DISTRIBUTE_LOCK_SCRIPT_UNLOCK_VAL = "if" +
            " redis.call('get', KEYS[1]) == ARGV[1]" +
            " then" +
            " return redis.call('del', KEYS[1])" +
            " else" +
            " return 0" +
            " end";
    private static volatile String unlockSha1 = "";
    private static final Long UNLOCK_SUCCESS_CODE = 1L;
    private static final String LOCK_SUCCESS_CODE = "ok";

    /**
     * qsh
     * jedis集群模式
     * 根据loopTryTime循环重试
     * @param lockKey 锁key
     * @param lockVal 锁值，用于解锁校验
     * @param expiryTime 锁过期时间
     * @param loopTryTime 获取失败时，循环重试获取锁的时长
     * @return 是否获得锁
     */
    public static boolean tryLock(String lockKey, String lockVal, long expiryTime, long loopTryTime,JedisCluster jedisCluster){
        Long endTime = System.currentTimeMillis() + loopTryTime;
        while (System.currentTimeMillis() < endTime){
            if (tryLock(lockKey, lockVal, expiryTime,jedisCluster)){
                return true;
            }
        }
        return false;
    }

    /**
     * qsh
     * jedis集群模式
     * 根据loopTryTime循环重试
     * @param lockKey 锁key
     * @param lockVal 锁值，用于解锁校验
     * @param expiryTime 锁过期时间
     * @param retryTimes 重试次数
     * @param setpTime 每次重试间隔 mills
     * @return 是否获得锁
     */
    public static boolean tryLock(String lockKey, String lockVal, long expiryTime, int retryTimes, long setpTime,JedisCluster jedisCluster){
        while (retryTimes > 0){
            if (tryLock(lockKey, lockVal, expiryTime,jedisCluster)){
                return true;
            }
            retryTimes--;
            try {
                Thread.sleep(setpTime);
            } catch (InterruptedException e) {
                System.out.println("get distribute lock error" +e.getLocalizedMessage());
            }
        }
        return false;
    }

    /**
     * qsh
     * jedis集群模式
     * 一次尝试，快速失败。不支持重入
     * @param lockKey 锁key
     * @param lockVal 锁值，用于解锁校验
     * @param expiryTime 锁过期时间 MILLS
     * @return 是否获得锁
     */
    public static boolean tryLock(String lockKey, String lockVal, long expiryTime,JedisCluster jedisCluster){
        //相比一般的分布式锁，这里把setNx和setExpiry操作合并到一起，jedis保证原子性，避免连个命令之间出现宕机等问题
        //这里也可以我们使用lua脚本实现
        String result = jedisCluster.set(lockKey, lockVal, "NX", "PX", expiryTime);
        return LOCK_SUCCESS_CODE.equalsIgnoreCase(result);
    }

    /**
     * qsh
     * jedis集群模式
     * 释放分布式锁，释放失败最可能是业务执行时间长于lockKey过期时间，应当结合业务场景调整过期时间
     * @param lockKey 锁key
     * @param lockVal 锁值
     * @return 是否释放成功
     */
    public static boolean tryUnLock(String lockKey, String lockVal,JedisCluster jedisCluster){
        List keys = new ArrayList<>();
        keys.add(lockKey);
        List argv = new ArrayList<>();
        argv.add(lockVal);
        try {
            Object result = jedisCluster.evalsha(unlockSha1, keys, argv);
            return UNLOCK_SUCCESS_CODE.equals(result);
        }catch (JedisNoScriptException e){
            //没有脚本缓存时，重新发送缓存
            System.out.println("尝试重新发送缓存");
            storeScript(jedisCluster,lockKey);
            Object result = jedisCluster.evalsha(unlockSha1, keys, argv);
            return UNLOCK_SUCCESS_CODE.equals(result);
        }catch (Exception e){
            e.printStackTrace();
            return false;
        }
    }

    /**
     * qsh
     * jedis集群模式
     * 由于使用redis集群，因此每个节点都需要各自缓存一份脚本数据
     * @param slotKey 用来定位对应的slot的slotKey
     */
    public static void storeScript(JedisCluster jedisCluster, String slotKey){
        if (StringUtils.isEmpty(unlockSha1) || !jedisCluster.scriptExists(unlockSha1, slotKey)){
            //redis支持脚本缓存，返回哈希码，后续可以继续用来调用脚本
            unlockSha1 = jedisCluster.scriptLoad(DISTRIBUTE_LOCK_SCRIPT_UNLOCK_VAL, slotKey);
        }
    }
}

集群模式我们使用jedisCluster，方法内注解都写的很清楚，很简单就能看懂

redis集群的测试用例

    @Autowired
    public JedisCluster jedisCluster;
    
    @Scheduled(fixedDelay = 3*60*1000)
    public void getData(){
        String uuid = UUID.randomUUID().toString();
        boolean status=false;
        try {
            status = RedisTool.tryLock("xxx",uuid,2*60*1000,2*60*1000,jedisCluster);
            if (status){
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，获取redis锁成功！");
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，开始执行方法！");
                //这里写你的定时器逻辑
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，执行方法结束！");
            }else {
                System.out.println("当前进程:"+Thread.currentThread().getName()+"，获取redis锁失败！");
                System.out.println("当前程序:"+this.getClass().getName()+"，ID："+uuid+"，不执行定时任务！");
            }
        } catch (Exception e) {
            System.out.println("当前进程:"+Thread.currentThread().getName()+"，获取redis锁发生异常！立即释放redis锁");
            RedisTool.tryUnLock("xxx",uuid,jedisCluster);
            e.printStackTrace();
        }
    }

在这里我设置的是发生异常时才会进行解锁，其余情况则不进行解锁，但是当该key过期后，会自动解锁。如果定时器走完后立即进行解锁的话，有时候其他负载的方法执行可能会从redis内找不到锁，因此就会自动进行set，这样的话就重复执行了，但是如果使用thread.sleep设置成延迟解锁的话,明显会影响项目效率，因此也不推荐。