Redis分布式锁最佳实践

1.1 分布式锁的注意事项

1. 互斥性：在任意时刻，只有一个客户端能持有同一把锁；
2. 同一性：加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给释放了。
3. 可重入性：即使有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其他客户端能成功加锁（锁到期会自动释放）。

1.2 实现原理

1.3 代码实现

import redis.clients.jedis.Jedis;

import java.util.Collections;

/**
 * Redis分布式锁：互斥性、同一性、可重入性
 * 推荐写法
 * SET key value [EX seconds] [PX milliseconds] [NX|XX]
 *  EX second ：设置键的过期时间为 second 秒。
 *  PX millisecond ：设置键的过期时间为 millisecond 毫秒。
 *  NX ：只在键不存在时，才对键进行设置操作。
 *  XX ：只在键已经存在时，才对键进行设置操作。
 *
 * @author liangfeihu
 * @since 2019/6/11
 */
public class RedisLockV2 {
    private static final String LOCK_SUCCESS = "OK";
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "EX";

    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 使用redis的set命令实现获取分布式锁
     * 命令 SET key val NX EX max-lock-time 是一种在 Redis 中实现锁的简单方法。
     * 客户端执行以上的命令：
     * 如果服务器返回 OK  ，那么这个客户端获得锁。
     * 如果服务器返回 nil ，那么客户端获取锁失败，可以在稍后再重试。
     * 设置的过期时间到达之后，锁将自动释放。
     *
     * @param lockKey    可以就是锁
     * @param requestId  请求ID，保证同一性
     * @param expireTime 过期时间，避免死锁(单位秒)
     * @return
     */
    public static boolean getLock(Jedis jedis, String lockKey, String requestId, int expireTime) {
        //NX:保证互斥性
        String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
        if (LOCK_SUCCESS.equals(result)) {
            return true;
        }
        return false;
    }


    /**
     * 释放分布式锁
     * 不使用固定的字符串作为键的值，而是设置一个不可猜测（non-guessable）的长随机字符串，作为口令串（token）。
     * 不使用 DEL 命令来释放锁，而是发送一个 Lua 脚本，这个脚本只在客户端传入的值和键的口令串相匹配时，才对键进行删除。
     *
     * @param lockKey
     * @param requestId
     */
    public static boolean releaseLock(Jedis jedis, String lockKey, String requestId) {
        // 可以防止持有过期锁的客户端误删现有锁的情况出现。
        String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
        // 使用Lua脚本保证原子性
        Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));

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

}