Java封装Redis分布式锁

前言

记得刚参加工作的时候，就想写写博客，把平时学习的心得感悟都记录一下，算是做笔记了，可是坚持了没几天就放弃了。倒也不是放弃，只是记在了有道笔记里。现在觉得还是社区环境更适合成长，不仅可以看别人的文章学习，自己写的文章也许能帮到别人。而且自己学习某个知识点时候可能没悟到点上，这时候得到他人得指点就显得尤为重要了。希望自己能坚持下去，乌拉！

学习缘由

最近在做供应商采购业务，为了解决多并发情况下操作同一个供应商账户数据时额度不会多加或多减，加入了Redis分布式锁。

学习方法

先是在知乎上搜了几篇文章看了看，然后在csdn上搜了几篇文章看了看，然后就是上手操作了。平时遇到问题的解决方法基本就是这样，可能有小朋友会举手提问了，平时遇上难题，不和同事交流吗？也交流，不过咱平时并不谦虚，一般不问别人都是自己解决。平时开发也遇不到啥解决不了的问题，如果有，就多在知乎、CSDN搜点博客看看，基本都能解决。对对对，B站上的学习视频也不少！

实现方式

分布式锁一般有三种实现方式：

1. 数据库乐观锁；
2. 基于Redis的分布式锁；
3. 基于ZooKeeper的分布式锁。

本篇博客将介绍第二种方式，基于Redis实现分布式锁。分别使用jedis和redisson这俩种Redis的客户端框架来演示。

可靠性

首先，为了确保分布式锁可用，我们至少要确保锁的实现同时满足以下四个条件：

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

Jedis解决方案

maven依赖

<dependency>
	<groupId>redis.clients</groupId>
	<artifactId>jedis</artifactId>
	<version>2.8.1</version>
</dependency>

工具类

• redis2.8版本之后引入了指令 set key value [EX seconds] [PX milliseconds] [NX|XX] ,该指令可以同时执行 setnx 和 expire ，于是解决了死锁问题；
• EX seconds: 设定过期时间，单位为秒
• PX milliseconds: 设定过期时间，单位为毫秒
• NX: key不存在时设置值
• XX: key存在时设置值
• set(String lockKey, String requestId, String NX, String PX, int expireTime)

/**
 * Redis分布式锁
 * FJH
 * 2020年4月16日
 */
public class RedisDistributedLockUtil {
    private static final Logger LOGGER = LoggerFactory.getLogger(RedisDistributedLockUtil.class);
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    private static final String LOCK_SUCCESS = "OK";
    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 尝试获取分布式锁
     * FJH
     * 2020年4月16日
     *
     * @param lockKey    锁
     * @param requestId  请求标识
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public static void tryGetDistributedLock(JedisPool jedisPool, String lockKey, String requestId, int expireTime) throws Exception {
        Jedis jedis = jedisPool.getResource();
        try {
            /*
             *  redis2.8版本之后引入了指令 set key value [EX seconds] [PX milliseconds] [NX|XX] ,该指令可以同时执行 setnx 和 expire ，于是解决了死锁问题；
             *  EX seconds: 设定过期时间，单位为秒
			 *  PX milliseconds: 设定过期时间，单位为毫秒
			 *  NX: key不存在时设置值
			 *  XX: key存在时设置值
			 * 
             *  set(String lockKey, String requestId, String NX, String PX, int expireTime)
             *  lockKey     锁键
             *  requestId   锁值(发起请求的客户端的标识)---互斥性。在任意时刻，只有一个客户端能持有锁
             *  NX          (set if not exist)如果该key没有值则设值为requestId,如果有值则不操作
             *  PX          (set with expire time)设置过期时间
             *  expireTime  过期时间(ms)
             */
            for (int i = 0; i < 5; i++) { //最多尝试5次
                Thread.sleep(3 * 1000); // 设置间隔时间 3 秒
                LOGGER.info("第" + (i+1) + "次尝试获取Redis分布式锁");
                String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
                if (LOCK_SUCCESS.equals(result)) {
                    LOGGER.info("获取Redis分布式锁成功");
                    break;
                }
                if (i == 4 && !LOCK_SUCCESS.equals(result)) {
                    throw new Exception("获取Redis分布式锁超时，请重试");
                }
            }
        } catch (Exception e) {
            LOGGER.error(e.getMessage(), e);
            throw new Exception("获取Redis分布式锁异常", e);
        } finally {
            jedis.close();
        }
    }

    /**
     * 释放分布式锁
     * FJH
     * 2020年4月17日
     *
     * @param jedisPool jedis链接池
     * @param lockKey   锁
     * @param requestId 请求标识
     * @return 是否释放成功
     */
    public static void releaseDistributedLock(JedisPool jedisPool, String lockKey, String requestId) throws Exception {
        Jedis jedis = jedisPool.getResource();
        try {
            // 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)) {
                LOGGER.info("释放Redis分布式锁成功");
            }
        } catch (Exception e) {
            LOGGER.error(e.getMessage(), e);
            throw new Exception("释放Redis分布式锁异常", e);
        } finally {
            jedis.close();
        }
    }

}

业务代码

// 获取分布式锁
String lockKey = "9527"; // 锁键(该条被修改数据的唯一标识)
String requestId = UUID.randomUUID().toString(); // 锁值(发起访问的客户端的标识)
int expireTime = 20; // 过期时间
RedisDistributedLockUtil.tryGetDistributedLock(jedisPool, lockKey, requestId, expireTime);
/******* 一大坨代码 *******/
// 释放锁
RedisDistributedLockUtil.releaseDistributedLock(jedisPool, lockKey, requestId);

---

参考文件

• Redis 分布式锁的正确实现方式(Java 版)
• Redis、memcache、Zookeeper实现分布式锁
• redis分布式锁过期时间到了，但业务没执行完怎么办？
• 为什么你不会redis分布式锁？因为你没看到这篇文章 这一篇厉害推荐看看

END [2020年4月17日23:36:43]
奥利给