Redis实现之客户端

客户端

Redis服务器是典型的一对多服务器程序：一个服务器可以与多个客户端建立网络连接，每个客户端可以向服务器发送命令请求，而服务器则接收并处理客户端发送的命令请求，并向客户端返回命令回复。通过使用I/O多路复用技术实现的文件事件处理器，Redis服务器使用单线程单进程的方式来处理命令请求，并与多个客户端进行网络通信

对于每个与服务器进行连接的客户端，服务器都为这些客户端建立了相应的redis.h/redisClient结构（客户端状态），这个结构保存了客户端当前的状态信息，以及执行相关功能时需要用到的数据结构，其中包括：

• 客户端的套接字描述符
• 客户端的名字
• 客户端的标志值（flag）
• 指向客户端正在使用的数据库指针，以及该数据库的号码
• 客户端当前要执行的命令、命令的参数、命令参数的个数，以及指向命令实现函数的指针
• 客户端的输入缓冲区和输出缓冲区
• 客户端的复制状态信息，以及进行复制所需的数据结构
• 客户端执行BRPOP、BLPOP等列表阻塞命令时使用的数据结构
• 客户端的事物状态，以及执行WATCH命令时用到的数据结构
• 客户端执行发布与订阅功能时用到的数据结构
• 客户端的身份验证标识
• 客户端的创建时间，客户端和服务器最后一次通信时间，以及客户端的输出华冲区大小超出软性限制的时间

Redis服务器状态结构的clients属性是一个链表，这个链表保存了所有与服务器连接的客户端的状态结构，对客户端执行批量操作，或者查找某个指定的客户端，都可以通过遍历clients链表来完成：

redis.h

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

　　

图1-1   客户端与服务器

作为例子，图1-1展示了一个与三个客户端进行连接的服务器，而图1-2则展示了这个服务器clients链表的例子

图1-2   clients链表

客户端属性

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

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

套接字描述符

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

redis.h

typedef struct redisClient {
    int fd;
    ……
} redisClient;

　　

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

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

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

127.0.0.1:6379> CLIENT list
id=3 addr=127.0.0.1:57522 fd=9 name= age=76021 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域是空白的。不过我们可以使用CLIENT SETNAME命令为客户端设置一个名字，让客户端的身份变得清晰。以下展示客户端执行CLIENT SETNAME命令之后的客户端列表

127.0.0.1:6379> CLIENT SETNAME message_quque
OK
127.0.0.1:6379> CLIENT list
id=3 addr=127.0.0.1:57522 fd=9 name=message_quque age=76399 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

　　

客户端的名字记录在客户端状态的name属性中：

redis.h

typedef struct redisClient {
    ……
    robj *name;             
    ……
} redisClient;

　　

如果客户端没有为自己设置名字，那么相应客户端状态的name属性指向NULL指针；相反地，如果客户端为自己设置了名字，那么name属性将指向一个字符串对象，而对象则存放着客户端的名字。图1-3展示了客户端状态示例，根据name属性显示，客户端名字为"message_queue"

图1-3   name属性示例

标志

客户端的标志属性flags记录了客户端的角色，以及客户端目前所处的状态

redis.h

typedef struct redisClient {
    ……
    int flags;           
    ……
} redisClient;

　　

flags属性的值可以是单个标志：flags = <flag>，也可以是多个标志的二进制：flags = <flags1> | <flags2> | ……

每个标志使用一个常量表示，一部分标志记录了客户端的角色：

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

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

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

以上提到的所有标志都定义在redis.h文件中

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

通常情况下，Redis只会将那些对数据库进行了修改的命令写入到AOF文件，并复制到各个从服务器。如果一个命令没有对数据库进行任何修改，那么它就会被认为是只读命令，这个命令不会被写入到AOF文件，也不会被复制到从服务器

以上规则适用于绝大部分Redis命令，但PUBSUB命令和SCRIPT LOAD命令是其中的例外。PUBSUB命令虽然没有修改数据库，但PUBSUB命令向频道的所有订阅者发送消息这一行为带有副作用，接收到消息的所有客户端的状态都会因为这个命令而改变。因此，服务器需要使用REDIS_FORCE_AOF标志，强制将这个命令写入AOF文件，这样在将来载入AOF文件时，服务器就可以再次执行相同的PUBSUB命令，并产生相同的副作用。SCRIPT LOAD命令的情况与PUBSUB命令类似：虽然SCRIPT LOAD命令没有修改数据库，但它修改了服务器状态，所以它是一个带有副作用的命令，服务器需要使用REDIS_FORCE_AOF标志，强制将这个命令写入AOF文件，使得将来在载入AOF文件时，服务器可以产生相同的副作用

另外，为了让主服务器和从服务器都可以正确地载入SCRIPT LOAD命令指定的脚本，服务器需要使用REDIS_FORCE_REPL标志，强制将SCRIPT LOAD命令复制给所有从服务器

以下是一些flags属性的例子

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

　　

输入缓冲区

客户端状态的输入缓冲区用于保存客户端发送的命令请求

redis.h

typedef struct redisClient {
    ……
    sds querybuf;
    ……
} redisClient;

　　

举个栗子，如果客户端向服务器发送了以下命令请求：

SET key value

　　

那么客户端状态的querybuf属性将是一个包含以下内容的SDS值：

*3
$3
SET
$3
key
$5
value

　　

图1-4展示了这个SDS值以及querybuf属性的样子

图1-4   querybuf属性示例

命令与命令参数

在服务器将客户端发送的命令请求保存到客户端状态的querybuf属性之后，服务器将对命令请求的内容进行分析，并将得出的命令参数以及命令参数的个数分别保存到客户端状态的argv属性和argc属性：

redis.h

typedef struct redisClient {
    ……
    int argc;
    robj **argv;
    ……
} redisClient;

　　

argv属性是一个数组，数组中的每个项都是一个字符串对象，其中argv[0]是要执行的命令，而之后的其他项则是传给命令的参数。argc属性负责记录argv数组的长度

举个栗子，对于图1-4所示的querybuf属性来说，服务器将分析并创建图1-5所示的argv属性和argc属性

图1-5   argv属性和argc属性示例

注意，图1-5展示的客户端状态中，argc属性的值为3，而不是2，因为命令的名字"SET"本身也是一个参数

命令的实现函数

当服务器从协议内容中分析并得出argv属性和argc属性的值之后，服务器将根据项argv[0]的值，在命令表中查找命令所对应的命令实现函数。图1-6展示了一个命令表示例，该表是一个字典，字典的键是一个SDS结构体，保存了命令的名字，字典的值是命令所对应的redisCommand结构体，这个结构体保存了命令的实现函数、命令的标志、命令应该给定的参数个数、命令的总执行次数和总消耗时长等统计信息

图1-6   命令表

当程序在命令表中成功找到argv[0]所对应的redisCommand结构体时，它会将客户端状态的cmd指针指向这个结构体：

redis.h

typedef struct redisClient {
    ……
    struct redisCommand *cmd;
    ……
} redisClient;

　　

之后，服务器就可以使用cmd属性所指向的redisCommand结构体，以及argv、argc属性中保存的命令参数信息，调用命令实现函数，执行客户端指定的命令

图1-7演示了服务器在argv[0]为"SET"时，查找命令表并将客户端状态的cmd指针指向目标redisCommand结构体的整个过程

图1-7   查找命令并设置cmd属性

针对命令表的查找操作不区分输入字母的大小写，所以无论argv[0]是"SET"、"set"或者是"SeT"等等，查找结果都是相同的

输出缓冲区

执行命令所得的命令回复会被保存在客户端状态的输出缓冲区里面，每个客户端都有两个输出缓冲区可用，一个缓冲区的大小是固定的，另一个缓冲区的大小是可变的

• 固定大小的缓冲区用于保存那些长度比较小的回复，比如OK、简短的字符串值、整数值、错误回复等等
• 可变大小的缓冲区用于保存那些长度比较大的回复，比如一个非常长的字符串值、一个由很多项组成的列表、一个包含了很多元素的集合等等

客户端的固定大小缓冲区由buf和bufpos两个属性组合：

redis.h

typedef struct redisClient {
    ……
    int bufpos;
    char buf[REDIS_REPLY_CHUNK_BYTES];
} redisClient;

　　

buf是一个大小为REDIS_REPLY_CHUNK_BYTES字节的字节数组，而bufpos属性则记录了buf数组目前已使用的字节数量。REDIS_REPLY_CHUNK_BYTES常量目前的默认值为16*1024，也即是说，buf数组的默认大小为16KB

图1-8展示了一个使用固定大小缓冲区来保存返回值+OK 的例子

图1-8   固定大小缓冲区示例

当buf数组的空间已经用完，或者回复因为太大而无法装进buf数组里面，服务器就会开始使用可变大小缓冲区。可变大小缓冲区由reply链表和一个或多个字符串对象组成：

redis.h

typedef struct redisClient {
    ……
    list *reply;
    ……
} redisClient;

　　

通过使用链表来连接多个字符串对象，服务器可以为客户端保存一个非常长的命令回复，而不必受到固定大小缓冲区16KB大小的限制。图1-9展示了一个包含三个字符串对象的reply链表

图1-9   可变大小缓冲区示例

身份验证

客户端状态的authenticated属性用于记录客户端是否通过了身份验证：

redis.h

typedef struct redisClient {
    ……
    int authenticated;      /* when requirepass is non-NULL */
    ……
} redisClient;

　　

如果authenticated的值为0，表示客户端尚未通过身份认证；如果authenticated的值为1，表示客户端已通过认认证。举个栗子，对于一个尚未进程身份认证的客户端来说，客户端状态的authenticated属性如图1-10所示

图1-10   未验证身份时的客户端状态

当客户端authenticated属性的值为0时，除了AUTH命令之外，客户端发送的所有其他命令都会被服务器拒绝执行：

127.0.0.1:6379> PING
(error) NOAUTH Authentication required.
127.0.0.1:6379> SET msg "hello world"
(error) NOAUTH Authentication required.

　　

当客户端通过AUTH命令成功进行身份验证之后，客户端状态authenticated属性的值从0变为1，如图1-11所示，这时客户端就可以像往常一样向服务器发送命令请求了： 

127.0.0.1:6379> AUTH 123456
OK
127.0.0.1:6379> PING
PONG
127.0.0.1:6379> SET msg "hello world"
OK

　　

图1-11   已经通过身份验证的客户端状态

authenticated属性仅在服务器启用了身份验证功能时使用，如果服务器没有启用身份验证功能的话，那么即使authenticated属性的值为0（默认值），服务器也不会拒绝未验证身份的客户端发送的命令请求。关于服务器身份验证的更多信息可以参考配置文件对requirepass选项的相关说明

时间

最后，客户端还有几个和时间相关的属性：

redis.h

typedef struct redisClient {
    ……
    time_t ctime;          
    time_t lastinteraction; 
    time_t obuf_soft_limit_reached_time;
    ……
} redisClient;

　　

ctime属性记录了创建客户端的时间，这个时间可以用来计算客户端与服务器已经连接了多少秒，CLIENT list命令的age域记录了这个秒数

127.0.0.1:6379> CLIENT list
…… age=87315 ……
…… age=535 ……

　　　　

lastinteraction属性记录了客户端与服务器最后一次进行互动（interaction）的时间，这里的互动可以是客户端向服务器发送命令请求，也可以是服务器向客户端发送命令回复。lastinteraction属性可以用来计算客户端的空转时间，也即是，距离客户端与服务器最后一次进行互动以来，已经过去多少秒，CLIENT list命令的idle域记录了这个秒数

127.0.0.1:6379> CLIENT list
…… idle=10916 ……
…… idle=0 ……

　　

obuf_soft_limit_reached_time属性记录了输出缓冲区第一次达到软性限制（soft time）的时间

客户端的创建与关闭

服务器使用不同的方式来创建和关闭不同类型的客户端，本节将介绍服务器创建和关闭客户端的方法

创建普通客户端

如果客户端是通过网络连接和服务器进行连接的普通客户端，那么在客户端使用connect函数连接到服务端时，服务器就会调用连接事件处理器，为客户端创建相应的客户端状态，并将这个客户端状态添加到服务器状态结构体中clients链表的末尾

举个栗子，假设当前有c1和c2两个普通客户端正在连接服务器，那么当一个新的普通客户端c3连接到服务器后，服务器会将c3所对应的客户端状态添加到clients链表的末尾，如图1-12所示，其中用虚线包围的就是服务器为c3新创建的客户端状态

图1-12   服务器状态结构体的clients链表

关闭普通客户端

一个普通客户端可以因为多种原因而被关闭：

•  如果客户端进程退出或者被杀死，那么客户端与服务器之间的网络连接将被关闭，从而造成客户端被关闭
• 如果客户端向服务器发送了带有不符合协议格式的命令请求，那么这个客户端也会被服务器关闭
• 如果客户端成为了CLIENTKILL命令的目标，那么它也会被关闭
• 如果用户为服务器设置了timeout配置选项，那么当客户端的空转时间超过timeout选项设置的值时，客户端将被关闭。不过timeout选项有一些例外情况：如果客户端是主服务器(打开了REDIS_MASTER标志)，从服务器(打开了REDIS_SLAVE标志)，正在被BLPOP等命令阻塞(打开了REDIS_BLOCKED标志)，或者正在执行SUBSCRIBE, PSUBSCRIBE等订阅命令，那么即使客户端的空转时间超过了timeout选项的值，客户端也不会被服务器关闭
• 如果客户端发送的命令请求的大小超过了输入缓冲区的限制大小(默认为1GB),那么这个客户端会被服务器关闭
• 如果要发送给客户端的命令回复的大小超过了输出缓冲区的限制大小，那么这个客户端会被服务器关闭

前面介绍输出缓冲区的时候提到过，可变大小缓冲区由一个链表和任意多个字符串对象组成，理论上来说，这个缓冲区可以保存任意长度的命令回复。但为了避免客户端回复过大，占用过多服务器资源，服务器会时刻检查客户端的输出缓冲区的大小，并在缓冲区的大小超出范围时，执行相应的限制操作。服务器使用两种模式来限制客户端输出缓冲的大小：

• 硬性限制（hard limit）：如果输出缓冲区的大小超过了硬性限制所设置的大小，那么服务器立即关闭客户端
• 软性限制（soft limit）：如果输出缓冲区的大小超过了软性限制所设置的大小，但还没有超过硬性限制，那么服务器将使用服务器状态结构的 obuf_soft_limit_reached_time 属性记录下客户端到达软性限制的起始时间，之后服务器会继续监视客户端，如果输出缓冲区的大小一直超出软性限制，并且持续时间超过服务器设定的时长，那么服务器就会关闭客户端，相反地，如果客户端在指 定时间内不再超出软性限制，那么客户端就不会被关闭，并且obuf_soft_limit_reached_time也会被清零

使用client-output-buffer-limit 可以为普通客户端、从服务器客户端、执行发布与订阅功能的客户端分别设置不同的软性限制和硬性限制，格式为：

client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>

　　

以下是三个设置示例：

client-output-buffer-limit normal 0 0 0  #不限制输出缓冲区大小
client-output-buffer-limit slave 256mb 64mb 60
client-output-buffer-limit pubsub 32mb 8mb 60 #执行发布和订阅功能的客户端硬性限制为32mb，软性限制为8mb，软性限制时长为60秒

　　

第一行设置将普通客户端的硬性限制和软性限制都设置为0，表示不限制客户端的输出缓冲区大小

第二行设置将从服务器客户端的硬性限制设置为256MB，而软性限制设置为64MB，软性限制的时长为60秒

第三行设置将执行发布与订阅功能的客户端的硬性限制设置为32MB，软性限制设置为8MB，软性限制的时长为60秒

关于client-output-buffer-limit选项的更多用法，可以参考示例配置文件redis.conf

Lua脚本的伪客户端

服务器会在初始化时创建负责执行Lua脚本中包含的Redis命令的伪客户端，并将这个伪客户端关联在服务器结构的lua_client属性中：

redis.h

struct redisServer {
    ……
    redisClient *lua_client;  
    ……
};

　　

lua_client伪客户端在服务器运行的整个生命周期中会一直存在，只有服务器被关闭时，这个客户端才会被关闭

AOF文件的伪客户端

服务器在载入AOF文件时，会创建用于执行AOF文件包含的Redis命令的伪客户端，并在载入完成之后，关闭这个伪客户端