死磕 Redis----- Redis 通信协议 RESP

Posted 2021-06-30 chenssy

原文：https://www.topjava.cn/category/1391389927996002304 『chenssy』

---

我们在第一次成功安装完 Redis ，启动 Redis 服务后，都会通过 ping 命令来测试 Redis 服务是否启动成功，如果服务启动成功则会响应 PONG，否则启动失败。这么一个简单的过程就完成了 Redis 客户端 - 服务端的一次交互。

我们知道，Redis 客户端与服务端是通过命令的方式来完成交互过程的，主要分为两个部分：网络模型和序列化协议。前者讨论的是数据交互的组织方式，后者讨论的是数据如何序列化。本篇文章将分析后者即，Redis 的序列化协议。

简介

Redis 的通信协议是 Redis Serialization Protocol，翻译为 Redis 序列化协议，简称 RESP。它具有如下特征：

• 在 TCP 层
• 是二进制安全的
• 基于请求 - 响应模式
• 简单、易懂（人都可以看懂）

RESP 所描述的是 Redis 客户端 - 服务端的交互方式，掌握了其原理我们基本上就可以撸一个简单的 Redis 客户端了。

RESP 描述

Redis 协议将传输的结构数据分为 5 种类型，单元结束时统一加上回车换行符号 \\r\\n。

• 单行字符串，第一个字节为 +
• 错误消息，第一个字节为 -
• 整型数字，第一个字节为 :，后跟整数的字符串
• 多行字符串，第一个字节为 $，后跟字符串的长度
• 数组，第一个字节为 *，后跟跟着数组的长度

单行字符串 chenssy

+chenssy

错误消息

-ERR unknown command ‘sets’…

整型字符串 29

:29

多行字符串 chenssy

$7
chenssy

数组[chenssy,29]

*2
$7
chenssy
$2
29

为了更加直观的阅读，将 \\r\\n 替换为换行

请求命令

Redis 对每一条请求命令都做了统一规范，格式如下：

*<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

翻译如下：

• number of arguments ： 参数的数量
• CR LF：\\r\\n
• number of bytes of argument 1：参数 1 的字节数
• number of bytes of argument N：参数 N 的字节数

以命令 set userName chenssy 为例，如下：

*3
$3
SET
$8
userName
$7
chenssy

解释：

*3 数组，表明有三个参数 SET、userName、chenssy
$3 多行字符串，第一个参数 SET ，有 3 个字符
$8 多行字符串，第二个参数 userName，有 8 个字符
$7 多行字符串，第三个参数 chenssy，有 7 个字符

上面只是格式化显示的结果，真正传输的结果如下：

*3\\r\\n$3\\r\\nSET\\r\\n$8\\r\\nuserName\\r\\n$7\\r\\nchenssy\\r\\n

回复命令

Redis 服务端响应要支持多种数据格式，所以回复命令一般都会显得复杂些，但是无论如何它都逃脱不了上面 5 中类型及其组合。

我们通过 nc 命令来模拟整个过程，图如下：

单行字符串

set name chenssy
+OK

当行字符串响应一般都用于状态类的请求，比如 set、del、hset 等等诸如此类的

错误消息

sets birthday 02-30
-ERR unknown command ‘sets’…

因为没有 sets 这个命令，所以回复错误信息

整数型

incrby age 29
:58

多行字符串

get name
$7
chenssy

返回的 value chenssy 有 7 个字符，所以类型为 $7

数组类型

mget name age
*2
$7
chenssy
$2
58

通过 mget 获取 name 和 age 的值，因为结果要返回两个结果集，所以 *2 表示返回的结果类型为数组且有两个元素，$7、$2 就不过多解释了。

lrange listkey 0 -1
*4
$8
chenssy3
$8
chenssy2
$8
chenssy1
$7
chenssy

lrange 命令是获取列表（list）中的数据的，返回结果依然是以数组方式组合起来的，和 mget 命令返回的结果集一致。

其他的就不再演示了。

从上面我们可以看出 RESP 协议是非常简单直观的一种协议，我们肉眼都可以看懂，而且数据结构类型也只有少少的 5 中，所以实现起来就变得很简单了，下面我们就手撸一个简单的客户端。

撸一个简单的客户端

撸一个简易的 Redis 客户端其实是比较容易的，我们只需要清楚知道客户端与 Redis 之间的通信协议是 RESP，在构造 Redis 命令的时候，只需要按照 RESP 的协议规范即可。客户端与 Redis 服务端通信采用最简单的 socket 就行了。

实现效果：从控制台输入简单的 Redis 命令，程序根据命令构造 RESP 协议，发送给 Redis 服务，根据分析响应结果并显示。源码如下：

public class RedisClient {

    private static Socket socket;
    private static OutputStream write;
    private static InputStream read;

    public static void main(String[] args) throws IOException {
        socket = new Socket("127.0.0.1",6379);
        write = socket.getOutputStream();
        read = socket.getInputStream();


        Scanner scan = new Scanner(System.in);

        // 判断是否还有输入
        while (scan.hasNextLine()) {
            String str = scan.nextLine();

            // 构造协议
            String commannd = buildCommand(str);
            
            System.out.println("发送命令为：\\r\\n" + commannd);
            
            String result = sendCommand(commannd);

            System.out.println("响应命令为：" + result);
        }

        scan.close();
    }

    private static String sendCommand(String commannd) throws IOException {
        write.write(commannd.toString().getBytes());
        byte[] bytes = new byte[1024];
        read.read(bytes);

        return new String(bytes,"UTF-8");
    }

    private static String buildCommand(String str) {
        if (str != null && !"".equals(str)) {
            String[] strs = str.split(" ");

            StringBuilder builder = new StringBuilder();
            builder.append("*").append(strs.length).append("\\r\\n");
            for (String str1 : strs) {
                builder.append("$").append(str1.length()).append("\\r\\n");
                builder.append(str1).append("\\r\\n");
            }

            return builder.toString();
        }

        return null;
    }
    
}

运行结果：

set name chenssy
发送命令为：
*3
$3
set
$4
name
$7
chenssy

响应命令为：+OK

get name
发送命令为：
*2
$3
get
$4
name

响应命令为：$7
chenssy