Redis Template实现分布式锁的实例代码

前言

分布式锁一般有三种实现方式：1. 数据库乐观锁；2. 基于Redis的分布式锁；3. 基于ZooKeeper的分布式锁。本篇博客将介绍第二种方式，基于Redis实现分布式锁。虽然网上已经有各种介绍Redis分布式锁实现的博客，然而他们的实现却有着各种各样的问题，为了避免误人子弟，本篇博客将详细介绍如何正确地实现Redis分布式锁。

可靠性

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

使用Redis的SETNX命令获取分布式锁的步骤：

•C1和C2线程同时检查时间戳获取锁，执行SETNX命令并都返回0，此时锁仍被C3持有，并且C3已经崩溃
•C1 DEL锁
•C1 使用SETNX命令获取锁，并且成功
•C2 DEL锁
•C2 使用SETNX命令获取锁，并且成功
•ERROR : 由于竞态条件，C1和C2都获取到了锁

幸运的是，以下面的步骤完全可以避免这种情况发生，看看C4线程如何操作

•C4使用SETNX命令获取锁
•C3已经崩溃但是仍然持有锁，所以Redis返回0给C4
•C4使用GET命令获取锁并检查锁是否已经过期，如果没有过期，则继续等待一段时间并重新重试
•如果锁已经过期，C4尝试 GETSET lock.foo <current Unix timestamp + lock timeout + 1>
•利用GETSET语法，C4可以检查旧时间是否仍然是过期时间，如果是，则获取锁
•如果另一个客户端C5率先获取到锁，C4执行GETSET命令后将返回非过期时间，然后C4继续从头开始重新尝试获取锁。此操作C4将延长一点C5获取到的锁的过期时间，不过这不是什么大问题。

接下来我们用代码的形式展现:

package com.shuige.components.cache.redis;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Component;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
/**
 * Description: 通用Redis帮助类
 * User: zhouzhou
 * Date: 2018-09-05
 * Time: 15:39
 */
@Component
public class CommonRedisHelper {
  public static final String LOCK_PREFIX = "redis_lock";
  public static final int LOCK_EXPIRE = 300; // ms
  @Autowired
  RedisTemplate redisTemplate;
  /**
   * 最终加强分布式锁
   *
   * @param key key值
   * @return 是否获取到
   */
  public boolean lock(String key){
    String lock = LOCK_PREFIX + key;
    // 利用lambda表达式
    return (Boolean) redisTemplate.execute((RedisCallback) connection -> {
      long expireAt = System.currentTimeMillis() + LOCK_EXPIRE + 1;
      Boolean acquire = connection.setNX(lock.getBytes(), String.valueOf(expireAt).getBytes());
      if (acquire) {
        return true;
      } else {
        byte[] value = connection.get(lock.getBytes());
        if (Objects.nonNull(value) && value.length > 0) {
          long expireTime = Long.parseLong(new String(value));
          if (expireTime < System.currentTimeMillis()) {
            // 如果锁已经过期
            byte[] oldValue = connection.getSet(lock.getBytes(), String.valueOf(System.currentTimeMillis() + LOCK_EXPIRE + 1).getBytes());
            // 防止死锁
            return Long.parseLong(new String(oldValue)) < System.currentTimeMillis();
          }
        }
      }
      return false;
    });
  }
  /**
   * 删除锁
   *
   * @param key
   */
  public void delete(String key) {
    redisTemplate.delete(key);
  }
}

如何使用呢,导入工具类后:

boolean lock = redisHelper.lock(key);
    if (lock) {
      // 执行逻辑操作
      redisHelper.delete(key);
    } else {
      // 设置失败次数计数器, 当到达5次时, 返回失败
      int failCount = 1;
      while(failCount <= 5){
        // 等待100ms重试
        try {
          Thread.sleep(100l);
        } catch (InterruptedException e) {
          e.printStackTrace();
        }
        if (redisHelper.lock(key)){
          // 执行逻辑操作
          redisHelper.delete(key);
        }else{
          failCount ++;
        }
      }
      throw new RuntimeException("现在创建的人太多了, 请稍等再试");
    }

加锁成功执行完逻辑后, 必须解锁, 否则只能靠锁机制来解锁了不建议这么做

总结

以上所述是小编给大家介绍的Redis Template实现分布式锁的实例代码，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对菜鸟教程(cainiaojc.com)网站的支持！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：notice#cainiaojc.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。