在Java中,关于锁我想大家都很熟悉。在并发编程中,我们通过锁,来避免由于竞争而造成的数据不一致问题。通常,我们以synchronized 、Lock来使用它。
但是Java中的锁,只能保证在同一个JVM进程内中执行。如果在分布式集群环境下呢?
1. 什么是分布式锁
分布式锁是控制分布式系统或不同系统之家共同访问共享资源的一种实现。
如果不同的系统或同一个系统的不同主机之间共享了某个资源时,往往通过互斥来防止彼此干扰。
2. 分布式锁设计目的
可以保证在分布式部署的应用集群中,同一个方法在同一操作只能被一台机器上的线程访问。
3. 设计要求
- 互斥性。在任意时刻,只有一个客户端能持有锁。
- 不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动解锁,也能保证后续其他客户端能加锁。
- 具有容错性。只要大部分的Redis节点正常运行,客户端就可以加锁和解锁。
- 解铃还须系铃人。加锁和解锁必须是同一个客户端,客户端自己不能把别人加的锁给解了。
4. 分布式锁实现方案
- 获取锁的时候,使用setnx(SETNX key val:当且仅当key不存在时,set一个键为key,值为val的字符串,返回1;弱key存在,则无法修改值,并返回0)加锁,锁的value值为当且服务器内网IP编号拼接任务标识,在释放锁的时候进行判断,并使用expire命令为锁添加一个超时时间,超过时间自动释放锁。
- 获取锁的时候使用setnx,如果返回0,则该锁正在被别人使用,返回1则成功释放锁,还设置一个超时时间
- 释放的时候,判断是不是该锁(即value为当前服务器内网IP编号拼接任务标识),若是该所,则执行delete进行释放
备注:此方案不是最优方案,因为如果在setnx之后执行expire之前进程意外crash或者要重启维护了,那这个锁就永远得不到释放了,解决方案慢慢往下看,下面会讲到解决方案
5. 业务逻辑代码
我们开启一个定时任务,每10秒执行一次,启动两个项目端口分别为8081和8082来模拟分布式的场景,
@Service
public class RedisLock {
@Autowired
private RedisUtil redisUtil;
private static String LOCK_PREFIX = "prefix_";
@Scheduled(cron = "0/10 * * * * *")
public void lock(){
String lock_key = LOCK_PREFIX + "LockNxExJob";
String uuid = UUID.randomUUID().toString();
try {
Long aLong = redisUtil.setnx(lock_key, getHostIp() + ":" + uuid);
if (aLong.intValue() == 1) {
// 获取锁成功,设置过期时间
redisUtil.expire(lock_key, 3600);
// 处理业务逻辑
System.out.println("error job" + System.currentTimeMillis());
Thread.sleep(5000);
} else {
// 获取锁失败, 查看占有锁的服务器IP
String value = redisUtil.get(lock_key, 0);
System.out.println("get lock fail, lock belong to:{}" +value);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
// 任务执行完,删除锁
redisUtil.del(0, lock_key);
}
}
public String getHostIp() throws UnknownHostException {
InetAddress addr = InetAddress.getLocalHost();
return addr.getHostAddress();
}
}
抢到锁成功时打印error job + 时间戳
抢到锁失败时打印get lock fail, lock belong to:{} + 抢到锁的服务的IP+生成的UUID
6. 解决setnx遗留的问题
上边讲到如果在setnx之后执行expire之前进程意外crash或者要重启维护了,那这个锁就永远得不到释放了,针对这个问题有两种解决方案第一种是使用Lua脚本一次性执行setnx和expire命令来解决这个问题,第二种是redis2.6之后的版本支持setnx和expire连用,命令是jedis.set(String key, String value, String nxxx, String expx, int time)
我们这里讲第二种方式
String result = jedis.set(key, value, nxxx, expx, time);
可以看到,我们加锁就一行代码: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. 已有锁存在,不做任何操作。
7. 解决释放锁遗留的问题
在上边代码中是直接使用del命令删除的key,这种不先判断锁的拥有者而直接解锁的方式,会导致任何客户端都可以随时进行解锁,即使这把锁不是它的。
7.1 错误示例1
jedis.del(localKey)
7.2 错误示例2
这种解锁代码乍一看也是没问题,甚至我之前也差点这样实现,与正确姿势差不多,唯一区别的是分成两条命令去执行,代码如下:
// 判断加锁与解锁是不是同一个客户端
if (value.equals(jedis.get(lockKey))) {
// 若在此时,这把锁突然不是这个客户端的,则会误解锁
jedis.del(lockKey);
}
如代码注释,问题在于如果调用jedis.del()方法的时候,这把锁已经不属于当前客户端的时候会解除他人加的锁。那么是否真的有这种场景?答案是肯定的,比如客户端A加锁,一段时间之后客户端A解锁,在执行jedis.del()之前,锁突然过期了,此时客户端B尝试加锁成功,然后客户端A再执行del()方法,则将客户端B的锁给解除了。
7.3 解决方案
String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
# 成功返回1 失败返回0
Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(value));
可以看到,我们解锁只需要两行代码就搞定了!第一行代码,我们写了一个简单的Lua脚本代码。第二行代码,我们将Lua代码传到jedis.eval()方法里,并使参数KEYS[1]赋值为lockKey,ARGV[1]赋值为value。eval()方法是将Lua代码交给Redis服务端执行。
那么这段Lua代码的功能是什么呢?其实很简单,首先获取锁对应的value值,检查是否与value相等,如果相等则删除锁(解锁)。
那么为什么执行eval()方法可以确保原子性,源于Redis的特性,下面是官网对eval命令的部分解释:
简单来说,就是在eval命令执行Lua代码的时候,Lua代码将被当成一个命令去执行,并且直到eval命令执行完成,Redis才会执行其他命令。
8 总结
8.1 什么是分布式锁
分布式锁就是同一资源在同一时间只能被同一个应用占用
为了确保分布式锁可用,我们至少要确保锁的实现同时满足以下三个条件:
- 互斥性。在任意时刻,只有一个客户端能持有锁
- 不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动解锁,也能保证后续其他客户端能加锁
- 解锁还需系铃人。加锁和解锁必须是同一个客户端,客户端自己不能把别人加的锁给解了。
8.2 怎么实现分布式锁
实现分布式锁有两种
- 采用lua脚本操作分布式锁
- 采用setnx和expire命令连用的方式实现分布式锁
8.3 解锁需要注意什么
解铃还须系铃人。加锁和解锁必须是同一个客户端,客户端不能把别人加的锁给解了