Redis protocol (redis通信协议)

以前只会用redis -cli客户端, 或者在java程序里使用jedis来作为介质与redis服务器通信.这两天正好在实习中接触了一点这方面的内容. 五一放假就稍微翻了翻redis相关资料.

本篇博客一来是给自己整理笔记,二来是给学校的同学们分享: 面向于使用过redis, 但只是停留在基本set get的命令, 不了解其中原理的同学.

介绍redis的ping pong

首先介绍一下ping pong.. (既然有同学不懂..我就再加上ping pong的介绍吧)

登录redis cli客户端后, 输入ping, 服务器会返回pong, 来表示连接状况是完好的, 也表示了服务器大体上是正常运转的.

其中的第一行是我用docker 启动的客户端, 大家如果不是docker的话, 自己正常启动redis -cli就行..

ping之后就会收到pong

(大家问了docker怎么用...我这里附上一个地址...http://www.runoob.com/docker/docker-install-redis.html )

使用Java socket 来实现 Redis 的ping pong

抄代码的时候大家良心一点...不要去用我的ip去试...(非要拿我的试也没关系...因为我已经偷偷改掉一位数了)

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.210", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        InputStream is = socket.getInputStream();

        // 向redis服务器写
        os.write("PING\r\n".getBytes());

        //从redis服务器读,到bytes中
        byte[] bytes = new byte[1024];
        int len = is.read(bytes);

        // to string 输出一下
        System.out.println(new String(bytes,0,len));
    }

返回的结果如下:

问: 为什么会有一个 '+'符号 呢?  redis -cli里是没有这个加号的呀?  答:这个和通信协议有关, 一会儿再介绍具体的含义. 不过redis -cli只是把这个'+'符号吞掉处理了, 没显示出来罢了. 如果这么说还不理解的话......看下面代码...

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.210", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        InputStream is = socket.getInputStream();

        // 向redis服务器写
        os.write("PING\r\n".getBytes());

        //从redis服务器读,到bytes中
        byte[] bytes = new byte[1024];
        if(is.read()=='+'){
            // to string 输出一下
            int len = is.read(bytes);
            System.out.println(new String(bytes,0,len));
        }
        // else if $
        // else if *
        // else
    }

这样就跟redis -cli里的一样啦.就只是pong了

ps: 不是我逗大家玩....jedis在在协议层也是类似于这样的写法, 把 $ * + 这几个符号挨个判断来确定传输内容的含义的...

实现一下SET 和 GET 吧

咱们先实现, 稍后再讲解其中的协议内容

set:

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.210", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        InputStream is = socket.getInputStream();

        // 向redis服务器写
        os.write("set hello world123\r\n".getBytes());

        //从redis服务器读,到bytes中
        byte[] bytes = new byte[1024];
        int len = is.read(bytes);

        // to string 输出一下
        System.out.println(new String(bytes,0,len));
    }

---

get:

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.310", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        InputStream is = socket.getInputStream();

        // 向redis服务器写
        os.write("get hello\r\n".getBytes());

        //从redis服务器读,到bytes中
        byte[] bytes = new byte[1024];
        int len = is.read(bytes);

        // to string 输出一下
        System.out.println(new String(bytes,0,len));
    }

解释上面例子中的+和$符号

ps:本文只是一个博客,并非官方文档, 所以不会一下子抛出很多概念, 只是一点点引导着同学们看, 看的着急的同学可以直接去看官方文档

https://redis.io/topics/protocol ,   这里还有个中文版: http://doc.redisfans.com/topic/protocol.html

加号'+' 是来表示状态回复的, 在redis服务端向客户端返回状态信息时, 就会先发送一个`+`符号来开头.

接下来是相应的状态信息, 例如'OK'什么的.

最后, 要以'\r\n' 来结尾... 咱们看一下代码就明白了

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.210", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        InputStream is = socket.getInputStream();

        // 向redis服务器写
        os.write("set hello world123\r\n".getBytes());

        //从redis服务器读,到bytes中
        byte[] bytes = new byte[1024];
        if (is.read() == '+') {
            System.out.println("这是一个状态回复哦! 怎么知道的呢? `+` 号就表示 '状态回复' 了");
            int len = is.read(bytes);
            System.out.println("回复的状态是: " + new String(bytes, 0, len));
        }

        // 大家想不想看看bytes里面到底有几个字符吗?
        System.out.println(Arrays.toString(bytes));
        // 输出的是 [79, 75, 13, 10, 0, 0, 0, 0, 0,....]
        // 其中 79 75 是 `OK`
        // 其中 13 10 是 `\r\n`
        // 后面的一串0 是 表示没有后续内容, 已经读完.
    }

---

$ 表示批量读取, 一般格式是: $<数字>, 数字来表示正文的内容的字节数

抓包后是这样的, 客户端向服务端发送了"get hello", 服务端向客户端发送了蓝色的这两行.

public static void main(String[] args) throws Exception {
        // socket
        Socket socket = new Socket("140.143.135.210", 6379);

        // oi流
        OutputStream os = socket.getOutputStream();
        // 为了解析'\r\n'方便, 我就用改为字符流了
        BufferedReader br = new BufferedReader(new InputStreamReader(socket.getInputStream()));

        // 向redis服务器写
        os.write("get hello\r\n".getBytes());

        // 缓冲数组
        char[] chars = new char[1024];

        //从redis服务器读,到bytes中
        if (br.read() == '$') {
            System.out.println("这是一个批量回复哦! 怎么知道的呢? `$` 号就表示 '批量回复' 了");
            System.out.println("$ 后面会跟一个数字, 来表示正文内容的大小");
            // readLine直接能判断'\r' '\n'
            int len = Integer.parseInt(br.readLine());
            System.out.println("$后面跟着的数字是: " + len + ", 表示正文是" + len + "个字节, 接下来只要读取" + len + "个字节就好了");

            // 接下来只读取len个字符就ok了  (其实单位应该是字节, 但是我中途为了readLine省事, 改用了字符流, 个数是不变的)
            br.read(chars, 0, len);
            System.out.println("get到的结果是: " + new String(chars, 0, len) + ", 数一数真的是" + len + "个字符");
        }
    }

Redis通信协议就只是这样?

no!!!刚才客户端向服务端发送的 "get hello" , 这种只是"内联命令", 而不是Redis真正的通信协议.

问: 什么意思呢? 答:  就是说你可以像之前那样给服务端发, 服务器端接受到后, 会遍历一遍你发送的内容, 最后根据空格来分析你所发的内容的含义.

问: 这样有什么不好的吗?  答: 如果这样的话, 你就把解析的工作交给了服务器来做, 会加大服务器的工作量.

问: 那怎么样才是符合规范的呢? 符合协议的话真的会提高服务器的效率? 答: 首先看一下符合协议的客户端和服务端之间的交互把.如下例子:

例: set java python ,抓到包之后是这样的:

红色是客户端发送的内容, 蓝色是服务器端返回的内容.

咱们一起解析一下:

*3表示 , 客户端即将发送3段内容

哪三段呢? 第一段: '$3 SET'  第二段: '$4 java'   第三段: '$6 python'

更严格地说: 第一段: '$3\r\nSET\r\n'  第二段:'$4\r\njava\r\n'  第三段:'$6\r\npython\r\n'

$符号的意思在上一小节就已经提到过了, 表示下文的内容的长度, 方便服务器进行读取.

例如: $6就已经把python的长度给汇报出来了, 服务器只需要截取区间[index, index+6]就好了, 不需要去找空格在什么地方(找空格的时间复杂度是O(n), 而$6这种写法是O(1) )

Jedis呢?

其实Jedis做的工作大体就是把SET key value 这样的格式转化为下面这种格式, 然后发到Redis服务端:

*3\r\n
$3\r\n
SET\r\n
$3\r\n
key\r\n
$5\r\n
value\r\n