安科网

springboot 中单机 redis 实现分布式锁

loviezhang

loviezhang

2020-01-03

关注 关注

在微服务中经常需要使用分布式锁，来执行一些任务。例如定期删除过期数据，在多个服务中只需要一个去执行即可。

以下说明非严格意义的分布式锁，因为 redis 实现严格意义的分布式锁还是比较复杂的，对于日常简单使用使用如下简单方法即可。即偶尔不执行任务不影响业务。

实现要点

1）获得锁、释放锁需要是原子操作。要么获取成功，要么失败。释放要么成功，要么失败

2）任务完成需要自己释放自己的锁，不能释放别人的锁。

3）锁要有过期时间限制，防止任务崩溃没有释放锁，导致其他节点无法获得锁。

4）执行节点超时长时间不释放锁，到下次任务开始执行并行存在的情况

要考虑的风险点

1）获取锁失败，偶尔不执行任务要不影响业务或告警人工干预

2）redis 宕机，导致无法获取锁

方案一：低版本使用 jedis 实现

1 添加依赖，高版本或低版本有些方法可能没有

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><scope>compile</scope></dependency>
<dependency><groupId>redis.clients</groupId><artifactId>jedis</artifactId><version>2.10.2</version></dependency>

2 实现方法

@Slf4j
public abstract class AbsDistributeLock {

    private Jedis jedis;

    public void initDistributeLock(String ip, int port, Integer database, String password) {
        jedis = new Jedis(ip, port);
        if (password != null && !password.isEmpty()) {
            jedis.auth(password.trim());
        }
        if (database == null || database < 0 || database > 15) {
            database = 0;
        }
        jedis.select(database);
    }

    private static final String LOCK_SUCCESS = "OK";
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "PX";

    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 具体的任务需要子类去实现
     *
     * @throws RTException 分布式锁异常
     */
    public abstract void taskService() throws RTException;

    /**
     * 任一执行，ANY OF
     * 所有节点任意一个执行任务 taskService 即可，没有获得锁的节点不执行任务
     *
     * @param lockKey    lockKey
     * @param keyValue   keyValue
     * @param expireTime 过期时间 ms
     */
    public void onlyOneNodeExecute(String lockKey, String keyValue, int expireTime) {
        boolean getLock = false;
        try {
            if ((getLock = getDistributedLock(jedis, lockKey, keyValue, expireTime))) {
                taskService();
            }
        } finally {
            if (getLock) {
                releaseDistributedLock(jedis, lockKey, keyValue);
            }
        }
    }

    /**
     * 所有串行执行，ALL IN LINE
     * 所有节点都必须执行该任务，每次只能一个执行。
     *
     * @param lockKey    lockKey
     * @param keyValue   keyValue
     * @param expireTime 过期时间 ms
     */
    public void allNodeExecute(String lockKey, String keyValue, int expireTime) {
        try {
            while (!(getDistributedLock(jedis, lockKey, keyValue, expireTime))) {
                try {
                    Thread.sleep(200);
                } catch (InterruptedException e) {
                    log.info(e.getMessage());
                }
            }
            taskService();
        } finally {
            releaseDistributedLock(jedis, lockKey, keyValue);
        }
    }

    /**
     * @param jedis      客户端
     * @param lockKey    key
     * @param keyValue   key值
     * @param expireTime 过期时间，ms
     */
    public static boolean getDistributedLock(Jedis jedis, String lockKey, String keyValue, int expireTime) {
        String result = jedis.set(lockKey, keyValue, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
        if (LOCK_SUCCESS.equals(result)) {
            log.info("ip:[{}] get lock:[{}], value:[{}], getLock result:[{}]", IpUtil.getLocalIpAddr(), lockKey, keyValue, result);
            return true;
        } else {
            return false;
        }
    }

    public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String keyValue) {
        String script = "if redis.call(‘get‘, KEYS[1]) == ARGV[1] then return redis.call(‘del‘, KEYS[1]) else return 0 end";
        Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(keyValue));
        log.info("ip:[{}] release lock:[{}], value:[{}], release result: [{}]", IpUtil.getLocalIpAddr(), lockKey, keyValue, result);
        if (RELEASE_SUCCESS.equals(result)) {
            return true;
        }
        return false;
    }

}

方案二：高版本的springboot，使用 lua 脚本执行

1 添加依赖

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

2 代码实现

@Slf4j
public abstract class AbsDistributeLockLua {

    private RedisTemplate<String, String> redisTemplate;

    public AbsDistributeLockLua(RedisTemplate<String, String> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    /**
     * 具体的任务需要子类去实现
     *
     * @throws RTException 分布式锁异常
     */
    public abstract void taskService() throws RTException;

    /**
     * 任一执行，ANY OF
     * 所有节点任意一个执行任务 taskService 即可，没有获得锁的节点不执行任务
     *
     * @param lockKey    lockKey
     * @param keyValue   keyValue
     * @param expireTime 过期时间 ms
     */
    public void onlyOneNodeExecute(String lockKey, String keyValue, int expireTime) {
        boolean getLock = false;
        try {
            if ((getLock = getDistributeLock(redisTemplate, lockKey, keyValue, expireTime))) {
                taskService();
            }
        } finally {
            if (getLock) {
                releaseDistributeLock(redisTemplate, lockKey, keyValue);
            }
        }
    }

    /**
     * 所有串行执行，ALL IN LINE
     * 所有节点都必须执行该任务，每次只能一个执行。
     *
     * @param lockKey    lockKey
     * @param keyValue   keyValue
     * @param expireTime 过期时间 ms
     */
    public void allNodeExecute(String lockKey, String keyValue, int expireTime) {
        try {
            while (!(getDistributeLock(redisTemplate, lockKey, keyValue, expireTime))) {
                try {
                    Thread.sleep(200);
                } catch (InterruptedException e) {
                    log.info(e.getMessage());
                }
            }
            taskService();
        } finally {
            releaseDistributeLock(redisTemplate, lockKey, keyValue);
        }
    }

    /**
     * 通过lua脚本 加锁并设置过期时间
     *
     * @param key    锁key值
     * @param value  锁value值
     * @param expire 过期时间，单位毫秒
     * @return true：加锁成功，false：加锁失败
     */
    public boolean getDistributeLock(RedisTemplate<String, String> redisTemplate, String key, String value, int expire) {
        DefaultRedisScript<String> redisScript = new DefaultRedisScript<String>();
        redisScript.setResultType(String.class);
        String strScript = "if redis.call(‘setNx‘,KEYS[1],ARGV[1])==1 then return redis.call(‘pexpire‘,KEYS[1],ARGV[2]) else return 0 end";
        redisScript.setScriptText(strScript);
        try {
            Object result = redisTemplate.execute(redisScript, redisTemplate.getStringSerializer(), redisTemplate.getStringSerializer(), Collections.singletonList(key), value, expire);
            System.out.println("redis返回：" + result);
            return "1".equals("" + result);
        } catch (Exception e) {
            //可以自己做异常处理
            return false;
        }
    }

    /**
     * 通过lua脚本释放锁
     *
     * @param key   锁key值
     * @param value 锁value值（仅当redis里面的value值和传入的相同时才释放，避免释放其他线程的锁）
     * @return true：释放锁成功，false：释放锁失败（可能已过期或者已被释放）
     */
    public boolean releaseDistributeLock(RedisTemplate<String, String> redisTemplate, String key, String value) {
        DefaultRedisScript<String> redisScript = new DefaultRedisScript<>();
        redisScript.setResultType(String.class);
        String strScript = "if redis.call(‘get‘, KEYS[1]) == ARGV[1] then return redis.call(‘del‘, KEYS[1]) else return 0 end";
        redisScript.setScriptText(strScript);
        try {
            Object result = redisTemplate.execute(redisScript, redisTemplate.getStringSerializer(), redisTemplate.getStringSerializer(), Collections.singletonList(key), value);
            return "1".equals("" + result);
        } catch (Exception e) {
            //可以自己做异常处理
            return false;
        }
    }
}

代码地址:https://github.com/crazyCodeLove/distribute-lock

参考文献：

https://www.cnblogs.com/bcde/p/11132479.html

https://blog.csdn.net/u013985664/article/details/94459529

redis 分布式锁 redis分布式锁 jedis string

loviezhang

loviezhang

0 关注 0 粉丝 0 动态

关注 关注

相关推荐

php redis setnx分布式锁简单原理解析

我就废话不多说了，大家还是直接看代码吧~如果一个请求更新缓存的时间比较长，甚至比锁的有效期还要长，导致在缓存更新过程中，锁就失效了，此时另一个请求会获取锁，但前一个请求在缓存更新完毕的时候，如果不加以判断直接删除锁，就会出现误删除其它请求创建的锁的情况，所

savorTheFlavor 2020-10-23

程序员必懂的Redis技术实战

Redis是现在很受欢迎的NoSQL数据库之一，目前广泛用于缓存系统、分布式锁、计数器、消息队列系统、排行榜、社交网络等场景中，本篇文章成哥为大家带来redis日常使用实践，及通过代码实现redis的分布式锁。Redis通过IO多路复用解决单线程下并发客户

smartbaby 2020-11-11

redis的设计及使用场景

redis是一个完全开源的，高性能的key-value数据库，特点是：支持原子性、持久化、丰富的数据类型。在使用redis的时候，要注意的key设计，这样易于维护，考虑持久化策略，以防在服务异常的时候快速的恢复数据；考虑系统的安全策略，不能使用key *命

夙梦流尘 2020-09-23

springboot redis lua脚本分布式锁

* @param value redis的value要求是随机串，防止释放其他请求的锁。* @param expireTime redis的key 的过期时间 防止死锁，导致其他请求无法正常执行业务。String script =

峰哥 2020-09-23

Redis中的String类型及使用Redis解决订单秒杀超卖问题

本系列将和大家分享Redis分布式缓存，本章主要简单介绍下Redis中的String类型，以及如何使用Redis解决订单秒杀超卖问题。Redis中5种数据结构之String类型：key-value的缓存，支持过期，value不超过512M。Redis是单线

聚合室 2020-11-16

springboot +redis 实现点赞、浏览、收藏、评论等数量的增减操作

最近做了一个帖子的收藏、点赞数量的功能，其实之前也做过类似的功能，因为之前一直使用的mysql 总是感觉对于这种频繁需要改变的值，不应该给予Mysql过大的压力，本文章采用的是redis 做了持久化。下面贴出关键代码：DataResponse是项目中使用的

零 2020-09-18

Redis migrate数据迁移工具的使用教程

在工作中可能会遇到单点Redis向Redis集群迁移数据的问题，但又不能老麻烦运维来做。为了方便研发自己迁移数据，我这里写了一个简单的Redis迁移工具，希望对有需要的人有用。该工具已经编译成了多平台命令，直接从Github下载二进制文件执行就好了。把代码

afanti 2020-09-16

快速制作Redis Docker镜像

现在容器化已经是趋势，制作镜像也是我们的基础工作。镜像越小，部署起来越方便。在这个方面，轻巧的Linux发行版本就是一个很好的选择，这里我们选择alpine linux 。目前最新版本是3.12.1。官方很友好的提供了minirootfs的包，这个包就是为

王道革 2020-11-25

Go+Vue开发一个线上外卖应用的流程(用户名密码和图形验证码)

在使用用户名和密码登录功能时，需要填写验证码，验证码是以图形化的方式进行获取和展示的。验证通过即可继续进行登录。借助开源的验证码工具库可以生成验证码。第一个example是用于演示生成验证码和验证码的示例代码。当验证码生成后，将验证码存放在Redis中，并

wangdonghello 2020-11-03

Windows安装Redis并添加本地自启动服务的实例详解

在windows本地搭建redis缓存，添加到本地计算机的服务中，保证每次开机自动启动服务。解压缩包，拷贝文件夹到计算机指定的磁盘下。然后编辑redis.windows.conf文件，设置redis的密码：找到# requirepass foobared

Langeldep 2020-11-16

Redis客户端及服务端的安装教程详解

本系列将和大家分享Redis分布式缓存，本文是该系列的开篇，主要简单介绍下Redis客户端及服务端的安装。基于内存管理，实现了5种数据结构，单线程模型的应用程序，对外提供插入--查询--固化--集群功能。但是不能当数据库，不能作为数据的最终依据。单线程多进

chenhualong0 2020-11-16

详解Redis数据结构之跳跃表

我们先不谈Redis，来看一下跳表。还要支持输入道具名称的精确查询和不输入名称的全量查询。拍卖行商品列表是线性的，最容易表达线性结构的是数组和链表。每个元素均关联一个double类型的score，Redis 根据score进行从小到大排序；这个是 Redi

koushr 2020-11-12

Linux下redis5.0.5的安装过程与配置方法

先将 redis-5.0.5 里的配置文件 redis.conf 移动到刚创建的 config 文件夹。 注释掉 bind 127.0.0.1 这一行。 将 protected-mode 属性改为 no

MRFENGG 2020-11-11

Redis 的 GeoHash详解

Redis 在 3.2 版本以后增加了地理位置 GEO 模块，意味着我们可以使用 Redis 来实现摩拜单车「附近的 Mobike」、美团和饿了么「附近的餐馆」这样的功能了。比如掘金办公室在望京 SOHO，它的经纬度坐标是 ，都是正数，因为中国位于东北半球

guoyanga 2020-11-10

通过kubesphere部署redis的方法

docker run --name redis -p 6379:6379 -d --restart=always a4d3716dbb72 redis-server --appendonly yes --requirepass "123456&q

fackyou00 2020-11-10

为啥Redis使用pipelining会更快

为啥Redis使用pipelining会更快？为什么执行结果相差如此之大呢？因为这是连接本地的redis，所以网络开销非常小，当然，这里仍然有一部分是网络开销影响，可是除此之外是否还有其它影响因素呢？答案是有，比如OS进程调度，当不使用管道时，Redis处

Orangesss 2020-11-03

基于Redis+Lua脚本实现分布式限流组件封装的方法

<artifactId>spring-boot-starter-data-redis</artifactId>. -- Created by IntelliJ IDEA.local count = tonumber(redis.ca

dongCSDN 2020-10-31

Redis概述及linux安装redis的详细教程

性能极高，Redis能读的速度是110000次/s,写的速度是81000次/s 。Redis支持数据的持久化，可以将内存中的数据保持在磁盘中，重启的时候可以再次加载进行使用。Redis不仅仅支持简单的key-value类型的数据，同时还提供list，set

rainandtear 2020-10-30

Redis常用数据类型命令实例汇总

存储：zadd key score menber1 score menber2 ...删除指定的key：del key1 key2...获取所有与pattern匹配的key： keys pattern 。

Quietboy 2020-10-30

解密Redis助力双11背后电商秒杀系统(推荐)

秒杀活动是绝大部分电商选择的低价促销，推广品牌的方式。既可以给平台带来用户量，还可以提高平台知名度。一个好的秒杀系统，可以提高平台系统的稳定性和公平性，获得更好的用户体验，提升平台的口碑，从而提升秒杀活动的最大价值。本文讨论云数据库Redis版缓存设计高并

liuyulong 2020-10-29
loviezhang

loviezhang

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号