12 客户端

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

通过I/O多路复用技术实现的文件事件处理器，Redis服务器使用单线程单进程的方式处理命令请求，并与多个客户端进行网络通信。

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

Redis服务器状态结构的clients属性是一个链表，这个链表保存了所有与服务器连接的客户端的状态结构，对客户端执行批量操作、

或查找某个指定的客户端，都可以通过遍历clients链表来完成：

struct redisServer{
    //...

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

    //...
};

 

1.客户端属性

客户端状态包含的属性可以分为2类：通用属性、和特定功能相关的属性

 

1.1 套接字描述符

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

typedef struct redisClient{
    //...

    int fd;

    //...
}redisClient;

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

伪客户端的fd属性的值为-1：伪客户端处理的命令请求来源于AOF文件或者Lua脚本，而不是网络，所以这种客户端不需要套接字连接，自然也不需要记录套接字描述符。目前仅有2处用到伪客户端，一个是载入AOF文件并还原数据库状态，而另一个则用于执行Lua脚本中包含的Redis命令。

普通客户端的fd属性大于-1的整数：普通客户端使用套接字来与服务器进行通信，所以服务器会用fd属性来记录客户端套接字的描述符。因为合法的套接字描述符不能是-1，所以普通客户端的值一定大于-1

注：CLIENT llist：列出当前所有连接到服务器的普通客户端

 

1.2 名字

默认情况下，一个连接到服务器的客户端是没有名字的。

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

typedef struct redisClient{
    //...

    robj *name;

    //...
}redisClient;

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

 

1.3 标志

客户端的标志属性flags记录了客户端的角色（role），以及客户端目前所对应的状态：

typedef struct redisClient{
    //...

   int flags;

    //...
}redisClient;

flags属性的值可以是单个标志，也可以起是多个标志的二进制。

 

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

1）在主从服务器进行复制操作时，主服务器会成为从服务器的客户端，而从服务器也会成为主服务器的客户端。REDIS_MASTER标志表示客户端代表的是一个主服务器，REDIS_SLAVE标志代表的是一个从服务器。

2）REDIS_PRE_PSYNC标志表示客户端代表的是一个版本低于Redis2.8的从服务器，主服务器不能使用PSYNC命令与这个从服务器进行同步。这个标志只能在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标志表示的阻塞状态脱离出来

5）REDIS_MULTI标志表示客户端正在执行事务

6）REDIS_DIRTY_CAS标志表示事务使用WATCH命令监视的数据键已经被修改，REDIS_DITTY_EXEC标志表示事务在命令入队时出现了错误，以上两个标志都表示事务的安全性已经被破坏，只要这两个标志中任何一个被打开，EXEC命令表示事务的安全性已经被破坏。

7）REDIS_CLOS_ASAP标志表示客户端的输出缓冲区大小超出了服务器允许的范围，服务器会在下一次执行serverCron函数时关闭这个客户端，以免服务器的稳定性收到这个客户端影响。积存在输出缓冲区中的所有内容会被直接释放，不会返回给客户端

8）REDIS_CLOSE_AFTER_REPLY标志表示有用户对这个客户端执行了CLIENT KILL命令，或者客户端发送给服务器的命令请求中包含了错误的协议内容。服务器会将客户端积存在输出缓冲区的所有内容发送给客户端然后关闭客户端。

9）REDIS_ASKING标志表示客户端向集群节点发送了ASKING命令

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命令虽然没修改数据库，但是还是会将这个命令写入AOF

 

1.4 输入缓冲区

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

typedef struct redisClient{
    //...

    sds querybuf;

    //...
}redisClient;

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

 

1.5 命令与命令参数

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

typedef struct redisClient{
    //...

    robj **argv;

    int argc;

    //...
}redisClient;

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

argc属性负责记录argv数组的长度

 

1.6 命令的实现函数

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

针对命令表的查找操作是不区分大小写的。

 

1.7 输出缓冲区

执行命令所得的命令回复会被保存在客户端状态的输出缓冲区里面，每个客户端都有2个输出缓冲区可用，一个缓冲区的大小是固定的，一个是可变的。固定大小的缓冲区用于保存那些长度比较小的回复，可变的保存长度比较大的回复

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

typedef struct redisClient{
    //...

    char buf[REDIS_REPLY_CHUNK_BYTES];

    int bufpos;

    //...

}redisClient;

buf是一个大小为REDIS_REPLY_CHUNK_BYTES（默认16*1024）字节的字节数组，而bufpos属性则记录了buf数组目前已使用的字节数量。当buf数据空间用完或者太大放不进去是，服务器就会使用可变大小缓冲区。

可变大小缓冲区由reply链表和一个或多个字符串对象组成：

typedef struct redisClient{
    //...

    list *reply;

    //...
}redisClient;

通过使用链表来连接多个字符串对象，服务器可以为客户端保存一个非常长的命令回复，而不必受到16KB大小的限制

 

1.8 身份验证

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

typedef struct redisClient{
    //...

    int authenticated;

    //...
}redisClient;

如果authenticated为0表示没有通过身份验证；如果为1表示通过了.

authenticated仅在服务器启用了身份验证功能时使用。

 

1.9 时间

客户端有几个和时间相关的属性：

typedef struct redisClient{
    //...

    time_t ctime;

    time_t lastinteraction;

    time_t obuf_soft_limit_reached_time;

    //...
}redisClient;

ctime：创建客户端的时间

lastinteraction：客户端与服务器最后一次互动的时间

obuf_soft_limit_reached_time：输出缓冲区第一次到达软性限制的时间

 

2.客户端的创建和关闭

2.1 创建普通客户端

客户端使用connect函数连接到服务器时，服务器会调用连接事件处理器，为客户端创建相应的客户端状态，并将这个新的客户端状态添加到服务器状态结构clients链表的末尾。

 

2.2关闭普通客户端

普通客户端会因为多种原因被关闭：

1）客户端进程退出或杀死

2）客户端发送了不符合协议格式的命令请求

3）客户端成为CLIENT KILL命令的目标

4）用户设置了timeout配置选项，当客户端的空转时间超时。不过timeout选项有一些例外情况：如果客户端是主服务器，从服务器正在被BLPOP等命令阻塞，或者正在执行SUBSCRIBE、PSUBSCRIBE等命令，及时客户端的空转时间超时了，也不会被关闭

5）客户端发送的命令请求大小超过了输入缓冲区的限制大小（1GB）

6）发送给客户端的命令回复大小超过输出缓冲区的限制大小。理论上，可变缓冲区是链表无限长，但是为了避免客户端的回复过大，服务器会时刻监测并限制客户端的输出缓冲区大小：

====1）硬性限制：如果输出缓冲区大小超过硬性限制，那么服务器会关闭客户端

====2）软性限制：如果输出缓冲区的大小超过了软性限制，但是没超过硬性限制，那么obuf_soft_limit_reached_time会记录下客户端到达软性限制的起始时间，继续监视，如果缓冲区一直超过软性限制的时长超过设定的时长，关闭客户端。否则，会把obuf_soft_limit_reached_time清零。

注：client-output-buffer-limit可以为普通客户端（normal）、从服务器客户端（slave）、执行发布与订阅功能的客户端（pubsub）设置不同的软性限制和硬性限制

 

2.3 Lua脚本的伪客户端

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

struct redisServer{
    //...

    redisClient *lua_client;

    //...
};

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

 

2.4 AOF文件的伪客户端

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