Redis - RESP

前言

Redis 在 1.2 版本中引入一种新的通信协议，并在 2.0 版本中开始，该协议成为了与Redis服务器通讯的标准方式。

该通行协议有种很多优点，比如：

1. 简单的实现。
2. 快速地被计算机解析。
3. 简单得可以能被人工解析。
4. 二进制安全。

正文

原理

在 OSI 网络层中，Redis 在 TCP 端口 6379(默认) 上监听到来的连接，客户端连接到来时，Redis服务器为此创建一个TCP连接。在客户端与服务器端之间传输的每个 Redis 命令或者数据都以 \r\n 结尾。如下例子：

*2
$3
GET
$7
library

Redis 接收由不同参数组成的命令。一旦收到命令，将会立刻被处理，并回复给客户端。

回复详解

1. 用回复的第一个字节“+” 表示：单行回复。
2. 用回复的第一个字节“-” 表示：错误消息。
3. 用回复的第一个字节“:” 表示：整型数字。
4. 用回复的第一个字节“$” 表示：批量回复。
5. 用回复的第一个字节“*” 表示：多个批量回复。

通用格式如下，若暂时没明白。可以先看下面的实际操作，再来理解。

*<number of arguments> CR LF
$<number of bytes of argument 1> CR LF
<argument data> CR LF
...
$<number of bytes of argument N> CR LF
<argument data> CR LF

码来实操

本人用 PHP 写了一个 Redis 的客户端，它能够清晰告诉你请求 redis 和接受到 redis 响应的原始报文格式。

可以使用 composer 或者 Github 进行下载。如果你觉得有点意思或者能帮助你理解，请帮忙点一个小星星。点我点我

1. composer
composer require ucwords/zredis

2. github 
https://github.com/ucwords/zredis.git

该包部分代码借鉴于 predis, 命令及参数遵循 redis 格式和要求。不同的是每个命令的第一个参数控制是否打印原始报文。

当使用时候若想查看请求或响应的原始报文，第一个参数请赋值为 true。
当想正常使用如像 predis 时候，第一个参数请赋值为 false。

使用举例

<?php

require '../vendor/autoload.php';

$singleServer = [
    'host' => '127.0.0.1',
    'port' => 6379,
];

$client = new Ucwords\Zredis\Client($singleServer);

// 下例将会输出原始报文

$client->set(true, 'library', 'library');
$client->get(true, 'library');


// 下例将如 predis 一样正常使用

$client->set(false, 'library', 'library');
$client->get(false, 'library');

单行回复 示例

Redis 回复的第一个字节为 “+” 表示单行回复。状态回复（或者单行回复）以“+”开始以“\r\n”结尾的单行字符串形式，如：“+OK\r\n”。

// 单行回复 示例
$client->set(true, 'library', 'library');

格式化结果输出：

-----------请求 开始 ----------
请求原始报文: SET library library
请求格式化为 Redis 报文: 
*3
$3
SET
$7
library
$7
library

----------- 请求 结束 ----------

----------- 响应 开始 ----------
响应原始报文: 
响应格式化为 Redis 报文: 
+OK
----------- 响应 结束 ---------- 

错误消息 示例

Redis 回复的第一个字节为 “-” 表示错误消息。错误回复发送类似于状态回复。唯一的不同是第一个字节用“-”代替“+”。

比如我们对一个 string 类似的key，执行 hget 指令。

$client->set(true, 'library', 'library');

// 错误回复
$client->hgetall(true, 'library');

格式化结果输出：

-----------请求 开始 ----------
请求原始报文: HGETALL library
请求格式化为 Redis 报文: 
*2
$7
HGETALL
$7
library

----------- 请求 结束 ----------

----------- 响应 开始 ----------
响应原始报文: 
响应格式化为 Redis 报文: 
-

异常信息：WRONGTYPE Operation against a key holding the wrong kind of value
----------- 响应 结束 ----------    

整型数字消息 示例

Redis 回复的第一个字节为 “:” 表示整型数字回复。例如：“：0\r\n”，或者“:1000\r\n”是整型回复。

如判断一个 key 是否存在。

$client->set(true, 'library', 'library');

$client->exists(true, 'library');

格式化结果输出：
-----------请求 开始 ----------
请求原始报文: EXISTS library
请求格式化为 Redis 报文: 
*2
$6
EXISTS
$7
library

----------- 请求 结束 ----------

----------- 响应 开始 ----------
响应原始报文: 1
响应格式化为 Redis 报文: 
:1

----------- 响应 结束 ----------

批量回复消息 示例

Redis 回复的第一个字节为 “$” 表示批量回复。 批量回复被服务器用于返回一个单二进制安全字符串。

$client->set(true, 'library', 'library');

// 批量回复 示例
$client->get(true, 'library');

格式化结果输出：

-----------请求 开始 ----------
请求原始报文: GET library
请求格式化为 Redis 报文: 
*2
$3
GET
$7
library

----------- 请求 结束 ----------

----------- 响应 开始 ----------
响应原始报文: library
响应格式化为 Redis 报文: 
$7
library

----------- 响应 结束 ----------

多个批量回复消息 示例

Redis 回复的第一个字节为 “*” 表示多个批量回复，如使用 hgetall 指令。

$client->hgetall(true, 'test_hash');

格式化结果输出：

-----------请求 开始 ----------
请求原始报文: HGETALL test_hash
请求格式化为 Redis 报文: 
*2
$7
HGETALL
$9
test_hash

----------- 请求 结束 ----------

----------- 响应 开始 ----------
响应原始报文: Array
响应格式化为 Redis 报文: 
*8
$4
name

$5
zhang

$3
age

$2
18

$4
attr

$1
2

$8
attr\0fa

$1
2

----------- 响应 结束 ----------

总结

本文描述了 Redis 自己实现的通信协议，其实 Redis 源码中还有很多自己实现的数据结构。它们是很有意思的，如果你感兴趣可以看继续看这系列文章《Redis 系列文章导航》。

其实上面的例子中还有二进制安全没有验证，希望大家看到这里可以下载这个客户端进行实现。其实就是看 Redis 对含有 \0 字符串的处理结果就好了。

最后若本文对你有帮助，请给我一个小星星。点我点我