Redis SETNX命令

Redis SETNX命令详解

SETNX命令介绍

Redis的SETNX命令用来向Redis中指定的key设置一个值，当且仅当该key不存在的情况下。如果该key已经存在，则SETNX命令不做任何操作。SETNX命令是原子操作，即在同一时间只能有一个客户端对同一个key执行SETNX命令。

SETNX命令使用方法

SETNX命令的使用方法如下：

SETNX key value

其中，key是要被设置的key，value是要为该key设置的值。

SETNX命令返回值

SETNX命令的返回值如下：

• 如果key不存在，则设置成功，返回1
• 如果key已经存在，则设置失败，返回0

SETNX命令实例说明

实例1

我们可以通过SETNX命令实现一个基于Redis的锁。在一个多线程或者多进程的程序中，若想要使用某一个共享资源时，需要先对该资源进行加锁，才能对该资源进行读写操作。实现一个Redis锁的示例代码如下：

import redis
import time

class RedisLocker():
    def __init__(self, redis_host, redis_port, redis_db, lock_ttl):
        self.redis_conn = redis.StrictRedis(host=redis_host, port=redis_port, db=redis_db)
        self.lock_ttl = lock_ttl

    def acquire(self, lock_name, lock_id):
        while True:
            lock_value = int(time.time()) + self.lock_ttl
            acquired = self.redis_conn.setnx(lock_name, lock_value)
            if acquired or (int(self.redis_conn.get(lock_name)) < int(time.time()) and self.redis_conn.getset(lock_name, lock_value)):
                print(f"线程 {lock_id} 拿到了锁")
                return lock_value
            print(f"线程 {lock_id} 没有拿到锁")
            time.sleep(0.02)

    def release(self, lock_name, lock_value):
        if self.redis_conn.get(lock_name) == lock_value:
            self.redis_conn.delete(lock_name)
            print(f"锁 {lock_name}:{lock_value} 释放成功")
        else:
            print(f"锁 {lock_name}:{lock_value} 已经被释放或该锁已被其他线程占用")

在上面的代码中，我们通过调用Redis的SETNX命令创建了一个名为lock_name的key，并设置了一个value值。如果获取锁的线程在锁的过期时间之前调用release()方法，那么该锁就会被正常地释放掉。如果在锁的过期时间之内其他线程没有尝试获取该锁，那么释放锁的任务会被自动交给Redis，以免因为某个线程忘记释放锁而导致其他线程无法获取到该资源。

实例2

当需要在程序中将一个变量做递增操作时，可以使用Redis中的INCR命令。但是使用INCR命令前，我们可能需要检查该key是否存在，如果不存在，则需要先将该key初始化为1。为了解决这个问题，可以使用Redis中的SETNX命令结合INCR命令来实现该功能。示例代码如下：

import redis

redis_conn = redis.StrictRedis()

if not redis_conn.exists("count"):
    redis_conn.setnx("count", 1)

redis_conn.incr("count")
count = redis_conn.get("count")
print(f"当前count的值是 {count}")

在上面的代码中，如果count不存在，则使用setnx命令将count初始化为1。如果count已经存在，则使用incr命令将count自增1，并获取自增后的值。