0%

Redis 设计与实现-客户端

发表于 更新于 分类于 ， 阅读次数： Valine：
本文字数： 4.4k 阅读时长 ≈ 4 分钟

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

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

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

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

1. 客户端的属性

1.1 套接字描述符

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

1
2
3
4
5
typedef struct redisClient {
    //...
    int fd;
    // ...
} redisClient;

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

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

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

1.2 名字

在默认情况下,一个连接到服务器的客尸端是没有名字的。使用 CLIENT setName 命令可以为客户端设置一个名字,让客户端的身份变得更清晰。以下展示的是客户端执行 CLIENT setName 命令之后的客户端列表:

1
2
3
4
redis>CLIENT list

addr=127.0.0.1:53428 fd=6 name=message_queue age=2093 idle=0…
addr=127.0.0.1:53469 fd=7 name=user_relationship aqe=855 idle=2…

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

1
2
3
4
5
typedef struct redisClient {
    //...
    robj *name;
    // ...
} redisClient;

图13-3展示了一个客户端状态示例,根据name属性显示,客户端的名字为“message_queue“。

1.3 标志

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

1
2
3
4
5
typedef struct redisClient {
    //...
    int flags;
    // ...
} redisClient;

flags 属性的值可以是单个标志：

1
flags = <flags>

也可以是多个标志的二进制或,比如:

1
flags = <flagl>|<flag2>|...

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

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

  • REDIS_PRE_PSYNC标志表示客户端代表的是一个版本低于Redis2.8的从服务器,主服务器不能使用PSYVC命令与这个从服务器进行同步。这个标志只能在REDIS_SLAVE标志处于打开状态时使用。

  • REDIS_LUR_CLIENT标识表示客户端是专门用于处理Lua脚本里面包含的Redis命令的伪客户端。

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

  • REDIS_MONITOR标志表示客户端正在执行MOMNITOR命令。

  • REBDIS_UNIX_SOCKET标志表示服务器使用UNIX套接字来连接客户端。

  • REDIS_BLOCKED标志表示客户端正在被BRPOP、BLPOP等命令阻塞。

  • ….

1.4 输入缓冲区

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

1
2
3
4
5
typedef struct redisClient {
    //...
    sds querybuf;
    // ...
} redisClient;

举个例子,如果客户端向服务器发送了以下命令请求:

1
set key value

那么客户端状态的querybuf属性将是一个包含以下内容的SDS值:图13-4展示了这个SDS值以及querybuf属性的样子。

1.5 命令与命令参数

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

1
2
3
4
5
6
typedef struct redisClient {
    //...
    robj **argv;
    int argc;
    // ...
} redisClient;

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

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

1.6 命令的实现函数

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

图13-6展示了一个命令表示例,该表是一个字典,字典的键是一个SDS结构,保存了命令的名字,字典的值是命令所对应的redisCommand结构,这个结构保存了命令的实现函数、命令的标志、命令应该给定的参数个数、命令的总执行次数和总消耗时长等统计信息。

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

1
2
3
4
5
typedef struct redisClient {
    //...
    struct redisCommand *cmd;
    // ...
} redisClient;

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

1.7 输出缓冲区

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

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

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

1
2
3
4
5
6
typedef struct redisClient {
    //...
    char buf[REDIS_REPLY_CHUNK_BYTES];
    int bufpos;
    // ...
} redisClient;

buf是一个大小为REDIS_REPLY_CHUNK_BYTES字节的字节数组,而bufpos属性则记录了buf数组目前已使用的字节数量。图13-8展示了一个使用固定大小缓冲区来保存返回值+OK\r\n的例子。

图13-9展示了一个包含三个字符串对象的reply链表。

1.8 身份验证

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

1
2
3
4
5
typedef struct redisClient {
    //...
    int authenticated;
    // ...
} redisClient;

如果authenticated的值为0,那么表示客户端未通过身份验证;如果authenticated的值为1,那么表示客户端已经通过了身份验证。

2. 客户端的创建与关闭

2.1 创建普通客户端

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

2.2 关闭普通客户端

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

  • 如果客户端进程退出或者被杀死,那么客户端与服务器之间的网络连接将被关闭,从而造成客户端被关闭。

  • 如果客户端向服务器发送了带有不符合协议格式的命令请求,那么这个客户端也会被服务器关闭。

  • …

2.3 Lua 脚本的伪客户端

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

1
2
3
4
5
typedef struct redisClient {
    //...
    redisClient *lua_client;
    // ...
} redisClient;

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

2.4 AOF 文件的伪客户端

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

------ 本文结束------