Springboot集成Redis实现分布式锁

集成Redis

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

配置RedisTemplate

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        // 设置Key使用String序列化
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        return redisTemplate;
    }
}

分布式锁

代码实现

public class RedisSimpleLock implements AutoCloseable {
    public static final Logger log = LoggerFactory.getLogger(RedisSimpleLock.class);
    /**
     * 锁key后缀
     */
    public static final String SUFFIX = "~lock";

    private final RedisTemplate<String, Object> redisTemplate;
    /**
     * 锁key
     */
    private final String key;
    /**
     * 超时时间
     */
    private final long timeout;
    /**
     * 时间单位
     */
    private final TimeUnit unit;
    /**
     * 锁状态
     */
    private boolean lock;
    /**
     * 是否自动释放
     */
    private boolean autoUnlock;

    public RedisSimpleLock(RedisTemplate<String, Object> redisTemplate, String key, long timeout, TimeUnit unit) {
        this(redisTemplate, key, timeout, unit, true);
    }

    public RedisSimpleLock(RedisTemplate<String, Object> redisTemplate, String key, long timeout, TimeUnit unit, boolean autoUnlock) {
        this.redisTemplate = redisTemplate;
        this.key = key + SUFFIX;
        this.timeout = timeout;
        this.unit = unit;
        this.autoUnlock = autoUnlock;
    }


    public RedisSimpleLock(RedisTemplate<Object, Object> redisTemplate, String key, long timeout, TimeUnit unit, boolean autoUnlock) {
        this.redisTemplate = redisTemplate;
        this.key = key + SUFFIX;
        this.timeout = timeout;
        this.unit = unit;
        this.autoUnlock = autoUnlock;
    }


    public boolean lock() throws Exception {
        // 利用key过期时间来完成超时自动解锁
        Boolean res = redisTemplate.opsForValue().setIfAbsent(key, "lock", timeout, unit);
        if (res == null) {
            log.info("Redis lock key:{},timeout:{},timeUnit:{} ==> Result:[{}]", key, timeout, unit, "error");
            throw new Exception();
        } else {
            log.info("Redis lock key:{},timeout:{},timeUnit:{} ==> Result:[{}]", key, timeout, unit, res);
            this.lock = res;
            return res;
        }
    }

    private void unlock() {
        if (lock) {
            try {
                Object currentValue = redisTemplate.opsForValue().get(key);
                if (currentValue != null) {
                    redisTemplate.opsForValue().getOperations().delete(key);
                    log.info("Redis unlock key:{} ==> done.", key);
                } else {
                    log.warn("Redis unlock key:{} ==> Key not exists,skip.", key);
                }
            } catch (Exception e) {
                log.error("Redis unlock key:{} ==> An error has occurred.", key, e);
            }
        } else {
            log.info("Redis unlock key:{} ==> skip.", key);
        }
    }

    @Override
    public void close() {
        // 实现AutoCloseable接口close方法,简化try(...)...catch的finally部分,自动调用close方法解锁
        if (autoUnlock) {
            unlock();
        }
    }
}

测试

  1. 测试代码
@RunWith(SpringRunner.class)
@SpringBootTest
public class RedisLockApplicationTests {
    public static final Logger log = LoggerFactory.getLogger(RedisLockApplicationTests.class);

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Test
    public void contextLoads() {
        ExecutorService pool = Executors.newCachedThreadPool(new ThreadFactory() {
            final AtomicInteger threadNumber = new AtomicInteger(1);

            @Override
            public Thread newThread(Runnable r) {
                return new Thread(r, "RedisLock-" + threadNumber.getAndIncrement());
            }
        });
        // 模拟10个并发
        for (int i = 0; i < 10; i++) {
            pool.submit(() -> {
                try (RedisSimpleLock lock = new RedisSimpleLock(redisTemplate, "TESTLOCK", 30, TimeUnit.SECONDS)) {
                    if (lock.lock()) {
                        log.info("获取锁成功,执行业务逻辑");
                        Thread.sleep(10000);
                        log.info("业务逻辑执行完毕");
                    } else {
                        log.info("未获取到锁");
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            });
        }
        pool.shutdown();
        log.info("等待业务完成");
        while (!pool.isTerminated()) {
        }
        log.info("程序结束");
    }

}
  1. 控制台输出
2019-07-16 23:05:15.826  INFO 3779 --- [    RedisLock-2] io.lettuce.core.EpollProvider            : Starting without optional epoll library
2019-07-16 23:05:15.830  INFO 3779 --- [    RedisLock-2] io.lettuce.core.KqueueProvider           : Starting without optional kqueue library
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-9] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[true]
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-4] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-7] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-4] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-7] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.136  INFO 3779 --- [    RedisLock-9] c.s.redislock.RedisLockApplicationTests  : 获取锁成功,执行业务逻辑
2019-07-16 23:05:16.137  INFO 3779 --- [    RedisLock-4] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.137  INFO 3779 --- [    RedisLock-7] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.137  INFO 3779 --- [    RedisLock-6] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.138  INFO 3779 --- [    RedisLock-6] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.138  INFO 3779 --- [    RedisLock-3] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.138  INFO 3779 --- [    RedisLock-6] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.138  INFO 3779 --- [    RedisLock-3] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.138  INFO 3779 --- [    RedisLock-3] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.139  INFO 3779 --- [    RedisLock-1] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.139  INFO 3779 --- [    RedisLock-1] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.139  INFO 3779 --- [    RedisLock-1] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.140  INFO 3779 --- [   RedisLock-10] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-5] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.140  INFO 3779 --- [   RedisLock-10] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-5] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-8] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.140  INFO 3779 --- [   RedisLock-10] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-5] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-8] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.140  INFO 3779 --- [    RedisLock-8] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:16.141  INFO 3779 --- [    RedisLock-2] c.s.redislock.config.RedisSimpleLock     : Redis lock key:TESTLOCK~lock,timeout:30,timeUnit:SECONDS ==> Result:[false]
2019-07-16 23:05:16.142  INFO 3779 --- [    RedisLock-2] c.s.redislock.RedisLockApplicationTests  : 未获取到锁
2019-07-16 23:05:16.142  INFO 3779 --- [    RedisLock-2] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> skip.
2019-07-16 23:05:26.137  INFO 3779 --- [    RedisLock-9] c.s.redislock.RedisLockApplicationTests  : 业务逻辑执行完毕
2019-07-16 23:05:26.145  INFO 3779 --- [    RedisLock-9] c.s.redislock.config.RedisSimpleLock     : Redis unlock key:TESTLOCK~lock ==> done.
2019-07-16 23:05:26.146  INFO 3779 --- [           main] c.s.redislock.RedisLockApplicationTests  : 程序结束
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容