使用Redisson作为分布式锁

客官°小女子只卖身不卖艺 2022-11-07 14:30 151阅读 0赞

### 概述 ###

*  1  
    Redisson 是 redis 的一个Java客户端，但是最为人熟知的是它的分布式锁的功能。所以分布式锁就不要自己实现一套了，人家帮你实现了并且考虑得比你周全得多代码健壮得多。
 *  2  
    Redisson 除了所熟知的分布式锁的功能，其实也跟其他的Redis的Java客户端一样，有操作redis的功能，例如
    
        // string类型的，key是abc，值是vvv
        RBucket<String> s = redissonClient.getBucket("abc");
        s.set("vvv");
    
    它提供的Java API看起来是有点奇怪，其实更加面向对象。
 *  3  
    总结起来 Redisson 其实跟 Jedis、RedisTemplate(spring data redis) 是一样的，是一个Java客户端，提供了 Java可用的API用来操作 redis，只是它最为人所熟知的是它的分布式锁的功能。**再说一遍**，别人实现了分布式锁啦，你就别自己写啦。
    
    > 为什么不自己写分布式锁？你写的分布式锁可能无法实现 “A线程持有锁的时候B线程阻塞在那里等待直至获得”，你写的可能就是 “B线程尝试一次是否能获取”。Redisson 实现比较复杂，实现了java.util.concurrent.locks.Lock(JUC包的，跟你用的ReentrantLock是一样的)

### 使用 ###

*  引入需要的包
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <version>2.3.9.RELEASE</version>
        </dependency>
        
        
        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson-spring-boot-starter</artifactId>
            <version>3.11.4</version>
        </dependency>
 *  配置
    
        # Redis数据库索引（默认为0）
        spring.redis.database=15
        spring.redis.host=47.103.66.213
        spring.redis.port=6379
        spring.redis.password=xxxx
 *  代码
    
        @Autowired
        private StringRedisTemplate stringRedisTemplate;
        
        @Autowired
        private RedissonClient redissonClient;
        
        @GetMapping("/submitOrder")
        public String submitOrder() { 
        
            RLock lock = redissonClient.getLock(product);
        
            try { 
                lock.lock();//阻塞
                // boolean b = lock.tryLock();//非阻塞
                int stock = Integer.parseInt(stringRedisTemplate.opsForValue().get("stock"));
                if (stock > 0) { 
                    //下单
                    stock -= 1;
                    stringRedisTemplate.opsForValue().set("stock", String.valueOf(stock));
                    System.out.println("扣减成功，库存stock：" + stock);
        
                } else { 
                    //没库存
                    System.out.println("扣减失败，库存不足");
                }
            } finally { 
                if (lock.isHeldByCurrentThread()) { 
                    lock.unlock();//释放锁
                }
            }
            return "end";
        }

### 经验总结 ###

*  分布式锁使用的key跟已经存在于redis的key同名，会怎么样？**同名很严重，千万别用简单名字作为key**
    
     *  如果已经存在的key不是hash类型的，会抛出类型错误的异常(分布式锁是hash类型的)
     *  如果已经存在的key是hash类型，则会阻塞在那里(redisson以为有别的线程获取了锁！)
 *  如果一个程序lock.lock() 得到锁(会在redis写入一个key)，如果此时程序挂掉，会怎么样？这个key一直存在于redis吗？
    
    不会的，虽然调用lock()没有设定租期，但是一定时间之后这个key会自己从redis消失。
    
    我猜测应该是有看门狗的实现，即lock()写入的key其实是会超时的。正常情况下，程序不释放锁则会一直重新延长key的有效期。如果程序挂了就不会再续期了，所以到期后key自动消失。PS：redisson实现的实现考虑如此周全，你还要自己写一个分布式锁吗？
    
    [官方关于看门狗的说明][Link 1] 里面有一段话：
    
    ![在这里插入图片描述][20210319154235879.png]
 *  lock()：会阻塞，一直等到能获得锁。无返回值
 *  lock(long leaseTime, TimeUnit timeUnit)：会阻塞，设定租期，租期到后自动释放锁。无返回值
 *  tryLock()：不阻塞，只检查一次，即只检查当前时刻能否获得锁。返回boolean
 *  tryLock(long time, TimeUnit unit)：在设定的time(等待时间)内阻塞，如果能获得锁则立即返回true，超过等待时间仍不能获得则返回false
 *  tryLock(long waitTime, long leaseTime, TimeUnit unit)：设定了等待时间以及租期
 *  unlock()：释放锁，如果已经是释放状态则会抛出异常(例如其他线程已经释放，或者租期到释放)，只能是持有锁的线程进行释放否则抛出异常。
 *  isLock()：判断锁是否被占用。注意：**不是**判断锁是否被当前线程占用，锁被其他线程占用的情况也会返回true
 *  isHeldByCurrentThread()：判断锁是否被当前线程占用。这个**才是**判断锁是否被当前线程占用(持有)
 *  其他注意：unlock() 之前最好判断是否锁被占用，才进行解锁
    
        if (lock.isHeldByCurrentThread()) { 
            lock.unlock();
        }
        
        注意不要这么用，因为所不被当前线程持有 isLocked()也返回true，但是unlock()必须是当前线程持有才不会抛出异常
        if (lock.isLocked()) { 
            lock.unlock();
        }
 *  **总结**：
    
    看上面的例子，可以看到 `stringRedisTemplate` 和 `redissonClient` 是混着用的，确实可以混着用，毕竟很多人不熟悉 Redisson 的API，仅仅将 Redisson 作为分布式锁的工具，操作 redis 依然保持不变是没问题的。
    
    但是**注意**一下下面的混用会出错的
    
        // 混用会报错
        stringRedisTemplate.opsForValue().set("t3", "f_v", 100, TimeUnit.SECONDS);
        RBucket<String> s = redissonClient.getBucket("t3");
        String value = s.get();

[Link 1]: https://github.com/redisson/redisson/wiki/8.-%E5%88%86%E5%B8%83%E5%BC%8F%E9%94%81%E5%92%8C%E5%90%8C%E6%AD%A5%E5%99%A8
[20210319154235879.png]: /images/20221023/8771a36519cc4627bd9df76ebc6d3a06.png