spring data redis结合lua脚本实现分布式锁

springboot整合spring data redis就不说了，自己去网上找吧。

redis分布式锁简单介绍

关于redis的分布式锁，主要包含三部分，setnx原子操作对key设值、对key设置过期时间、删除key。其中核心是setnx的原子性。

• setnx对key查看和设值的原子性，类似于CAS，来保证线程或者进程间获取锁的安全性。
• 过期时间，以防程序或者系统出问题，key过期自动失效，兜底释放锁。
• 删除key，业务逻辑处理完成后删除key，及时释放锁。

问题：

1. setnx和对key设置过期时间非原子，有可能第一步完成后还没来得及设置过期时间，程序异常或者服务器宕机，那么久永远无法释放锁。
2. 删除key，有肯能删除key的时候key已经失效了，因此在执行删除的时候实际删除的是其他的线程或者进程获取到的锁。

解决：

针对问题1：

• redis有原生命令 set [key] [value] nx px [milliseconds]，其可以结合setnx以及set key expire，例如[set key value nx px 3000]，即设置key，值为value，并设置过期时间为3000毫秒，整体为原子操作。

针对问题2：

• 可以设置value为一组随机数字或者字符串，解锁的时候进行比较如果和设值时候一样则删除，但理论上还是存在误删其他线程或者进程的锁的情况，因为查和删非原子操作。所以，一般来说释放锁通过lua脚本来进行。因为Redis在执行Lua脚本的过程中，其他的客户端命令都需要等待该Lua脚本执行完才能执行。

spring data redis实现分布式锁

@Slf4j
@Component
public class RedisService {

    @Autowired
    private RedisTemplate redisTemplate;

    public static final String REDIS_LOCK_KEY = "redis_lock_key_%s";

    public static final Long WAIT_TIME = 1000 * 21L;

    // 获取锁，key也放开，可供多个场景使用，value传入随机值，解锁时候传入相同值
    public boolean lock(String key, String value) {
        Long begin = System.currentTimeMillis();

        for (;;) {
            // key不存在的时候设置，并设置超时时间
            Boolean lock = redisTemplate.opsForValue().setIfAbsent(String.format(REDIS_LOCK_KEY, key), value, 10, TimeUnit.SECONDS);
            if (lock) {
                return true;
            }

            Long waitTime = System.currentTimeMillis() - begin;
            // 限制自旋获取锁时间，可根据需要调整或者搞成动态的
            if (waitTime > WAIT_TIME) {
                return false;
            }

            try {
                Thread.sleep(500);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }
    // 解锁
    public boolean unLock(String key, String value) {
        // 定义lua脚本
        String script =
                "if redis.call('get',KEYS[1]) == ARGV[1] then" +
                        "   return redis.call('del',KEYS[1]) " +
                        "else" +
                        "   return 0 " +
                        "end";
        
        RedisScript redisScript = new DefaultRedisScript<>(script, Long.class);
        // 执行Lua脚本，传入脚本以及对应参数
        Object result = redisTemplate.execute(redisScript, Collections.singletonList(String.format(REDIS_LOCK_KEY, key)), value);
        if ("1".equals(result.toString())) {
            return true;
        }
        return false;
    }

}

使用

    public void methodName(Param1 p1, Param2 p2) {
        String value = 随机数或者字符串;
        final String redisLockKey = 业务属性字符串;
        try {
            boolean lock = redisService.lock(redisLockKey, value);
            if (lock) {
                // 业务逻辑
                // ******
            } else {
                throw new ClientException(HttpStatus.BAD_REQUEST.value(), "请重试");
            }
        } finally {
            redisService.unLock(redisLockKey, value);
        }
    }

个人笔记，欢迎探讨。