Redis分布式锁的实正确现方式

1.Maven pom.xml引入依赖

首先我们要通过Maven引入Jedis开源组件，在pom.xml文件加入下面的代码：

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

2.配置Spring Redis的XML文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- JedisPoolConfig 连接池配置信息,实例化bean,set方法注入 -->
    <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
        <property name="minIdle" value="8"></property>
        <property name="maxIdle" value="20"></property>
        <property name="maxTotal" value="100"></property>
        <!--<property name="minEvictableIdleTimeMillis" value="300000">  </property>-->
        <!--<property name="numTestsPerEvictionRun" value="-1"></property>-->
        <property name="timeBetweenEvictionRunsMillis" value="60000"></property>
        <!--连接耗尽时是否阻塞, false报异常,ture阻塞直到超时, 默认true-->
        <property name="blockWhenExhausted" value="false"></property>
    </bean>
<!--实例化bean 构造方法注入-->
    <bean id="jedisPool" class="redis.clients.jedis.JedisPool">
        <constructor-arg name="poolConfig" ref="jedisPoolConfig" />
        <constructor-arg name="host" value="${redis.hostName}" />
        <constructor-arg name="port" value="${redis.port}" type="int" />
        <constructor-arg name="timeout" value="${redis.timeout}" type="int" />
        <constructor-arg name="password" value="${redis.pass}" />
        <constructor-arg name="database" value="${redis.db}" type="int" />
    </bean>
</beans>

3.Spring 配置的xml application.xml引入Redis配置

 <import resource="classpath:context/session-redis.xml"/>

4.加锁工具类

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import redis.clients.jedis.Jedis;

import java.util.Collections;

@Component
public class RedisLockKit {

    //日志
    private static final Logger LOGGER = LoggerFactory.getLogger(RedisLockKit.class);
    //注入Jedis连接池
    @Autowired
    private JedisPool jedisPool;
    //定义最终变量
    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;

    /**
     * 尝试获取分布式锁
     * @param lockKey 锁   要锁的资源的唯一标识
     * @param requestId 请求标识    可以定位锁的唯一标识,理解为钥匙
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public boolean tryGetDistributedLock(String lockKey, String requestId, int expireTime) {
          //获得jedis
        Jedis jedis = getResource();
        try {
            //加锁   返回值
            /*
              可以看到，我们加锁就一行代码：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的过期时间。
            */
            String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
            if (LOCK_SUCCESS.equals(result)) {
                return true;
            }
        }catch (Exception e){
            LOGGER.error("error", e);
        }finally {
            //关闭连接
            returnResource(jedis);
        }
        return false;
    }

    /**
     * 释放分布式锁
     * @param lockKey 锁  和加的锁保持一致
     * @param requestId 解锁的钥匙 与添加的保持一致
     * @return 是否释放成功
     */
    public boolean releaseDistributedLock(String lockKey, String requestId) {
        //获得jedis
        Jedis jedis = 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)) {
                //解锁成功
                return true;
            }
        }finally {
            //关闭连接
            returnResource(jedis);
        }
        return false;
    }
    //或得连接
    private Jedis getResource() {
        return jedisPool.getResource();
    }
    //关闭连接
    private void returnResource(Jedis jedis) {
        if (jedis == null) {
            return;
        }
        try {
            jedis.close();
        } catch (Exception e) {
            LOGGER.error(e.getMessage(), e);
        }
    }
}

感谢Ruthless的分享文章引入地址

浪客行1213的简书

---

xhh