目录

• 1、Redis API
• 2、String 操作
• 3、Hash 操作
• 4、List 操作
• 5、Set 操作

1、Redis API

1.安装redis模块

$ pip3.8 install redis

2.使用redis模块

import redis

# 连接redis的ip地址/主机名，port，password=None
r = redis.Redis(host="127.0.0.1",port=6379,password="gs123456")

3.redis连接池
redis-py使用connection pool来管理对一个redis server的所有连接，避免每次建立、释放连接的开销。默认，每个Redis实例都会维护一个自己的连接池。可以直接建立一个连接池，然后作为参数Redis，这样就可以实现多个Redis实例共享一个连接池。

总之，当程序创建数据源实例时，系统会一次性创建多个数据库连接，并把这些数据库连接保存在连接池中，当程序需要进行数据库访问时，无需重新新建数据库连接，而是从连接池中取出一个空闲的数据库连接

import redis
# 创建连接池，将连接保存在连接池中
pool = redis.ConnectionPool(host="127.0.0.1",port=6379,password="gs123456",max_connections=10)

# 创建一个redis实例，并使用连接池"pool"
r = redis.Redis(connection_pool=pool)

2、String 操作

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

1. set 为name设置值

# 在Redis中设置值，默认，不存在则创建，存在则修改
set(name, value, ex=None, px=None, nx=False, xx=False, keepttl=False)

name：设置键
value：设置值
ex：设置过期时间（秒级）
px：设置过期时间（毫秒）
nx：如果设置为True，则只有name不存在时，当前set操作才执行,同setnx(name, value)
xx：如果设置为True，则只有name存在时，当前set操作才执行

set用法：

r.set("name1","jack",ex=3600)
r.set("name2","xander",xx=36000)

setnx用法：

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

setex用法：

# 设置值,参数：time -->过期时间（数字秒 或 timedelta对象）
setex(name, value, time)

psetex用法：

# 设置值,参数：time_ms，过期时间（数字毫秒 或 timedelta对象）
psetex(name, time_ms, value)

2. get 获取name的值

# 根据key获取值
get(name)

r.get("foo")

3. mset 批量设置name的值：

mset(mapping)

data = {
    "k1":"v1",
    "k2":"v2",
}
r.mset(data)

4. Mget 批量获取name的值

# 批量获取值，根据多key获取多个值
mgets(mapping)

# 方法一
r.mget("k1","k2")

# 方法二
data = ["k1","k2"]
r.mget(data)

# 方法三
data = ("k1","k2")
r.mget(data)

5. getset 设置新值并获取原来的值

getset(name, value)

r.set("foo", "xoo")
ret = r.getset("foo", "yoo")
print(ret) # b'xoo'

6. append 为name原有值后追加内容

# key对应值的后面追加内容
append(key, value)

r.set("name","jack")
r.append("name","-m")
ret = r.get("name")
print(ret) # b'jack-m'

7. strlen 返回name的值字节长度：

# 返回字符串的长度，当name不存在时返回0
strlen(name)

r.set("name","jack-")
ret = r.strlen("name")
print(ret) # 5

8. incr 为name整数累加值

# 自增mount对应的值，当mount不存在时，则创建mount＝amount，否则，则自增,amount为自增数(整数)
incr(name, amount=1)

r.incr('mount')
r.incr('mount')
r.incr('mount', amount=3)
ret = r.get('mount')
print(ret)		# b'5'

3、Hash 操作

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

1. hset 为name设置单个键值对

# name对应的hash中设置一个键值对（不存在，则创建；否则，修改）
hset(name, key, value)

name：设置name
key：name对应hash中的key（键）
value：name对应的hash中的value（值）

hset用法

# 一次只能设置一个键值对
r.hset("student-jack", "name", "Jack")

2 . hget 获取name单个键值对

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

ret = r.hget("student-jack", "name")
print(ret) // b'Jack'

3. hmset 为name设置多个键值对

# mapping中传入字典（不存在，则创建；否则，修改)
hmset(name, mapping):


data = {
    "name": "Jack",
    "age": 20,
    "gender": "M",
}
r.hmset("student-jack", mapping=data)

4. hmget 获取name多个键值对

# 根据name对应的hash中获取多个key的值
hmget(name, keys, *args)

name：指定name
keys：要获取key集合，如：['k1', 'k2', 'k3']
*args：要获取的key，如：k1,k2,k3


# 直接传入需要获取的键
ret = r.hmget("student-jack", "name", "age")
print(ret)  # [b'Jack', b'20']

# 列表中指定需要获取的键
data = ["name", "age"]
ret = r.hmget("student-jack", data)
print(ret)  # [b'Jack', b'20']

5. hgetall 获取name的键值对

# 根据name获取hash的所有值
hgetall(name)

ret = r.hgetall("student-jack")
print(ret)   # {b'name': b'Jack', b'age': b'20', b'gender': b'M'}

6、hlen 获取name中的键值对个数

# 根据name获取hash中键值对的总个数
hlen(name)

ret = r.hlen("student-jack")
print(ret) # 3  ， 3个键值对

7. hkeys 获取name中键值对所有key

# 获取name里键值对的key
hkeys(name)

ret = r.hkeys('student-jack')
print(ret)  # [b'name', b'age', b'gender']

8. hvals 获取name中键值对所有value

# 获取name里键值对的value
hvals(name)

ret = r.hvals('student-jack')
print(ret)  # [b'Jack', b'20', b'M']

9. hkeys 检查name里的键值对是否有对应的key

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

# 返回布尔值
ret = r.hexists('student-jack', 'name')
print(ret)	# True

10. hincrby 从name里的键值对设置自增值

1.整数自增：

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

name：设置键
key：hash对应的key
amount：自增数（整数）


ret = r.hincrby('student-jack', 'age')
ret = r.hincrby('student-jack', 'age')
print(ret)		# 22

2.浮点自增

# 自增name对应的hash中的指定key的值，不存在则创建key=amount
hincrbyfloat(name, key, amount=1.0)

name：设置键
key：hash对应的key
amount：自增数（浮点数）

11. hdel 根据name从键值对中删除指定key

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


r.hdel("info",*("m-k1","m-k2"))

4、List 操作

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

1. lpush 为name添加元素，每个新的元素都添加到列表的最左边

# name对应的list中添加元素
lpush(name,values)


# 直接指定多个元素
r.lpush("names", "Jack", "Alex", "Eric")

# 将需要添加的元素添加到元组
data = ("Jack", "Alex", "Eric")
r.rpush("names", *data)

# 将需要添加的元素添加到列表
data = ["Jack", "Alex", "Eric"]
r.rpush("names", *data)

Note：列表类型中的值统称元素

2. rpush 为name添加元素，每个新的元素都添加到列表的最右边

# 同lpush，但每个新的元素都会添加到列表的最右边
rpush(name, values) 

3. lpushx 为name添加元素，只有当name已存在时，将元素添加至列表最左边

lpushx(name,value)

4. rpushx 同上，将元素添加至列表最右边

rpushx(name, values) 

5. llen 统计name中list的元素个数

# name对应的list元素的个数
llen(name)

ret = r.llen('names')
print(ret) # 3， 该list中有3个元素

6. linsert 为name中list的某一个值或后 插入一个新的值

# 在name对应的列表的某一个值前或后插入一个新值
linsert(name, where, refvalue, value)

name：设置name
where：BEFORE或AFTER
refvalue：标杆值，即：在它前后插入数据
value：要插入的数据


// 在Alex值前插入一个值（BEFORE表示：在...之前）
r.linsert('names', 'BEFORE', 'Jack', 'Jason')

// 在Jack后插入一个值（AFTER表示：在...之后）
r.linsert('names', 'AFTER', 'Jack', 'Xander')

7. lset 为name中list的某一个索引位置的元素重新赋值

# 对name对应的list中的某一个索引位置重新赋值
lset(name, index, value)

name：设置name
index：list的索引位置
value：要设置的值

// 将索引为1的元素修改为Gigi
r.lset('names', 1, 'Gigi')

8. lrem 移除name里对应list的元素

# 在name对应的list中删除指定的值
lrem(name, count, value)

name：设置name
value：要删除的值
count：count=0，删除列表中的指定值；
       count=2,从前到后，删除2个；
       count=-2,从后向前，删除2个

r.lrem('names', count=2, value='Xander')

9. lpop 从name里的list获取最左侧的第一个元素，并在列表中移除，返回值是则是第一个元素

lpop(name)

ret = r.lpop('names')
print(ret)		# b'Jason'

10. rpop 同上，从右侧获取第一个元素

rpop(name)

11. lindex 在name对应的列表 根据索引获取元素

# 在name对应的列表中根据索引获取列表元素
lindex(name, index)

ret = r.lindex('names', 0)
print(ret)	# b'Gigi'

12. ltrim 移除列表内没有在该索引之内的值（截断）

# 移除列表内没有在该索引之内的值
ltrim(name, start, end)

r.ltrim("names",0,2)

13. lrange 在name对应的列表 根据索引获取数据

# 在name对应的列表分片获取数据
lrange(name, start, end)

name：设置name
start：索引的起始位置
end：索引结束位置

// 先添加点元素
data = ['Jack', 'Eric', 'Koko', 'Jason', 'Alie']
r.rpush('names', *data)

// 获取列表所有元素
ret = r.lrange('names', 0, -1)
print(ret)  # [b'Gigi', b'Alex', b'Jack', b'Eric', b'Koko', b'Jason', b'Alie']

// 获取列表索引2-5的元素（包含2和5，即 2 3 4 5）
ret = r.lrange('names', 2, 5)
print(ret)	# [b'Jack', b'Eric', b'Koko', b'Jason']

// 获取列表的最后一个元素
ret = r.lrange('names', -1, -1)
print(ret)   # [b'Alie']

5、Set 操作

Set集合操作，Set集合会将列表存在一个集合里面，该列表绝对不会出现重复的元素，集合也是无序的。如图：　

1. sadd 添加一个或多个成员元素到集合中

// 已存在于集合的元素会被忽略
sadd(name,values)

r.sadd('names', 'Jack', 'Alex')

2. scard 获取集合中元素个数

scard(name)
  
ret = r.scard('names')
print(ret)  # 2

3. sdiff 返回指定集合之间的差集

差集含义：我有的你没有

// 返回在第一个name对应的集合中且不再其它name对应集合的元素集合
sdiff(keys, *args)

// 添加两个集合
r.sadd('linux_class', 'Jack', 'Xander', 'Jason', 'Gigi', 'Koko')
r.sadd('python_class', 'Xander', 'Alex', 'Eric', 'Koko')

// 对这两个集合取差集
// linux_class 拥有的，python_class 没有
ret = r.sdiff('linux_class', 'python_class')
print(ret)  # {b'Jack', b'Gigi', b'Jason'}

// python_class 拥有的，linux_class 没有
ret = r.sdiff('python_class', 'linux_class')
print(ret)  # {b'Alex', b'Eric'}

4. sdiffstore 将集合之间的差集存储在指定集合中

// 如果指定的集合 key 已存在，则会被覆盖
sdiffstore(dest, keys, *args)

// 差集存储
r.sdiffstore('diff_class', 'linux_class', 'python_class')
ret = r.sinter('diff_class')
print(ret)    # {b'Jack', b'Jason', b'Gigi'}

5. sinter 返回指定集合之间的交集

交集含义：你有的我也有

sinter(keys, *args)

// 添加两个集合
r.sadd('linux_class', 'Jack', 'Xander', 'Jason', 'Gigi', 'Koko')
r.sadd('python_class', 'Xander', 'Alex', 'Eric', 'Koko')

// 对这两个集合取交集
// linux_class 拥有的，python_class 也有
ret = r.sinter('linux_class', 'python_class')
print(ret)  # {b'Xander', b'Koko'}

// python_class 拥有的，linux_class 也有
ret = r.sinter('python_class', 'linux_class')
print(ret)  # {b'Xander', b'Koko'}

6. sinterstore 将指定集合之间的交集存储在指定集合中

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

// 交集存储
r.sinterstore('sint_class', 'linux_class', 'python_class')
ret = r.sinter('sint_class')
print(ret)  # {b'Koko', b'Xander'}

7. sismember 检查成员元素是否在集合成员中

sismember(name, value)

ret = r.sismember('names', 'Jack')
print(ret)	# True
ret = r.sismember('names', 'Koko')
print(ret)  # False

8. smembers 返回指定集合中的所有的成员

不存在空集合的key视为空集合

smembers(name)

ret = r.smembers('python_class')
print(ret)  # {b'Xander', b'Koko', b'Alex', b'Eric'}

ret = r.smembers('linux_class')
print(ret)	# {b'Xander', b'Jason', b'Koko', b'Jack', b'Gigi'}

9. smove 将指定成员value元素从src集合移动到dst集合

smove(src, dst, value)

// 将python_class 集合的 Alex 元素移动到linux_class集合
r.smove('python_class', 'linux_class', 'Alex')

10. spop 用于移除并返回集合中的一个随机元素

spop(name, count=None)
count：指定需要返回的随机元素个数

ret = r.spop('names')

11. srandmember 返回集合中的一个随机元素

srandmember(name, number=None)
number：指定返回的随机元素个数

ret = r.srandmember('names')

Note：spop返回随机元素的时候会修改集合中的随机元素，而srandmember只会返回随机元素，不会修改集合。

12. srem 移除集合中的一个或多个成员元素

不存在的元素则直接忽略，被成功移除的元素数量不会包含被忽略的元素

srem(name, *values)

// 返回被移除元素的数量
ret = r.srem('names', 'Jack', 'Koko')

13. sunionstore 将给定集合的并集存储在指定的集合dest中

并集含义：你的所有和我的所有合并在一起，并去重

sunionstore(dest, keys, *args)

r.sunionstore('total_class', 'python_class', 'linux_class')

14. sscan 迭代集合中的元素

# 同字符串的操作，用于增量迭代分批获取元素，避免内存消耗太大
sscan(name, cursor=0, match=None, count=None)
cursor：游标，每次该命令被调用之后都会返回一个新的游标，用户下次迭代的时候需要用这个新的游标来作为sscan命令的游标参数，以此来延续之前的迭代过程。
count：增量式迭代不保证每次迭代所返回的元素数量，指定每次迭代中应该返回多少个元素
match：匹配元素，只返回该参数执行的元素

ret = r.sscan('tests', cursor=10, match='t3', count=30)
print(ret)	# (15, [b't3'])