3. Redis的通信协议
先贴一个 官方文档
3.1 RESP
RESP(redis Serialization Protocol)是Redis的序列化协议,主要优势在于:
- 实现过程简单
- 解析性能极好
- 可读性强
RESP可序列化不同的数据类型,包括:简单字符串、错误类型、整数、批量字符串和数组。请求从客户端发送到Redis服务器,作为表示要执行命令的参数的字符串数组,Redis-server会使用特定的数据类型进行回复。
RESP是二进制安全的,不需要处理从一个进程传输到另一个进程的批量数据,因为它使用前缀来确定是否传输批量数据。
注意:RESP 虽然是为 Redis 设计的,但是同样也可以用于其他 C/S 的软件。Redis Cluster使用不同的二进制协议(gossip),以便在节点之间交换消息。
Redis协议将传输的结构数据分为5种最小单元类型,单元结束时统一加上回车换行符"\r\n"(CRLF)结束。
- "+"表示简单字符串 Simple Strings,即:单行字符串
- "$"表示批量字符串Bulk Strings,后跟字符串长度
- ":"表示整数
- "-"表示错误消息
- "*"表示数组
3.2 验证RESP
SET key value #对应的resp通信协议串
*3
$3
SET
$3
key
$5
value
第一次看到这个通信协议串,看不懂不必担心,我们按照RESP的协议说明慢慢看,并且下文会有详细的讲解。
这里大概翻译一下这段传输的数据含义:
- 第一行
*3
表示这条发给Redis server的命令是数组,数组有3个元素(其实就是SET、key、value这仨字符串);
后面的6行数据,分别是对数组三个元素的表示,每个元素用两行; - 数组第一个元素:<3`代表Bulk Strings字符串长度为3,内容是SET。
- 数组第二个元素:<3`代表Bulk Strings字符串长度为3,内容是key。
- 数组第三个元素:
$5 value``$5
代表Bulk Strings字符串长度为5,内容是value。
3.3 具体类型说明
3.3.1简单字符串Simple Strings
简单字符串按以下方式编码:+
字符,后跟不能包含CR或LF字符的字符串(不允许换行),由CRLF终止(即“\r\n”)。
Simple Strings用于以最小的开销、传输非二进制安全字符串。例如,许多Redis命令在成功时仅回复“OK”,因为RESP Simple String使用以下5个字节进行编码:
+OK\r\n
当Redis使用Simple String回复时,该字符串由'+'之后的第一个字符组成,直到字符串结尾,不包括最终的CRLF字节。
3.3.2 RESP错误
RESP具有特定的错误数据类型。实际上错误与RESP Simple Strings完全相同,但第一个字符是减-
字符而不是加号。RESP中简单字符串和错误之间的真正区别在于客户端将错误视为异常,组成错误类型的字符串是错误消息本身。
基本格式是:-ERR errorMsg\r\n
错误回复仅在发生错误时发送,例如,如果你尝试对错误的数据类型执行操作,或者命令不存在等等。收到错误答复时,库客户端应引发异常。
以下是错误回复的示例:
-ERR unknown command 'foobar'
-WRONGTYPE Operation against a key holding the wrong kind of value
“-”之后的第一个单词,直到第一个空格或换行符,表示返回的错误类型。这只是Redis使用的约定,不是RESP错误格式的一部分。
例如,ERR是一般错误,而WRONGTYPE更具体的错误意味着客户端尝试对错误的数据类型执行操作。这称为错误前缀,是一种允许客户端理解服务器返回的错误类型的方法,而不依赖于给定的确切消息,这可能随时间而变化。
下面是几个使用redis-cli的实际错误的例子:
127.0.0.1:6379> TaoBeier
-ERR unknown command 'TaoBeier'\r\n # 服务端实际返回, 下同
---
(error) ERR unknown command 'TaoBeier' # redis-cli 客户端显示, 下同
127.0.0.1:6379> set name TaoBeier love
-ERR syntax error\r\n
---
(error) ERR syntax error
客户端实现可以针对不同的错误返回不同类型的异常,或者可以通过直接将错误名称作为字符串提供给调用者来提供捕获错误的通用方法。
但是,错误类型很少有用,并且有限的客户端实现可能只是返回一般的错误条件,例如false。
3.3.3整数类型
此类型只是一个CRLF终止的字符串,表示一个以:
字节为前缀的整数。例如:0 \r\n
或:1000 \r\n
是整数回复。
很多Redis命令返回RESP整数类型,比如INCR,LLEN和LASTSAVE。
返回的整数没有特殊含义,它只是INCR的增量数,LASTSAVE的UNIX时间等等。但是,返回的整数保证在有符号的64位整数范围内。
整数回复也被广泛使用以返回真或假。例如,EXISTS或SISMEMBER之类的命令将返回1表示true,0表示false表示。
如果操作实际执行,其他命令如SADD,SREM和SETNX将返回1,否则返回0。
下面的命令都是整数类型回复:SETNX,DEL, EXISTS,INCR,INCRBY,DECR,DECRBY,DBSIZE,LASTSAVE, RENAMENX,MOVE,LLEN,SADD,SREM,SISMEMBER,SCARD。
3.3.4 Bulk Strings类型
翻译过来,是指批量、多行字符串。
Bulk Strings用于表示长度最大为512MB的单个二进制安全字符串。
批量字符串按以下方式编码:
- 一个
$
字节后跟组成字符串的字节数(一个前缀长度),由CRLF终止。 - 实际的字符串数据。
- 最终的CRLF。
所以字符串“foobar”的编码如下:
$6\r\n
foobar\r\n"
一个完整的Bulk Strings,主要包括两行:
第一行,$后面跟上字符串长度;
第二行,就是实际的字符串。
如下面执行set、get的例子:
127.0.0.1:6379> set site ljheee
+OK\r\n # 服务端实际返回, 下同
---
OK # redis-cli 客户端显示, 下同
127.0.0.1:6379> get site
$6\r\
ljheee\r\n
---
"ljheee"
在执行set site value
时,客户端给Redis server发送RESP命令后,Redis server返回的是simple strings类型+OK\r\n
,redis-cli命令行客户端给我们只显示了有效字符、省略了最后的CRLF。
在执行get site
时,Redis server返回的是Bulk Strings类型,第一行$6
代表site对应的value值length为6,第二行是实际value值。
当只是一个空字符串时,表示为:$0\r\n
Bulk Strings也可用于使用用于表示Null值的特殊格式来表示值的不存在。在这种特殊格式中,长度为-1,并且没有数据,因此Null表示为:$-1\r\n
,这称为Null Bulk String。
3.3.5 数组类型
客户端使用数组、将命令发送到Redis服务器。类似地,某些Redis命令将元素集合返回给客户端使用数组类型回复。如LRANGE命令,它返回元素列表其实就是数组类型。
RESP数组使用以下格式发送:
- 它以 “*” 开头,后面跟着返回元素的个数,后跟CRLF。
- 然后就是数组中各元素自己的类型了,数组每个元素可以是任意的RESP类型。
最典型的是 LRRANGE
命令,返回的就是数组类型
LRANGE info 0 -1
*2\r\n
$3\r\
abc\r\n
$6\r\n
ljheee\r\n
--- # 实际redis-cli显示
1) "abc"
2) "ljheee"
返回的结果,*2代表数组长度为2,数组的第一个元素$3
是长度为3的字符串abc;数组的第二个元素$6
是长度为6的字符串ljheee。