Redis中的客户端(一)

客户端

概述

Redis服务器是典型的一对多服务器程序:一个服务器可以与多个客户端建立网络连接，每个客户端可以向服务器发送命令请求，而服务器则接收并处理客户端发送的命令请求，并向客户端返回命令回复。通过使用由IO多路复用技术实现的文件事件管理器，Redis服务器使用单线程单进程的方式来处理命令请求，并与多个客户端进行网络通信。对于每个与服务器进行连接的客户端，服务器都为这些客户端建立了相应的redis.h/redisClient结构(客户端状态)，这个结构保存了客户端当前的状态信息，以及执行相关功能时需要用到的数据结构，其中包括:

• 1.客户端的套接字描述符
• 2.客户端的名字
• 3.客户端的标志值(falg)
• 4.指向客户端正在使用的数据库的指针，以及该数据库的号码
• 5.客户端当前要执行的命令、命令的参数、命令参数的个数、以及指向命令实现函数的指针
• 6.客户端的输入缓冲区和输出缓冲区
• 7.客户端的复制状态信息，以及进行复制所需的数据结构
• 8.客户端执行BRPOP、BLPOP等列表阻塞命令时使用的数据结构
• 9.客户端的事务状态。以及执行WATCH命令时用到的数据结构
• 10.客户端执行发布与订阅功能时用到的数据结构
• 11.客户端的身份验证标志
• 12.客户端的创建事件,客户端和服务器最后一次通信的时间，以及客户端的输出缓冲区大小超出软性限制(soft limit)的时间
  Redis服务器状态结构的clients属性是一个链表，这个链表保存了所有与服务器连接的客户端的状态结构，对客户端执行批量操作，或者查找某个指定的客户端，都可以通过遍历clients链表来完成:

struct redisServer {
 // ...
 
 // 一个链表，保存了所有客户端状态
 list *clients;
 
 // ...
}

例子

• 举个例子，如图展示了一个与三个客户端进行连接的服务器
  
• 如图展示了这个服务器的clients链表的样子

客户端属性

客户端状态包含的属性可以分为两类:

• 1.一类是比较通用的属性，这些属性很少与特定功能相关，无论客户端执行的是什么工作，它们都要用到这些属性
• 2.另外一类是和特定功能相关的属性，比如操作数据库时需要用到的db属性和dictid属性，执行事务时需要用到的mstate属性，以及执行WATCH命令时需要用到的watched_keys属性等等。

套接字描述符

客户端状态的fd属性记录了客户端正在使用的套接字描述符:

typedef struct redisClient {
 // ...
 int fd;
 // ...
}redisClient;

根据客户端类型的不同，fd属性的值可以是-1或者大于-1的整数:

• 1.伪客户端(fake client)的fd属性为-1:伪客户端处理的命令请求来源于AOF文件或者Lua脚本，而不是网络，所以这种客户端不需要套接字连接，自然也不需要记录套接字描述符。目前Redis服务器会在两个地方用到伪客户端，一个用于载入AOF我呢见并还原数据库状态，而另一个则
  用于执行Lua脚本中包含的Redis命令
• 2.普通客户端的fd属性的值大于-1的整数:普通客户端使用套接字来与服务器进行通信，所以服务器会用fd属性来记录客户端套接字的描述符。因为合法的套接字描述符不能是-1，所以普通客户端的套接字描述符的值必然是大于-1的整数

执行CLIENT list命令可以列出目前所有连接到服务器的普通客户端，命令输出中的fd域显示了服务器连接客户端所使用的套接字描述符：

127.0.0.1:6379> client list
id=4 addr=127.0.0.1:61899 fd=9 name= age=27 idle=22 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=client
id=5 addr=127.0.0.1:61921 fd=10 name= age=9 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 events=r cmd=client

名字

在默认情况下，一个连接到服务器的客户端是没有名字的。
比如在下面展示的CLIENT list命令示例中，两个客户端的name域都是空白的:

127.0.0.1:6379> client list
id=4 addr=127.0.0.1:61899 fd=9 name= age=27 idle=22 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=client
id=5 addr=127.0.0.1:61921 fd=10 name= age=9 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 events=r cmd=client

使用CLIENT setname 命令可以为客户端设置一个名字，让客户端的身份变得更清晰。

127.0.0.1:6379> CLIENT setname testName1
OK

127.0.0.1:6379> client list
id=4 addr=127.0.0.1:61899 fd=9 name=testName1 age=439 idle=6 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=client
id=5 addr=127.0.0.1:61921 fd=10 name= age=421 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 events=r cmd=client

其中第一个客户端的名字设置为了testName1，第二个客户端没有进行设置。客户端的名字记录在客户端状态的name属性里面:

typedef struct redisClient {
 // ...
 robj *name;
 // ...
}redisClient

如果客户端没有为自己设置名字，那么相应客户端状态的name属性指向NULL指针，相反地，如果客户端为自己设置了名字，那么name
属性将指向一个字符串对象，而该对象就保存着客户端的名字。

例子

• 举个例子。如图展示了一个客户端状态示例，根据name属性显示，
  客户端的名字为"testName1"

标志

客户端的标志属性flags记录了客户端的角色(role),以及客户端目前所处的状态:

typedef struct redisClient {
 // ...
 int flags;
 // ...
}redisClient

flags属性的值可以是单个标志:flags = < flag >,
也可以是多个标志的二进制或，比如:flags = < flag1 > | < flag2 > | …
每个标志使用一个常量表示，一部分标志记录了客户端的角色:

• 1.在主从服务器进行复制操作时，主服务器会称为从服务器的客户端，而从服务器也会成为主服务器的客户端。REDIS_MASTER标志表示客户端代表的是一个主服务器，REDIS_SLAVE标志客户端代表的是一个从服务器。
• 2.REDIS_PRE_PSYNC标志表示kk而护短代表的是一个版本低于Redis2.8的从服务器，主服务器不能使用PYSNC命令与这个从服务器进行同步，这个标志只能在REDIS_SLAVE标志处于打开状态时使用
• 3.REDIS_LUA_CLIENT标识表示客户端是专门用于处理Lua脚本里面包含的Redis的伪客户端。

而另一部分标志则记录了客户端目前所处的状态:

• 1.REDIS_MONITOR标志表示客户端正在执行MONITOR命令
• 2.REDIS_UNIX_SOCKET标志表示服务器使用UNIX套接字来连接客户端
• 3.REDIS_BLOCKED标志表示客户端正在被BRPOP、BLPOP等命令阻塞
• 4.REDIS_UNBLOCKED标志表示客户端已经从REDIS_BLOCKED标志所表示的阻塞状态中脱离出来，不再阻塞。REDIS_UNBLOCKED标志只能在REDIS_BLOCKED标志已经打开的情况下使用
• 5.REDIS_MULTI标志表示客户端正在执行事务
• 6.REDIS_DIRTY_CAS标志表示事务使用WATCH命令监视的数据库键已经被修改了
• 7.REDIS_DIRTY_EXEC标志表示事务在命令入队时出现了错误，以上两个标志都表示事务的安全性已经被破坏，只要这两个标记中的任意一个被打开，EXEC命令必然会执行失败。这两个标志只能在客户端打开了REDIS_MULTI标志的情况下使用
• 8.REDIS_CLOSE_ASAP标志表示客户端的输出缓冲区大小超出了服务器允许的范围，服务器会在下一次执行serverCron函数时关闭这个客户端，以免服务器的稳定性受到这个客户端影响。积存在输出缓冲区中的所有内容会直接被释放，不会返回给客户端。
• 9.REDIS_CLOSE_AFTER_REPLY标志表示有用户对这个客户端执行了CLIENT KILL命令，或者客户端发送给服务器的命令请求中包含了错误的协议内容。服务器会将客户端积存z在输出缓冲区中的所有内容发送给客户端，然后关闭客户端
• 10.REDIS_FORCE_AOF标志强制服务器将当前执行的命令写入到AOF文件里面，REDIS_FORCE_REPL标志强制主服务器将当前执行的命令复制给所有从服务器。执行PUBSUB命令会使客户端打开REDIS_FORCE_AOF标志，执行SCRIPT LOAD命令会使客户端打开REDIS_FORCE_AOF标志和REDIS_FORCE_REPL标志
• 11.在主从服务器进行命令传播期间，从服务器需要向主服务器发送REPLICATION ACK命令，在发送这个命令之前，从服务器必须打开主服务器对应的客户端的REDIS_MASTER_FORCE_REPLY标志，否则发送操作会被拒绝执行

PUBSUB命令和SCRIPT LOAD命令的特殊性

通常情况下，Redis只会将那些对数据库进行了修改的命令写入到AOF文件，并复制到各个从服务器。如果一个命令没有对数据库j进行任何修改，那么它就会被认为是只读命令，这个命令不会被写入到AOF
文件，也不会被复制到从服务器。以上规则适用于绝大部分Redis命令，但PUBSUB命令和SCRIPT LOAD命令是其中的例外。PUBSUB命令虽然没有修改数据库，但PUBSUB命令向频道的所有订阅者发送消息
这一行为带有副作用，接收到消息的所有客户端的状态都会因为这个命令而改变。因此，服务器需要使用REDIS_FORCE_AOF标志，强制将这个命令写入AOF文件，这样在将来载入AOF文件时，服务器就可以再次
执行相同的PUBSUB命令，并产生相同的副作用。SCIRPT LOAD命令的情况与PUBSUB命令类似:虽然SCRIPT LOAD命令没有修改数据库，但它修改了服务器状态，所以它是一个带有副作用的命令，服务器
需要使用REDIS_FORCE_AOF标志，强制将这个命令写入AOF文件，使得将来在载入AOF文件时，服务器可以产生相同的副作用。另外，为了让主服务器和从服务器都可以正确地载入SCRIPT LOAD命令指定的脚本，
服务器需要使用REDIS_FORCE_REPL标志，强制将SCIRPT LOAD命令复制给所有从服务器

例子

• 举个flags属性的例子:

# 客户端是一个主服务器
REDIS_MASTER
# 客户端正在被列表命令阻塞
REDIS_BLOCKED
# 客户端正在执行事务，但事务的安全性已被破坏
REDIS_MULTI | REDIS_DIRTY_CAS
# 客户端是一个从服务器，并且版本低于Redis2.8
REDIS_SLAVE | REDIS_PRE_PSYNC
# 这是专门用于执行Lua脚本包含的Redis命令的伪客户端
# 它强制服务器将当前的命令写入AOF文件，并复制给从服务器
REDIS_LUA_CLIENT | REDIS_FORCE_AOF | REDIS_FORCE_REPL