Redis的SETNX的使用

浅浅的花香味﹌ 2022-04-11 11:50 353阅读 0赞

### 一.介绍 ###

在 Redis 里，所谓 SETNX，是「SET if Not eXists」的缩写，也就是只有不存在的时候才设置，可以利用它来实现锁的效果。

###### SETNX key value ######

将 key 的值设为 value ，当且仅当 key 不存在。  
若给定的 key 已经存在，则 SETNX 不做任何动作。

### 二.选项命令 ###

在SET命令中，有很多选项可用来修改命令的行为。 以下是SET命令可用选项的基本语法。

> redis 127.0.0.1:6379> SET KEY VALUE \[EX seconds\] \[PX milliseconds\] \[NX|XX\]

(1)设置指定的到期时间(以秒为单位)。

> ShellEX seconds −

(2)设置指定的到期时间(以毫秒为单位)

> PX milliseconds

(3)仅在键不存在时设置键

> NX

(4)只有在键已存在时才设置

> XX

示例

> redis 127.0.0.1:6379> SET mykey “redis” EX 60 NX  
> OK

Shell以上示例将在键“mykey”不存在时，设置键的值，到期时间为60秒。

### 三.使用redisTemplate操作SetNx ###

##### 1.设置setNx #####

/** * @Author lss0555 * @Description setNx操作 **/
        @Override
        public boolean setNx(String key,String value, long time) { 
            try { 
                RedisCallback<String> callback = (connection) -> { 
                    JedisCommands commands = (JedisCommands) connection.getNativeConnection();
                    return commands.set(key, value, "NX", "PX", time);
                };
                String result = redisTemplate.execute(callback);
    
                return !StringUtils.isEmpty(result);
            } catch (Exception e) { 
                logger.error("set redis occured an exception", e);
            }
            return false;
        }

##### 2.获取getNx #####

/** * @Description getNx **/
        @Override
        public String getNx(String key) { 
            try { 
                RedisCallback<String> callback = (connection) -> { 
                    JedisCommands commands = (JedisCommands) connection.getNativeConnection();
                    return commands.get(key);
                };
                String result = redisTemplate.execute(callback);
                return result;
            } catch (Exception e) { 
                logger.error("get redis occured an exception", e);
            }
            return "";
        }

##### 3.lua脚本删除redis中匹配value的key #####

在分布式锁的应用中,使用lua脚本删除redis中匹配value的key，可以避免由于方法执行时间过长而redis锁自动过期失效的时候误删其他线程的锁,spring自带的执行脚本方法中，集群模式直接抛出不支持执行脚本的异常，所以只能拿到原redis的connection来执行脚本。

1.使用脚本的好处  
（1）减少网络开销，在Lua脚本中可以把多个命令放在同一个脚本中运行  
（2）原子操作，redis会将整个脚本作为一个整体执行，中间不会被其他命令插入。  
（3）复用性，客户端发送的脚本会永远存储在redis中，这意味着其他客户端可以复用这一脚本来完成同样的逻辑

2.使用示例

@Override
        public boolean unlcok(String key,String value) { 
            try { 
                List<String> keys = new ArrayList<>();
                keys.add(key);
                List<String> args = new ArrayList<>();
                args.add(value);          
                RedisCallback<Long> callback = (connection) -> { 
                    Object nativeConnection = connection.getNativeConnection();
                    // 集群模式和单机模式虽然执行脚本的方法一样，但是没有共同的接口，所以只能分开执行
                    // 集群模式
                    if (nativeConnection instanceof JedisCluster) { 
                        return (Long) ((JedisCluster) nativeConnection).eval(UNLOCK_LUA, keys, args);
                    }
    
                    // 单机模式
                    else if (nativeConnection instanceof Jedis) { 
                        return (Long) ((Jedis) nativeConnection).eval(UNLOCK_LUA, keys, args);
                    }
                    return 0L;
                };
                Long result = redisTemplate.execute(callback);
                return result != null && result > 0;
            } catch (Exception e) { 
                logger.error("release lock occured an exception", e);
            } finally { 
                // 清除掉ThreadLocal中的数据，避免内存溢出
                //lockFlag.remove();
            }
            return false;
        }
        
        public static final String UNLOCK_LUA;    
        static { 
            StringBuilder sb = new StringBuilder();
            sb.append("if redis.call(\"get\",KEYS[1]) == ARGV[1] ");
            sb.append("then ");
            sb.append(" return redis.call(\"del\",KEYS[1]) ");
            sb.append("else ");
            sb.append(" return 0 ");
            sb.append("end ");
            UNLOCK_LUA = sb.toString();
        }