第13章 客户端
文章目录
对于每个与服务器进行连接的客户端,服务器都为这些客户端建立了相应的redis.h/redisClient结构(客户端状态),这个结构保存了客户端当前的状态信息,以及执行相关功能时需要用到的数据结构。包括:
- 客户端的套接字描述符
- 客户端的名字
- 客户端的标志值(flag)
- 指向客户端正在使用的数据库的指针,以及该数据库的号码
- 客户端当前要执行的命令、命令的参数、命令参数的个数,以及指向命令实现函数的指针
- 客户端的输入缓冲区和输出缓冲区
- 客户端的复制状态信息,以及进行复制所需的数据结构
- 客户端执行BRPOP、BLPOP等列表阻塞命令时使用的数据结构
- 客户端的事务状态,以及执行WATCH命令时用到的数据结构
- 客户端执行发布与订阅功能时用到的数据结构
- 客户端的身份验证标志
- 客户端的创建时间,客户端和服务器最后一次通信的时间,以及客户端的输出缓冲区大小超出软性限制(soft limit)的时间。
struct redisServer {
// ...
list *clients; // 一个链表,保存了所有客户端状态
redisClient *lua_client; // Lua脚本的伪客户端
// ...
};


13.1 客户端属性
客户端状态包含的属性可以分为两类:
- 一类是比较通用的属性,这些属性很少与特定功能相关,无论客户端执行的是什么工作,它们都要用到这些属性
- 另外一类是和特定功能相关的属性
typedef struct redisClient {
int fd; // 套接字描述符
robj *name; // 名字
int flags; // 标志
sds querybuf; // 输入缓冲区
robj **argv; // 命令的参数
int argc; // 命令的个数
struct redisCommand *cmd; // 命令的实现函数
char buf[REDIS_REPLY_CHUNK_BYTES]; // 输出缓冲区
int bufpos; // buf已使用字节数量
int authenticated; // 身份验证
time_t ctime; // 时间
time_t lastinteraction;
time_t obuf_soft_limit_reached_time;
} redisClient;
-
套接字描述符
客户端状态的fd属性记录了客户端正在使用的套接字描述符
根据客户端类型的不同,fd属性的值可以是-1或者是大于-1的整数:
- 伪客户端(fake client)的fd属性的值为-1。伪客户端处理的命令请求来源于AOF文件或者Lua脚本
- 普通客户端的fd属性的值为大于-1的整数
-
名字
在默认情况下,一个连接到服务器的客户端是没有名字的
-
标志
客户端的标志属性flags记录了客户端的角色(role),以及客户端目前所处的状态
-
输入缓冲区
客户端状态的输入缓冲区用于保存客户端发送的命令请求
输入缓冲区的大小会根据输入内容动态地缩小或者扩大,但它的最大大小不能超过1GB,否则服务器将关闭这个客户端
-
命令与命令参数
在服务器将客户端发送的命令请求保存到客户端状态的querybuf属性之后,服务器将对命令请求的内容进行分析,并将得出的命令参数以及命令参数的个数分别保存到客户端状态的argv属性和argc属性
argv属性是一个数组,数组中的每个项都是一个字符串对象,其中argv[0]是要执行的命令,而之后的其他项则是传给命令的参数
argc属性则负责记录argv数组的长度
-
命令的实现函数
当服务器从协议内容中分析并得出argv属性和argc属性的值之后,服务器将根据项argv[0]的值,在命令表中查找命令所对应的命令实现函数
-
输出缓冲区
执行命令所得的命令回复会被保存在客户端状态的输出缓冲区里面,每个客户端都有两个输出缓冲区可用,一个缓冲区的大小是固定的,另一个缓冲区的大小是可变的:
- 固定大小的缓冲区用于保存那些长度比较小的回复
- 可变大小的缓冲区用于保存那些长度比较大的回复
-
身份验证
客户端状态的authenticated属性用于记录客户端是否通过了身份验证
如果authenticated的值为0,那么表示客户端未通过身份验证;如果authenticated的值为1,那么表示客户端已经通过了身份验证
当客户端authenticated属性的值为0时,除了AUTH命令之外,客户端发送的所有其他命令都会被服务器拒绝执行
authenticated属性仅在服务器启用了身份验证功能时使用。未启用的话,默认为0,服务器也不会拒绝执行客户端发送的命令请求
-
时间
time属性记录了创建客户端的时间
lastinteraction属性记录了客户端与服务器最后一次进行互动(interaction)的时间
obuf_soft_limit_reached_time属性记录了输出缓冲区第一次到达软性限制(soft limit)的时间
13.2 客户端的创建与关闭
服务器使用不同的方式来创建和关闭不同类型的客户端
13.2.1 创建普通客户端
如果客户端是通过网络连接与服务器进行连接的普通客户端,那么在客户端使用connect函数连接到服务器时,服务器就会调用连接事件处理器(在第12章有介绍),为客户端创建相应的客户端状态,并将这个新的客户端状态添加到服务器状态结构clients链表的末尾
13.2.2 关闭普通客户端
一个普通客户端可以因为多种原因而被关闭:
-
如果客户端进程退出或者被杀死,那么客户端与服务器之间的网络连接将被关闭,从而造成客户端被关闭
-
如果客户端向服务器发送了带有不符合协议格式的命令请求,那么这个客户端也会被服务器关闭
-
如果客户端成为了CLIENT KILL命令的目标,那么它也会被关闭
-
如果用户为服务器设置了timeout配置选项,那么当客户端的空转时间超过timeout选项设置的值时,客户端将被关闭
-
如果客户端发送的命令请求的大小超过了输入缓冲区的限制大小(默认为1 GB),那么这个客户端会被服务器关闭
-
如果要发送给客户端的命令回复的大小超过了输出缓冲区的限制大小,那么这个客户端会被服务器关闭
服务器使用两种模式来限制客户端输出缓冲区的大小:
- 硬性限制(hard limit):如果输出缓冲区的大小超过了硬性限制所设置的大小,那么服务器立即关闭客户端
- 软性限制(soft limit):如果输出缓冲区的大小超过了软性限制所设置的大小,但还没超过硬性限制,那么服务器将使用客户端状态结构的obuf_soft_limit_reached_time属性记录下客户端到达软性限制的起始时间;之后服务器会继续监视客户端,如果输出缓冲区的大小一直超出软性限制,并且持续时间超过服务器设定的时长,那么服务器将关闭客户端。(软性限制阈值小于硬性限制阈值,即缓冲区大小处于较高值持续较大时间)
13.2.3 Lua脚本的伪客户端
服务器会在初始化时创建负责执行Lua脚本中包含的Redis命令的伪客户端,并将这个伪客户端关联在服务器状态结构的lua_client属性中。
lua_client伪客户端在服务器运行的整个生命期中会一直存在,只有服务器被关闭时,这个客户端才会被关闭
13.2.4 AOF文件的伪客户端
服务器在载入AOF文件时,会创建用于执行AOF文件包含的Redis命令的伪客户端,并在载入完成之后,关闭这个伪客户端
13.3 重点回顾
- 服务器状态结构使用clients链表连接起多个客户端状态,新添加的客户端状态会被放到链表的末尾
- 客户端状态的flags属性使用不同标志来表示客户端的角色,以及客户端当前所处的状态
- 输入缓冲区记录了客户端发送的命令请求,这个缓冲区的大小不能超过1GB
- 命令的参数和参数个数会被记录在客户端状态的argv和argc属性里面,而cmd属性则记录了客户端要执行命令的实现函数
- 客户端有固定大小缓冲区和可变大小缓冲区两种缓冲区可用,其中固定大小缓冲区的最大大小为16KB,而可变大小缓冲区的最大大小不能超过服务器设置的硬性限制值
- 输出缓冲区限制值有两种,如果输出缓冲区的大小超过了服务器设置的硬性限制,那么客户端会被立即关闭;除此之外,如果客户端在一定时间内,一直超过服务器设置的软性限制,那么客户端也会被关闭
- 当一个客户端通过网络连接连上服务器时,服务器会为这个客户端创建相应的客户端状态。网络连接关闭、发送了不合协议格式的命令请求、成为CLIENT KILL命令的目标、空转时间超时、输出缓冲区的大小超出限制,以上这些原因都会造成客户端被关闭
- 处理Lua脚本的伪客户端在服务器初始化时创建,这个客户端会一直存在,直到服务器关闭
闭 - 当一个客户端通过网络连接连上服务器时,服务器会为这个客户端创建相应的客户端状态。网络连接关闭、发送了不合协议格式的命令请求、成为CLIENT KILL命令的目标、空转时间超时、输出缓冲区的大小超出限制,以上这些原因都会造成客户端被关闭
- 处理Lua脚本的伪客户端在服务器初始化时创建,这个客户端会一直存在,直到服务器关闭
- 载入AOF文件时使用的伪客户端在载入工作开始时动态创建,载入工作完毕之后关闭