Redis 常用的python api

墨蓝 2023-06-25 06:06 44阅读 0赞

# 1.初识Redis #

## 1.1 简介 ##

简介略，安装教程附上

[redis 安装教程][redis]

[docker mysql/redis安装][docker mysql_redis]

[redis-api 参考][redis-api]

## 1.2 Redis 数据结构简介 ##

#### String 字符串 ####

#### List 列表 ####

#### Hash 字典 ####

#### set 集合 ####

#### zset 有序集合 ####

<table> 
 <thead> 
  <tr> 
   <th>数据结构</th> 
   <th>结构存储的值</th> 
   <th>读写的能力</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>string</td> 
   <td>字符串,整数，浮点数</td> 
   <td>1.对整个字符串或字符串的其中一部分执行操作;2.整数/浮点数可以自增自减操作</td> 
  </tr> 
  <tr> 
   <td>list</td> 
   <td>一个链表，链表上的每个节点都包含了一个字符串</td> 
   <td>1.链表两端推入/弹出元素;2.根据偏移量对列表进行修剪;3.读取单个或多个元素4.根据值查找/移除元素</td> 
  </tr> 
  <tr> 
   <td>set</td> 
   <td>集合</td> 
   <td>1.添加/获取/删除单个元素; 2.检查一个元素是否在集合中;3.计算交集/并集/差集;4.集合中随机取出元素</td> 
  </tr> 
  <tr> 
   <td>hash</td> 
   <td>包含键值对的无序散列表</td> 
   <td>1.添加/获取/删除单个键值对;2.获取所有键值对</td> 
  </tr> 
  <tr> 
   <td>zset</td> 
   <td>有序集合，字符串成员与浮点数分值之间的有序映射，元素的排列顺序由分值大小决定。</td> 
   <td>1.添加/获取/删除单个元素;2.根据分值范围或者成员来获取元素</td> 
  </tr> 
 </tbody> 
</table>

## 1.3 redis-api(Python) ##

redis 示例 https://www.redis.net.cn/order/

### 1.3.1 字符串操作 String ###

#### get:获取值 ####

conn.get("key")       # 如果不存在，将得到None

#### incr/decr:自增/自减 ####

conn.incr("key")      # 对不存在的键执行自增操作，返回 1
    conn.incr("key",15)   # 此时key=1,自增15,返回16
    coon.decr("key",5)    # 自减操作,此时key=16,返回11
    
    incrbyfloat(self, name, amount=1.0)

#### set:设置值 ####

coon.set("key","13")  # 为key设置值为13，返回True
    """ set(self, name, value, ex=None, px=None, nx=False, xx=False) ex 过期时间为 秒 px 过期时间为 毫秒 nx 如果nx设置为True,只有name不存在时，才执行set操作 xx 如果xx设置为True,只有name存在，才执行操作 return:执行操作返回True,不执行操作返回None """
    
    # 其他设置值方法
    setnx(name, value)           # 只有name不存在时，执行设置操作
    setex(name, value, time)     # 设置过期时间 数字秒或timedelta对象
    psetex(name, time_ms, value) # 设置过期时间 数字毫秒或timedelta对象
    getset(name, value)          # 设置新值 并获取旧值

#### 批量操作 ####

mset(args, *kwargs)
    mget(args, *kwargs)
    """ 批量设置值 r.mget({'k1': 'v1', 'k2': 'v2'}) r.mset(k1="v1", k2="v2") # 这里k1 和k2 不能带引号 一次设置对个键值对 批量取值 r.mget("k1") r.mget('k1', 'k2') r.mget(['k1', 'k2']) r.mget("fruit", "fruit1", "fruit2", "k1", "k2") # 将目前redis缓存中的键对应的值批量取出来 """

#### 字符串子序列操作 ####

append(key, value) # 在redis name对应的值后面追加内容
    
    # 获取字符串的子序列
    # 需要注意 1个汉字3个字节 1个字母1个字节 (每个字节8bit)
    getrange(key, start, end)     # 切片操作，操作的是字节序列。
    setrange(name, offset, value) # 修改，位置后面的用value代替
    setbit(name, offset, value)   # 对 位序列 进行操作 0101010， 所以value只能是0/1
    getbit(name, offset)          # 获取name对应的值的二进制表示中的某位的值 （0或1）
    bitcount(key, start=None, end=None) # 返回bit的长度
    strlen(name)                  # 返回字节长度
    
    # 获取多个值，并将值做位运算，将最后的结果保存至新的name对应的值
    # operation,AND（并） 、 OR（或） 、 NOT（非） 、 XOR（异或）
    # dest, 新的Redis的name
    # *keys,要查找的Redis的name
    bitop(operation, dest, *keys)

### 1.3.2 列表操作 List ###

#### 追加操作 ####

r.lpush(name,values)           # 向列表name 最左边添加新元素，name不存在则新建
    r.lpush("list1", 11, 22, 33) # 保存顺序为: 33,22,11
    r.rpush("list2", 11, 22, 33)  # 表示从右向左操作
    
    r.lpushx(name,value)            # 向左添加 只有name存在才执行
    r.rpushx(name,value)          # 向右添加 只有name存在才执行

#### 查询操作 ####

r.lrange('list1', 0, 3)  # 切片取出值，范围是索引号0-3
    r.lrange("list2", 0, -1) # 切片取出值，范围是索引号0-最后一个元素
    r.llen("list2")          # 返回列表长度
    
    r.lindex(name, index)    # 取出索引对应的值

#### 插值操作 ####

linsert(name, where, refvalue, value)  # where before/after 之前/之后
    r.linsert("list2", "before", "11", "00")   # 往列表中左边第一个出现的元素"11"前插入元素"00"

#### 修改操作 ####

# 赋值
    r.lset(name, index, value) # 对name对应的list中的某一个索引位置重新赋值
    
    # 移动
    rpoplpush(src, dst) # 从list1最右，放入list2最左
    brpoplpush(src, dst, timeout=0) # 0 阻塞，单位秒，同上。

#### 删除操作 ####

r.lrem(name, value, num) # 在name对应的list中删除指定的值
    """ value，要删除的值 num=0，删除列表中所有的指定值 num=1,从前到后，删除左边第1个 num=2,从前到后，删除2个 num=-2,从后向前，删除2个 """
    
    # 删除并返回 -> 弹出
    lpop(name)
    rpop(name)
    
    # 一次弹出多个列表
    blpop(keys, timeout)   #将多个列表排列，按照从左到右去pop对应列表的元素 返回 (key,元素)
    brpop(keys, timeout) #同blpop，将多个列表排列,按照从右像左去移除各个列表内的元素
    
    # 删除索引之外的值
    ltrim(name, start, end)

### 1.3.3 字典操作 Hash ###

hset(name, key, value)   # 没有就新增，有的话就修改
    hsetnx(name, key, value) # 如果不存在，则创建，存在则不执行。
    hmset(name, mapping)     # 批量设置，mapping 是字典
    
    hget(name,key)           # 取
    hmget(name, keys, *arg)  # 批量取
    hgetall(name)            # 取出所有键值对
    
    hlen(name)               # 获取len
    hkeys(name)              # 获取所有key
    hvals(name)              # 获取所有值
    
    hexists(name, key)       # 判断key是否存在
    
    hdel(name,*keys)         # 删除键值对
    
    # 自增自减
    hincrby(name, key, amount=1)        # 如果存在，则修改+1 不存在设为1
    hincrbyfloat(name, key, amount=1.0) # 负数就是自减
    
    hscan(name, cursor=0, match=None, count=None)
    """ hscan可以实现分片的获取数据 不需要一次性获取全部，数据大的情况下，可节省内存 name，redis的name cursor，游标（基于游标分批取获取数据） match，匹配指定key，默认None 表示所有的key count，每次分片最少获取个数，默认None表示采用Redis的默认分片个数 如： 第一次：cursor1, data1 = r.hscan(‘xx’, cursor=0, match=None, count=None) 第二次：cursor2, data1 = r.hscan(‘xx’, cursor=cursor1, match=None, count=None) """
    
    hscan_iter(name, match=None, count=None)
    """ 利用yield封装hscan创建生成器，实现分批去redis中获取数据 match，匹配指定key，默认None 表示所有的key count，每次分片最少获取个数，默认None表示采用Redis的默认分片个数 for item in r.hscan_iter('hash1'): print(item) print(r.hscan_iter("hash1")) """

### 1.3.4 集合操作 Set ###

sadd(name,values) # 设置集合 r.sadd("set1", 33, 44, 55, 66) 
    scard(name)       # 集合的len
    smembers(name)    # 获取集合左右成员
    sscan(name, cursor=0, match=None, count=None) # 获取所有成员，元组
    sscan_iter(name, match=None, count=None)      # 迭代分批获取，yield
    
    # 差集
    sdiff(keys, *args) # 在第一个name对应的集合中且不在其他name对应的集合的元素集合
    sdiffstore(dest, keys, *args) # 找出差集，加入到dest
    
    # 交集
    sinter(keys, *args) # 找出交集
    sinterstore(dest, keys, *args) # 找出交集，加入到dest中
    
    # 并集
    sunion(keys, *args) # 取2个集合的并集
    sunionstore(dest,keys, *args) # 取并集，并将结果保存到dest中
    
    # 判断
    sismember(name, value) # 集合中是否存在这个元素value
    
    # 移动
    smove(src, dst, value) # 将value从src移动搭配dst
    
    # 删除(随机的)
    spop(name) # 随机删除并返回

### 1.3.5 有序集合操作 ZSet ###

有序集合是在set基础上的扩展，每个元素都有2个值 `(值和分数)` **依据分数进行排序**

# 添加元素
    zadd(name, args, *kwargs)
    r.zadd("zset1", n1=11, n2=22)      # 注意没有引号
    r.zadd("zset2", 'm1', 22, 'm2', 44)
    
    # 获取长度
    zcard(name)
    
    # 获取有序集合中分数在[min,max]之间的个数
    zcount(name, min, max)
    
    # 获取name对应有序集合中 value 对应的分数
    zscore(name, value)
    
    
    
    # 按照索引范围获取name对应的有序集合的元素
    r.zrange( name, start, end, desc=False, withscores=False, score_cast_func=float)
    """ 按照索引范围获取name对应的有序集合的元素 name，redis的name start，有序集合索引起始位置（非分数） end，有序集合索引结束位置（非分数） desc，排序规则，默认按照分数从小到大排序 withscores，是否获取元素的分数，默认只获取元素的值 score_cast_func，对分数进行数据转换的函数 """
    
    # 同zrange，集合是从大到小排序的
    zrevrange(name, start, end, withscores=False, score_cast_func=float)
    
    
    # 删除name对应的有序集合中值是values的成员
    zrem(name, values)
    # 根据排行范围删除
    zremrangebyrank(name, min, max)
    # 根据分数范围删除
    zremrangebyscore(name, min, max)

[redis]: https://blog.csdn.net/sunt2018/article/details/88531173
[docker mysql_redis]: https://blog.csdn.net/sunt2018/article/details/85263432
[redis-api]: https://blog.csdn.net/kl28978113/article/details/78726946