1. SET key value [EX seconds] [PX milliseconds] [NX|XX]
Original: Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type. Any previous time to live associated with the key is discarded on successful SET operation.
将字符串值 value 关联到 key 。
如果 key 已经持有其他值, SET 就覆写旧值,无视类型。
对于某个原本带有生存时间(TTL)的键来说, 当 SET 命令成功在这个键上执行时, 这个键原有的 TTL 将被清除。
1.1. 参数
从 Redis 2.6.12 版本开始, SET 命令的行为可以通过一系列参数来修改:
EX second
:设置键的过期时间为 second 秒。SET key value EX second
效果等同于SETEX key second value
。PX millisecond
:设置键的过期时间为 millisecond 毫秒。SET key value PX millisecond
效果等同于PSETEX key millisecond value
。NX
:只在键不存在时,才对键进行设置操作。SET key value NX
效果等同于SETNX key value
。XX
:只在键已经存在时,才对键进行设置操作。
注:因为
SET
命令可以通过参数来实现和 SETNX 、 SETEX 和 PSETEX 三个命令的效果,所以将来的 Redis 版本可能会废弃并最终移除 SETNX 、 SETEX 和 PSETEX 这三个命令。
1.2. 起始版本:
= 1.0.0
1.3. 时间复杂度:
O(1)
1.4. 返回值:
在 Redis 2.6.12 版本以前, SET 命令总是返回 OK 。
从 Redis 2.6.12 版本开始, SET 在设置操作成功完成时,才返回 OK 。
如果设置了 NX
或者 XX
,但因为条件没达到而造成设置操作未执行,那么命令返回空批量回复(NULL Bulk Reply)。
1.5. 案例
# 对不存在的键进行设置
127.0.0.1:6379> set key1 value1
OK
127.0.0.1:6379> get key1
"value1"
# 默认没有设置有效期
127.0.0.1:6379> TTL key1
(integer) -1
# 使用EX选项设置有效期为10秒
127.0.0.1:6379> set key2 value2 ex 10
OK
127.0.0.1:6379> get key2
"value2"
127.0.0.1:6379> ttl key2
(integer) 4
# 使用PX选项设置有效期为10秒
127.0.0.1:6379> set key3 value3 px 10000
OK
127.0.0.1:6379> get key3
"value3"
127.0.0.1:6379> ttl key3
(integer) 4
# 使用 NX 选项
127.0.0.1:6379> set key1 newvalue1 nx # 键已存在,设置失败
(nil)
127.0.0.1:6379> set key2 newvalue2 nx # 键不存在,设置成功
OK
127.0.0.1:6379> get key1
"value1"
127.0.0.1:6379> get key2
"newvalue2"
# 使用 XX 选项
127.0.0.1:6379> set key1 newvalue1 xx # 键已存在,设置成功
OK
127.0.0.1:6379> set not-exists-key not-exists-key-value xx # 键不存在,设置失败
(nil)
127.0.0.1:6379> get key1
"newvalue1"
127.0.0.1:6379> get not-exists-key
(nil)
1.6. 使用模式
命令 SET resource-name anystring NX EX max-lock-time
是一种在 Redis 中实现锁的简单方法。
客户端执行以上的命令:
- 如果服务器返回 OK ,那么这个客户端获得锁。
- 如果服务器返回 NIL ,那么客户端获取锁失败,可以在稍后再重试。
设置的过期时间到达之后,锁将自动释放。
可以通过以下修改,让这个锁实现更健壮:
- 不使用固定的字符串作为键的值,而是设置一个不可猜测(non-guessable)的长随机字符串,作为口令串(token)。
- 不使用 DEL 命令来释放锁,而是发送一个 Lua 脚本,这个脚本只在客户端传入的值和键的口令串相匹配时,才对键进行删除。 这两个改动可以防止持有过期锁的客户端误删现有锁的情况出现。
以下是一个简单的解锁脚本示例:
if redis.call("get",KEYS[1]) == ARGV[1]
then
return redis.call("del",KEYS[1])
else
return 0
end
这个脚本可以通过 EVAL ...script... 1 resource-name token-value
命令来调用。