Redis设计 - 客户端

一、客户端概述

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

客户端套接字描述符
客户端名字
客户端标志值
客户端使用的数据库指针（Redis有多个数据库，默认使用下标0号数据库）
客户端当前正要执行的命令，参数，实现函数的指针等待。
客户端的输入缓冲区、输出缓冲区
客户端复制状态信息、以及复制需要用到的数据结构
客户端执行BRPOP,BLPOP等列表阻塞命令时使用的数据结构
客户端的事务状态，以及执行watch命令时用到的数据结构
客户端执行发布订阅功能用到的数据结构
客户端身份验证标识
客户端的创建时间，最后一次通信时间，客户端输出缓冲区超出软性（soft limit）限制的时间

Redis服务器用链表（clients）保存了所有与服务器连接的客户端

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

客户端链表

二、客户端属性

1. 套接字描述符

typedef struct redisClient {
    // 套接字描述符
    int fd;

} redisClient;

客户端状态（redisClient）的 fd 属性（int类型）记录了客户端正在使用的套接字描述符。根据客户端类型不同，fd属性可以是-1或者是大于-1的整数：

伪客户端的fd属性值为-1：伪客户端处理的命令请求来自AOF文件或者Lua脚本，而不是网络。目前Redis服务器两个地方用到伪客户端：1）载入AOF文件并还原数据库状态，2）执行Lua脚本中包含的Redis命令。
普通客户端的fd属性值大于1：因为普通客户端需要使用套接字来与服务器进行通信。

2. 名字

typedef struct redisClient {
    // 名字
    robj *name;

} redisClient;

默认情况下，连接到服务器的客户端都是没有名字的，但是可以通过CLIENT setname命令为客户端设置名字，如果设置了名字，那么保存名字的属性 name 就会指向一个字符串对象，否则为NULL。

3. 标志

typedef struct redisClient {
    // 标志
    int flags;

} redisClient;

客户端的标志属性flags记录了客户端的角色（role），以及目前客户端所处的状态。
flags的值可以是单个：flags = <flag>，也可以是多个标志的二进制组合： flags = <flag1> | <flag2>。

每个标志使用一个常量表示：

在利用 Redis 主从服务器实现复制时，主从服务器会相互成为对方的客户端，也就是从服务器是主服务器的客户端，同时主服务器也是从服务器的客户端。Redis 使用REDIS_MASTER 标志来表示这个客户端是主服务器，而使用 REDIS_SLAVE 标志来表示另一个客户端是从服务器。
Redis 使用 REDIS_LUA_CLIENT 标志来表示该客户端是一个专门用于处理 Lua 脚本的伪客户端，它主要用于执行 Lua 脚本中包含的 Redis 命令。
Redis 使用 REDIS_PRE_PSYNC 标志来表示该客户端是一个低于 Redis 2.8 版本的从服务器，此时，对应的主服务器不能使用 PSYNC 命令实现与从服务器的数据同步。只有当 REDIS_SLAVE 标志处于打开状态时，才能使用 REDIS_PRE_PSYNC 标志。

记录客户端当前状态的标志有如下几个。

REDIS_ASKING 标志表示客户端向运行在集群模式下的服务器节点发送了 ASKING 命令。
REDIS_CLOSE_ASAP 标志表示客户端的输出缓冲区过大，超出了服务器所允许的范围。当服务器在下一次执行 serverCron 函数时，会关闭这个输出缓冲区过大的客户端，以此来保证服务器的稳定性不受这个客户端影响。在关闭的时候，存储在这个缓冲区中的数据也会被删除，并且不会给客户端返回任何信息。
REDIS_CLOSE_AFTER_REPLY 标志表示客户端给服务器发送的命令请求中有错误的协议内容，或者用户在客户端中执行了 CLIENT kill 命令。此时服务器会将客户端输出缓冲区中存储的所有数据内容发送给客户端，然后关闭这个客户端。
REDIS_DIRTY_CAS 标志表示事务使用 WATCH 命令监视的数据库键已经被修改。
** REDIS_DIRTY_EXEC** 标志表示事务在命令入队时出现错误。
REDIS_DIRTY_CAS 和 REDIS_DIRTY_EXEC 标志的出现都表示 Redis 事务的安全性已被破坏。只要这两个标志中的任何一个被打开，EXEC 命令都会执行失败。而只有在客户端打开了 REDIS_MULTI 标志的情况下，才能使用这两个标志。
REDIS_MULTI 标志表示客户端正处于执行事务的状态中。
REDIS_MONITOR 标志表示客户端正处于执行 MONITOR 命令的状态中。
REDIS_FORCE_AOF 标志表示让服务器将当前正在执行的命令强制写入 AOF 文件中。在执行 PUBSUB 命令时，会使客户端打开 REDIS_FORCE_AOF 标志。
REDIS_FORCE_REPL 标志表示强制让主服务器将当前正在执行的命令复制给所有与它连接的从服务器。当执行 SCRIPT LOAD 命令时，会使客户端同时开启 REDIS_FORCE_AOF 和 REDIS_FORCE_REPL 标志。如果要实现主从服务器可以正确地载入 SCRIPT LOAD 命令指定的脚本，那么服务器必须使用 REDIS_FORCE_REPL 标志，让主服务器强制将 SCRIPT LOAD 命令分发给相应的从服务器。
REDIS_UNIX_SOCKET 标志表示服务器连接客户端使用的是 UNIX 套接字。
REDIS_BLOCKED 标志表示客户端正处于被 BRPOP、BLPOP 等命令阻塞的状态中。
REDIS_UNBLOCKED 标志表示客户端不再阻塞，它从 REDIS_BLOCKED 标志的阻塞状态中脱离出来。只有在 REDIS_BLOCKED 标志被打开的情况下，才能使用 REDIS_UNBLOCKED 标志。
REDIS_MASTER_FORCE_REPLY 标志：在主从服务器进行命令传播期间，从服务器需要向主服务器发送 REPLICATION ACK 命令。但是，在发送此命令之前，从服务器必须开启主服务器对应的客户端的 REDIS_MASTER_FORCE_REPLY 标志；否则主服务器会拒绝执行从服务器发送的 REPLCATION ACK 命令。

4.输入缓冲区

客户端状态的输入缓冲区用于保存客户端发送的命令请求，Redis从会输入缓冲区拉取命令并执行。

typedef struct redisClient {
    // ...
    sds querybuf;
    // ...
} redisClient;

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

querybuf属性示例

5.命令与命令参数

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

typedef struct redisClient {
    // 命令参数(数组)
    robj **argv;
    // 命令参数个数
    int argc;
} redisClient;

argv属性是一个数组，数组中的每个项都是一个字符串对象，其中args[0]是要实行的命令，后面的是该命令的参数。
argc属性记录argv数组的长度。

argv属性和argc属性示例.png

6.命令的实现函数

当服务器从协议内容解析得出命令与命令参数后，服务器将根据argv[0]的值，在命令表中查找命令所对应的命令实现函数。

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

typedef struct redisClient {
    // ...
    struct redisCommand *cmd;
    
} redisClient;

7.输出缓冲区

命令回复的内容会被保存在客户端的输出缓冲区里面，每个客户端有两个输出缓冲区可用，一个缓冲区是固定大小，另外一个大小是可变的。

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

固定大小缓冲区

typedef struct redisClient {
    // 字节数组，默认值16*1024，也就是16KB
    char buf[REDIS_REPLY_CHUNK_BYTES];
    // 已使用的字节数量
    int bufpos;
    
} redisClient;

REDIS_REPLY_CHUNK_BYTES常量默认值16*1024，也就是16KB

固定大小缓冲区示例

可变大小缓冲区
buf数组的空间用完，或者因为回复内容太大没法放进buf数组时，服务器会开始使用可变大小缓冲区。

typedef struct redisClient {
    // ...
    list *reply;
    
} redisClient;

可变大小缓冲区示例

8.身份验证

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

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

如果authenticated=0，表示客户端未通过身份验证；如果authenticated=1，表示通过身份验证。

authenticated属性只在服务器启用了身份验证功能的时候有效，如果没启用，就算为0，服务器也不会拒绝客户端的命令。

三、客户端的创建与关闭

1. 创建普通客户端

客户端通过网络与服务器进行连接，那么客户端使用connect函数连接时，服务器就会调用连接事件处理器，为这个客户端创建相应的数据对象，保存信息，并且追加到服务器状态的clients末尾。

2. 关闭普通客户端

客户端可以因为多种原因而被关闭：

客户端自身退出或者被杀死，导致网络连接断开，造成客户端关闭
客户端发送带有不符合协议格式的命令请求，那么该客户端也会被关闭
客户端成为CLIENT KILL命令的目标，则会被关闭
服务器设置了timeout选项，客户端空转时长过长也会被关闭
客户端发送的命令请求大小超过了缓冲区限制，则会被关闭
客户端的命令回复大小超过了输出缓冲区限制，则会被关闭

3. lua脚本的伪客户端

服务器初始化时会创建一个lua脚本的伪客户端，并将这个客户端关联在服务器的lua_clients属性中，这个客户端在服务器运行的整个生命周期中一直存在。

typedef struct redisClient {
    // ...
    redisClient *lua_client;
    
} redisClient;

4. AOF文件的伪客户端

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

四、总结

Redis服务器通过维护客户端的元数据信息，从而达到管理客户端的目的。