使用场景

「分布式锁」是用来解决分布式应用中“并发冲突”的一种常用手段，比如：用户提交某种证件进行认证，对于同一个用户，如果有并发请求同时到达，那么只能处理一个请求。

业务流程

redis 分布式锁 (2).jpg

正确使用「redis分布式锁」

1. 互斥性。在同一时刻，只有一个客户端能持有锁。
2. 不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其他客户端能加锁。
3. 解铃还须系铃人。加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给解了。

• 获取分布式锁 & 释放分布式锁

    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    private static final String REDIS_SET_SUCCESS = "OK";
    private static final Long REDIS_EVAL_SUCCESS = 1L;
    @Autowired
    private RedisCommand redisCommand;
    /**
     * 获取分布式锁
     *
     * @param idempotentId 幂等id
     * @param expireTime   失效时间
     * @return true:成功 ; false:失败
     */
    public boolean getLock(String idempotentId, long expireTime) {
        // 构造KEY
        String key = buildKey(idempotentId);
        String value;
        try {
            /**
             * key : redis唯一key
             * value : 分布式锁要满足第三个条件解铃还须系铃人
             * nxxx : 传入 NX[SET_IF_NOT_EXIST]，即当key不存在时，我们进行set操作；若key已经存在，则不做任何操作；
             * expx : 传入 PX[SET_WITH_EXPIRE_TIME]，即给key加一个过期的设置，避免死锁
             * time : 具体的失效时间，单位:毫秒数
             */
            value = redisCommand.set(key, idempotentId,
                    SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
        } catch (Exception e) {
            log.error("getLock exception idempotentId[{}]", idempotentId, e);
            return false;
        }
        return REDIS_SET_SUCCESS.equalsIgnoreCase(value);
    }
    /**
     * 释放分布式锁
     *
     * @param idempotentId 幂等id
     * @return 是否释放成功
     */
    public boolean releaseDistributedLock(String idempotentId) {
        String lockKey = buildKey(idempotentId);
        String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
        Object result = redisCommand.eval(script, Collections.singletonList(lockKey), Collections.singletonList(idempotentId));
        return REDIS_EVAL_SUCCESS.equals(result)
    }
    private String buildKey(String idempotentId) {
        return new StringBuilder("redisKeyPrefix:").append(":").append(idempotentId).toString();
    }

释放锁为什么要使用lua脚本

因为要确保释放锁的操作是原子性的，eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令。

将Lua代码传到redisCommand.eval()方法里，并使参数KEYS[1]赋值为lockKey，ARGV[1]赋值为idempotentId。
eval()方法是将Lua代码交给Redis服务端执行。
首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁）
如果获取锁失败，只能等超时自动释放

补充说明

「获取分布式锁」都是通用功能，可以考虑使用注解（annotation）进行抽象，实现与业务代码的解耦