Redis（十七）：客户端

客户端

Redis服务器是典型的一对多服务器程序，即一个服务器可以与多个客户端建立网络连接，每个客户端都可以向服务器发送命令请求，而服务器则接收并处理客户端发送的命令请求，并向客户端返回命令回复。

这个过程是通过IO多路复用技术配合上文件事件处理器来实现的（Reactor模式），Redis使用单线程单进程的方式去处理命令请求，并与多个客户端进行网络通信。

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

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

而RedisServer(服务器状态)会对产生的RedisClient（客户端状态）进行存储，使用的是一个链表，该属性名为clients，这个链表保存了所有与服务器连接的客户端的状态结构，可以对客户端进行批量操作，或者找到某个指定的客户端，这些操作都是可以通过遍历clients链表来实现的。

客户端状态属性

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

• 一类是通用属性，即很少会与特定功能相关，无论客户端要执行什么操作，都要用到这些属性
• 另一类是与特定功能相关的属性，只有在执行特殊命令时候才会用到

套接字描述符

客户端状态拥有一个名为fd的属性，该属性记录了客户端正在使用的套接字描述符

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

根据客户端类型的不同，fd属性也会进行改变，fd属性可以为-1或者是大于-1的整数

• 伪客户端（前面持久化提到过，AOF持久化是执行命令的，所以必须在客户端上面才可以执行命令，所以需要初始化一个伪客户端）：伪客户端的fd属性的值为-1，伪客户端处理的命令请求来源于AOF文件或者Lua脚本，而不是网络通信，所以这种客户端是不需要进行套接字连接的，自然也就不需要套接字描述符。
• 普通客户端的fd属性的值为大于-1的整数，普通用户端需要使用套接字来与服务器进行通信。

可以通过以下命令查看Redis的用户连接

client list

名字

一般情况下，连接Redis的用户端都是没有名字的。

可以看到name属性一般都为空，用户端可以通过以下命令进行设置自己的名字

client setname haha

客户端的名字是记录在RedisClient里的（即name属性）

typedef struct redisClient(
	//...
    robj *name;
    //...
)redisClient;

name指向的是一个字符串对象，如果没有设置就会为NULL

标志

客户端的标志属性flags记录了客户端的角色，以及客户端目前所处的状态，可以看到上面栗子的flags=N

输入缓冲区

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

struct redisClient(
	//...
    robj *name;
    int flags;
    sds querybuf;
)redisClient;

输入缓冲区的大小会根据内容动态地缩小或者扩大，但它的最大大小不可以超过1GB，否则服务器会关闭客户端

命令与命令参数

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

typedef struct redisClient(
	//...
    robj *name;
    int flags;
    sds querybuf;
    robj **argv;
    int argc;
)redisClient;

argv是一个数组，数组中的每一个项都是一个字符串对象，但argv[0]则是要执行的命令，而之后的其他项则是传给命令的参数

argc则是用来记录argv数组的长度。

举个栗子

set key value;

此时的argc的值为3

命令的实现函数

到这一步，服务器会根据协议内容中分析得出argv属性和argc属性，然后根据argv[0]的值，在命令表中查找对应的命令实现函数。

命令表也是一个字典，字典的建是一个SDS对象，保存了命令的名字，字典的值则是命令所对应的redisCommand结构，这个结构保存了命令的实现函数、命令的标志、命令应该给定的参数个数、命令的总执行次数和总消耗时长等统计信息。

当服务器找到对应的redisCommand结构后，会将客户端状态的cmd指针指向该结构

typedef struct redisClient(
	//...
    robj *name;
    int flags;
    sds querybuf;
    robj **argv;
    int argc;
    struct redisCommand *cmd
)redisClient;

之后服务器就可以根据客户端状态（套接字）的cmd指针，以及argv里面保存的参数，去调用对应的redisCommand，执行指定的命令。

输出缓冲区

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

• 固定大小的缓冲区可以去保存那些长度比较小的回复，比如OK、简单的字符串值、整数值、错误回复等等
• 可变大小的缓冲区用于保存那些长度比较长的回复，比如包含了很多键值对的有序集合，哈希键，或者列表

客户端的固定大小的缓冲池为buf和bufpos组成

• buf是一个大小为REDIS_REPLY_CHUNK_BYTES的数组，大小是固定的，默认为16KB
• bufpos记录了buf数组目前已经使用了的字节量

当buf数组的空间用完后，服务器就会开始使用可变大缓冲区，可变大缓冲区由reply链表组成，使用链表来连接多个字符串对象，可以让客户端保存非常长的命令回复。

typedef struct redisClient(
	//...
    robj *name;
    int flags;
    sds querybuf;
    robj **argv;
    int argc;
    struct redisCommand *cmd;
    //输出缓冲区
    char buf[REDIS_REPLY_CHUNK_BYTES];
    int bufpos;
    list *reply
    //...
)redisClient;

身份验证

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

typedef struct redisClient(
	//...
    robj *name;
    int flags;
    sds querybuf;
    robj **argv;
    int argc;
    struct redisComment *cmd;
    char buf[REDIS_REPLY_CHUNK_BYTES];
    int bufpos;
    list *reply;
    //身份验证属性
    int authenticated;
)redisClient;

如果authenticated的值为0，代表该用户端未进行身份验证，如果authenticated为1，则代表该用户已经通过了身份验证。

使用AUTH命令进行验证

auth password

时间

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

• ctime属性记录了创建客户端的时间，这个时间可以用来计算客户端与服务器已经连接了多少秒，对应的是查看客户端连接的age属性
• lastinterraction属性记录了客户端与服务器最后一次进行互动的时间，即离最后一次执行命令又过了过久，对应的是查看客户端的idle属性（空转时间）
• 还有一个obuf_soft_limit_reached_time属性记录了输出缓冲区第一次到达软性限制的时间

所以完整的客户端架构为如下

typedef redisClient(
	//套接字描述符
    int fd;
    //名字
    robj *name;
    //标志（角色和状态）
    int flags;
    //输入缓冲区
    sds querybuf;
    //输入命令和参数
    robj **argv;
    //argv数组长度
    int argc;
    //固定输出缓冲区
    char buf[REDIS_REPLY_CHUNK_BYTES]
    //固定输出缓冲区已经使用了多少字节
    int bufpos
    //不固定输出缓冲区
    list *reply;
    //身份验证
    int authenticated
    //时间
    time_t ctime;
    time_t lastinteraction;
    time_t obuf_soft_limit_reached_time;
)redisClient;

客户端的创建与关闭

创建普通的客户端

客户端是通过网络连接与服务器进行连接的普通用户客户端，则会连接到连接套接字，产生READABLE事件，然后交由连接事件处理器去处理，为客户端创建相应的客户端状态（redisClient），并且将这个客户端状态加入到服务器的clients链表的末尾，并且生成新的客户端套接字（以后该客户端都是通过该套接访问Redis）

关闭普通客户端

• 客户端进程退出或者被杀死，客户端与服务器之间网络连接断开
• 客户端向服务器发送了带有不符合协议格式的命令请求
• 客户端成为了CLIENT KILL命令的目标
• 服务器设置了time out选项，当客户端空转时间超过了time out选项就会关闭
• 客户端发送的命令请求的大小超过了输入缓冲区的大小限制，默认1GB
• 服务器端发送的回复超过了输出缓冲区的大小限制，会分为以下两种情况
  • 硬性限制：关闭客户端
  • 软性限制：服务器使用obuf_soft_limit_reached_time属性记录下客户端到达软性限制的起时时间，之后服务器会继续监控该客户端，如果输入缓冲区一直都是超出软性限制的，并且超过了服务器规定的时间，那么服务器就会断开与该客户端连接，如果在指定时间内，不再超出软性限制，就不会关闭，并且obuf_soft_limit_reached_time会被清零

Lub脚本的伪客户端

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

struct redisServer(
	//...
    redisClient *lua_client;
    //...
);

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

AOF文件的伪客户端

当开启Redis时，会从AOF文件中进行读取命令来恢复数据库，此时会初始化一个AOF文件的伪客户端，当恢复完毕后，该客户端就会被关闭