python -- redis连接与使用

前面我们简单介绍了 redis nosql 数据库,现在我们在 python 里面来使用 redis。

一、python 连接 redis

在 python 中,要操作 redis,目前主要是通过一个 python-redis 模块来实现

1、在 python 中安装 redis 模块

1 pip3 install redis

2、在 python 中使用 redis

  跟其他模块一样,在安装好 redis 模块后,要使用 redis 模块就要先导入。

python 连接 redis 数据库:

 1 #!/usr/bin/env python
 2 # -*- coding:utf8 -*-
 3 
 4 import redis
 5 
 6 '''
 7 这种连接是连接一次就断了,耗资源. 端口默认 6379,就不用写
 8 r = redis.Redis(host='127.0.0.1',port=6379,password='tianxuroot')
 9 r.set('name','root')
10 
11 print(r.get('name').decode('utf8'))
12 '''
13 '''
14 连接池:
15 当程序创建数据源实例时,系统会一次性创建多个数据库连接,并把这些数据库连接保存在连接池中,当程序需要进行数据库访问时,
16 无需重新新建数据库连接,而是从连接池中取出一个空闲的数据库连接
17 '''
18 pool = redis.ConnectionPool(host='127.0.0.1',password='helloworld')   #实现一个连接池
19 
20 r = redis.Redis(connection_pool=pool)
21 r.set('foo','bar')
22 print(r.get('foo').decode('utf8'))

 

二、Redis API 使用

redis-py 的 API 的使用可以分类为:

  • 连接方式
  • 连接池
  • 操作
    • String 操作
    • Hash 操作
    • List 操作
    • Set 操作
    • Sort Set 操作
  • 管道
  • 发布订阅

前面通过一个连接实例来简述了 python 用过 redis 模块连接 redis 数据库的连接方式和连接池。

接下来主要看如何通过 python 来操作 redis 数据库:

1. String 操作

redis 中的 String 在在内存中按照一个 name 对应一个 value 来存储。如图:

set(name, value, ex=None, px=None, nx=False, xx=False)
  在 Redis 中设置值,默认,不存在则创建,存在则修改
  参数:
       ex,过期时间(秒)
       px,过期时间(毫秒)
       nx,如果设置为 True,则只有 name 不存在时,当前 set 操作才执行
       xx,如果设置为 True,则只有 name 存在时,岗前 set 操作才执行

setnx(name, value)
#设置值,只有 name 不存在时,执行设置操作(添加)

setex(name, value, time)
  # 设置值
  #
参数:
# time,过期时间(数字秒 或 timedelta 对象)
psetex(name, time_ms, value)
  # 设置值
  #
参数:
    # time_ms,过期时间(数字毫秒 或 timedelta 对象)

mset(
*args, **kwargs)
批量设置值
  如:
mset(k1
='v1', k2='v2')

mget({
'k1': 'v1', 'k2': 'v2'})

get(name)
获取值

mget(keys, *args)
批量获取
   如:
mget(
'name', 'root')

r.mget([
'name', 'root'])

getset(name, value)
设置新值并获取原来的值

getrange(key, start, end)
# 获取子序列(根据字节获取,非字符)
  #
参数:
#name,Redis 的 name
# start,起始位置(字节)
# end,结束位置(字节)
  #
如: "你好" ,0-3 表示 "你" (utf8 中一个中文字符占三个字节)

setrange(name, offset, value)
# 修改字符串内容,从指定字符串索引开始向后替换(新值太长时,则向后添加)
  #
参数:
# offset,字符串的索引,字节(一个汉字三个字节)
# value,要设置的值

setbit(name, offset, value)
# 对 name 对应值的二进制表示的位进行操作
  #
参数:
# name,redis 的 name
# offset,位的索引(将值变换成二进制后再进行索引)
# value,值只能是 1 或 0

  # 注:如果在 Redis 中有一个对应: n1 = "foo",
那么字符串 foo 的二进制表示为:01100110 01101111 01101111
所以,如果执行 setbit(
'n1', 7, 1),则就会将第 7 位设置为 1,
那么最终二进制则变成
01100111 01101111 01101111,即:"goo"

  # 扩展,转换二进制表示:
# source = "你好啊"
source = "foo"

<span style="color: rgba(0, 0, 255, 1)">for</span> i <span style="color: rgba(0, 0, 255, 1)">in</span><span style="color: rgba(0, 0, 0, 1)"> source:
    num </span>=<span style="color: rgba(0, 0, 0, 1)"> ord(i)
    </span><span style="color: rgba(0, 0, 255, 1)">print</span> bin(num).replace(<span style="color: rgba(128, 0, 0, 1)">'</span><span style="color: rgba(128, 0, 0, 1)">b</span><span style="color: rgba(128, 0, 0, 1)">'</span>,<span style="color: rgba(128, 0, 0, 1)">''</span><span style="color: rgba(0, 0, 0, 1)">)

特别的,如果source是汉字 </span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">你好啊</span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(0, 0, 0, 1)">怎么办?
答:对于utf</span>-8,每一个汉字占 3 个字节,那么 <span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">人生苦短</span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(0, 0, 0, 1)"> 则有 12个字节
   对于汉字,for循环时候会按照 字节 迭代,那么在迭代时,将每一个字节转换 十进制数,然后再将十进制数转换成二进制
    </span>11100110 10101101 10100110 11100110 10110010 10011011 11101001 10111101 10010000
    -------------------------- ----------------------------- -----------------------------<span style="color: rgba(0, 0, 0, 1)">
             你                               好                           啊

  *用途举例,用最省空间的方式,存储在线用户数及分别是哪些用户在线

getbit(name, offset)
# 获取 name 对应的值的二进制表示中的某位的值 (0 或 1)

bitcount(key, start
=None, end=None)
# 获取 name 对应的值的二进制表示中 1 的个数
  #
参数:
# key,Redis 的 name
# start,位起始位置
# end,位结束位置

strlen(name)
# 返回 name 对应值的字节长度(一个汉字 3 个字节)

incr(self, name, amount
=1)
# 自增 name 对应的值,当 name 不存在时,则创建 name=amount,否则,则自增。
  #
参数:
# name,Redis 的 name
# amount, 自增数(必须是整数)

  # 注:同 incrby

incrbyfloat(self, name, amount
=1.0)
# 自增 name 对应的值,当 name 不存在时,则创建 name=amount,否则,则自增。
  #
参数:
# name,Redis 的 name
# amount, 自增数(浮点型)

decr(self, name, amount
=1)
# 自减 name 对应的值,当 name 不存在时,则创建 name=amount,否则,则自减。
  #
参数:
# name,Redis 的 name
# amount, 自减数(整数)

append(key, value)
# 在 redis name 对应的值后面追加内容
  #
参数:
key, redis 的 name
value, 要追加的字符串

 

2. Hash操作

hash 表现形式上有些像 pyhton 中的 dict, 可以存储一组关联性较强的数据 , redis 中 Hash 在内存中的存储格式如下图:  

hset(name, key, value)
  # name 对应的 hash 中设置一个键值对(不存在,则创建;否则,修改), 注意: 在 python 中,键值对是 dict, 这里的 name 必须是 dict 格式。eg:xxx[]、 xxx[k]...     
  # 参数:
        # name,redis 的 name
        #key,name 对应的 hash 中的 key
        # value,name 对应的 hash 中的 value
  # 注:
        # hsetnx(name, key, value), 当 name 对应的 hash 中不存在当前 key 时则创建(相当于添加)

hmset(name, mapping)
  # 在 name 对应的 hash 中批量设置键值对 
  # 参数:
        # name,redis 的 name
        # mapping,字典,如:{'k1':'v1', 'k2': 'v2'}
  # 如:
        # r.hmset('xx', {'k1':'v1', 'k2': 'v2'})

hget(name,key)
  # 在 name 对应的 hash 中获取根据 key 获取 value

hmget(name, keys, *args)
  # 在 name 对应的 hash 中获取多个 key 的值
  # 参数:
        # name,reids 对应的 name
        # keys,要获取 key 集合,如:['k1', 'k2', 'k3']
        # *args,要获取的 key,如:k1,k2,k3
  # 如:
        # r.mget('xx', ['k1', 'k2'])
        #
        # print r.hmget('xx', 'k1', 'k2')

hgetall(name)
  #获取 name 对应 hash 的所有键值

hlen(name)
  # 获取 name 对应的 hash 中键值对的个数

hkeys(name)
  # 获取 name 对应的 hash 中所有的 key 的值

hvals(name)
  # 获取 name 对应的 hash 中所有的 value 的值

hexists(name, key)
  # 检查 name 对应的 hash 是否存在当前传入的 key

hdel(name,*keys)
  # 将 name 对应的 hash 中指定 key 的键值对删除

hincrby(name, key, amount=1)
  # 自增 name 对应的 hash 中的指定 key 的值,不存在则创建 key=amount
  # 参数:
        # name,redis 中的 name
           # key, hash 对应的 key
        # amount,自增数(整数)

hincrbyfloat(name, key, amount=1.0)
  # 自增 name 对应的 hash 中的指定 key 的值,不存在则创建 key=amount
  # 参数:
        # name,redis 中的 name
        # key, hash 对应的 key
        # amount,自增数(浮点数)
  # 自增 name 对应的 hash 中的指定 key 的值,不存在则创建 key=amount

hscan(name, cursor=0, match=None, count=None)
  Start a full hash scan with:
  HSCAN myhash 0
  Start a hash scan with fields matching a pattern with:
  HSCAN myhash 0 MATCH order_*
  Start a hash scan with fields matching a pattern and forcing the scan command to do more scanning with:
  HSCAN myhash 0 MATCH order_* COUNT 1000
  # 增量式迭代获取,对于数据大的数据非常有用,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)
        # ...
        # 直到返回值 cursor 的值为 0 时,表示数据已经通过分片获取完毕
 
hscan_iter(name, match=None, count=None)
  # 利用 yield 封装 hscan 创建生成器,实现分批去 redis 中获取数据     
  # 参数:
        # match,匹配指定 key,默认 None 表示所有的 key
        # count,每次分片最少获取个数,默认 None 表示采用 Redis 的默认分片个数
  # 如:
        # for item in r.hscan_iter('xx'):
        # print item
 

 

3. list

List 操作,redis 中的 List 在在内存中按照一个 name 对应一个 List 来存储。如图:  

lpush(name,values)
  # 在 name 对应的 list 中添加元素,每个新的元素都添加到列表的最左边
  # 如:
        # r.lpush('oo', 11,22,33)
        # 保存顺序为: 33,22,11
  # 扩展:
        # rpush(name, values) 表示从右向左操作

lpushx(name,value)
  # 在 name 对应的 list 中添加元素,只有 name 已经存在时,值添加到列表的最左边
  # 更多: # rpushx(name, value) 表示从右向左操作 llen(name)   # name 对应的 list 元素的个数 linsert(name, where, refvalue, value))   # 在 name 对应的列表的某一个值前或后插入一个新值   # 参数: # name,redis 的 name # where,BEFORE 或 AFTER # refvalue,标杆值,即:在它前后插入数据 # value,要插入的数据 r.lset(name, index, value)   # 对 name 对应的 list 中的某一个索引位置重新赋值   # 参数: # name,redis 的 name # index,list 的索引位置 # value,要设置的值 r.lrem(name, value, num)   # 在 name 对应的 list 中删除指定的值   # 参数: # name,redis 的 name # value,要删除的值 # num,num=0,删除列表中所有的指定值; # num=2, 从前到后,删除 2 个; # num=-2, 从后向前,删除 2 个 lpop(name)   # 在 name 对应的列表的左侧获取第一个元素并在列表中移除,返回值则是第一个元素   # 更多: # rpop(name) 表示从右向左操作 lindex(name, index)   #在 name 对应的列表中根据索引获取列表元素 lrange(name, start, end)   # 在 name 对应的列表分片获取数据   # 参数: # name,redis 的 name # start,索引的起始位置 # end,索引结束位置 ltrim(name, start, end)   # 在 name 对应的列表中移除没有在 start-end 索引之间的值   # 参数: # name,redis 的 name # start,索引的起始位置 # end,索引结束位置 rpoplpush(src, dst)   # 从一个列表取出最右边的元素,同时将其添加至另一个列表的最左边   # 参数: # src,要取数据的列表的 name # dst,要添加数据的列表的 name blpop(keys, timeout)   # 将多个列表排列,按照从左到右去 pop 对应列表的元素   # 参数: # keys,redis 的 name 的集合 # timeout,超时时间,当元素所有列表的元素获取完之后,阻塞等待列表内有数据的时间(秒), 0 表示永远阻塞

  # 更多:
# r.brpop(keys, timeout),从右向左获取数据

brpoplpush(src, dst, timeout
=0)
  
# 从一个列表的右侧移除一个元素并将其添加到另一个列表的左侧
  #
参数:
# src,取出并要移除元素的列表对应的 name
# dst,要插入元素的列表对应的 name
# timeout,当 src 对应的列表中没有数据时,阻塞等待其有数据的超时时间(秒),0 表示永远阻塞

 

4.set 集合操作

  Set 操作,Set 集合就是不允许重复的列表。这里包括了一般的集合和有序集合。

sadd(name,values)
  # name 对应的集合中添加元素

scard(name)
  # 获取 name 对应的集合中元素个数

sdiff(keys, *args)
  # 在第一个 name 对应的集合中且不在其他 name 对应的集合的元素集合

sdiffstore(dest, keys, args)
  
# 获取第一个 name 对应的集合中且不在其他 name 对应的集合,再将其新加入到 dest 对应的集合中

sinter(keys,
args)
  
# 获取多一个 name 对应集合的并集

sinterstore(dest, keys,
args)
  
# 获取多一个 name 对应集合的并集,再讲其加入到 dest 对应的集合中

sismember(name, value)
  
# 检查 value 是否是 name 对应的集合的成员

smembers(name)
  
# 获取 name 对应的集合的所有成员

smove(src, dst, value)
  
# 将某个成员从一个集合中移动到另外一个集合

spop(name)
  
# 从集合的右侧(尾部)移除一个成员,并将其返回

srandmember(name, numbers)
  
# 从 name 对应的集合中随机获取 numbers 个元素

srem(name, values)
  
# 在 name 对应的集合中删除某些值

sunion(keys,
args)
  
# 获取多一个 name 对应的集合的并集

sunionstore(dest,keys,
*args)
  
# 获取多一个 name 对应的集合的并集,并将结果保存到 dest 对应的集合中

sscan(name, cursor
=0, match=None, count=None)
sscan_iter(name, match
=None, count=None)
  
# 同字符串的操作,用于增量迭代分批获取元素,避免内存消耗太大


有序集合,在集合的基础上,为每元素排序;元素的排序需要根据另外一个值来进行比较,所以,对于有序集合,每一个元素有两个值,即:值和分数,分数专门用来做排序。
zadd(name, *args, **kwargs)
  # 在 name 对应的有序集合中添加元素
  # 如:
        # zadd('zz', 'n1', 1, 'n2', 2)
        #
        # zadd('zz', n1=11, n2=22)

zcard(name)
  # 获取 name 对应的有序集合元素的数量

zcount(name, min, max)
  # 获取 name 对应的有序集合中分数 在 [min,max] 之间的个数

zincrby(name, value, amount)
  # 自增 name 对应的有序集合的 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,对分数进行数据转换的函数

  # 更多:
# 从大到小排序
# zrevrange(name, start, end, withscores=False, score_cast_func=float)
# 按照分数范围获取 name 对应的有序集合的元素
# zrangebyscore(name, min, max, start=None, num=None, withscores=False, score_cast_func=float)
# 从大到小排序
# zrevrangebyscore(name, max, min, start=None, num=None, withscores=False, score_cast_func=float)

zrank(name, value)
  
# 获取某个值在 name 对应的有序集合中的排行(从 0 开始)
  # 更多:
# zrevrank(name, value),从大到小排序

zrem(name, values)
  
# 删除 name 对应的有序集合中值是 values 的成员
  # 如:zrem('zz', ['s1', 's2'])

zremrangebyrank(name, min, max)
  
# 根据排行范围删除

zremrangebyscore(name, min, max)
  
# 根据分数范围删除

zscore(name, value)
  
# 获取 name 对应有序集合中 value 对应的分数

zinterstore(dest, keys, aggregate
=None)
  
# 获取两个有序集合的交集,如果遇到相同值不同分数,则按照 aggregate 进行操作
  # aggregate 的值为: SUM MIN MAX
  
zunionstore(dest, keys, aggregate
=None)
  
# 获取两个有序集合的并集,如果遇到相同值不同分数,则按照 aggregate 进行操作
  # aggregate 的值为: SUM MIN MAX

zscan(name, cursor
=0, match=None, count=None, score_cast_func=float)
zscan_iter(name, match
=None, count=None,score_cast_func=float)
  
# 同字符串相似,相较于字符串新增 score_cast_func,用来对分数进行操作

 

5、其他常用操作

 

delete(*names)
  # 根据删除 redis 中的任意数据类型

exists(name)
  # 检测 redis 的 name 是否存在

keys(pattern='*')
  # 根据模型获取 redis 的 name
  # 更多:
        # KEYS * 匹配数据库中所有 key 。
        # KEYS h?llo 匹配 hello , hallo 和 hxllo 等。
        # KEYS h*llo 匹配 hllo 和 heeeeello 等。
        # KEYS h[ae]llo 匹配 hello 和 hallo ,但不匹配 hillo

expire(name ,time)
  # 为某个 redis 的某个 name 设置超时时间

rename(src, dst)
  # 对 redis 中 src 的 name 重命名为 dst

move(name, db))
  # 将 redis 的某个值移动到指定的 db 下

randomkey()
  # 随机获取一个 redis 的 name(不删除)

type(name)
  # 获取 name 对应值的类型

scan(cursor=0, match=None, count=None)
scan_iter(match=None, count=None)
  # 同字符串操作,用于增量迭代获取 key

 

三、管道

  redis-py 默认在执行每次请求都会创建(连接池申请连接)和断开(归还连接池)一次连接操作,如果想要在一次请求中指定多个命令,则可以使用 pipline 实现一次请求指定多个命令,并且默认情况下一次 pipline 是原子性操作。

 1 #!/usr/bin/env python
 2 # -*- coding:utf-8 -*-
 3 
 4 import redis
 5  
 6 pool = redis.ConnectionPool(host='192.168.22.132', port=6379)
 7 r = redis.Redis(connection_pool=pool)
 8 
 9 # pipe = r.pipeline(transaction=False)
10 pipe = r.pipeline(transaction=True)
11 
12 pipe.set('name', 'root')
13 pipe.set('role', 'root')
14 
15 pipe.execute()

 

四、发布与订阅

发布者:服务器

订阅者:Dashboad 和数据处理

redis_helper:

 1 #!/usr/bin/env python
 2 # -*- coding:utf8 -*-
 3 
 4 import redis
 5 
 6 class RedisHelper(object):
 7 
 8     def __init__(self):
 9         self.__conn = redis.Redis(host='localhost')   #连接本机,ip 不用写
10         self.chan_sub = 'fm104.5'
11         self.chan_pub = 'fm86'  #这个频道没用到啊...
12 
13     def public(self,msg):
14         self.__conn.publish(self.chan_sub,msg)
15         return True
16 
17     def subscribe(self):
18         pub = self.__conn.pubsub()
19         pub.subscribe(self.chan_sub)  #订阅的频道
20         pub.parse_response()  #准备好监听 (再调用一次就是开始监听)
21         return pub

redis 订阅:

 1 #!/usr/bin/env python
 2 # -*- coding:utf8 -*-
 3 
 4 from redis_helper import RedisHelper
 5 
 6 obj = RedisHelper()
 7 redis_sub = obj.subscribe()
 8 
 9 while True:
10     msg = redis_sub.parse_response()
11     print(msg)   #[b'message', b'fm104.5', b'who are you?']
12     # print(msg[2].decode('utf8'))

redis 发布:

 1 #!/usr/bin/env python
 2 # -*- coding:utf8 -*-
 3 
 4 '''
 5 发布与订阅是不同于存值取值,存值取值不需要同步,发布与订阅是需要同步的
 6 '''
 7 '''
 8 #这样是可以的,为了配套,使用下面的
 9 import redis
10 
11 obj = redis.Redis(password='helloworld')
12 obj.publish('fm104.5','hello')
13 
14 '''
15 
16 from redis_helper import RedisHelper
17 
18 obj = RedisHelper()
19 obj.public('hello')