简简单单写一个 Redis 客户端

前言

这篇文章很简单，就是写一个 Java 版本的 Redis Client，而且不是一个生产级别的项目，只是一个验证类型的 demo。用于了解“实现一个 Redis Client” 需要注意哪些事情。

思考

1. 首先，Redis 是一个服务器，有 ip，有端口，那么，我们就可以用 Java 的 Socket 来和他交互，也可以用 telnet 来交互。说白了，就是一个 TCP 服务器，只要打开了 TCP 通道，然后进行一次连接 3 次握手，建立起全双工通道，就能够互相发送数据。

2. 从我们之前的编程经验中，我知道，和一个服务器交互，通常是需要协议的，例如 HTTP 服务器，你需要 HTTP 协议，和 Dubbo 交互，你需要了解 Dubbo 协议，当然，这些都是建立在 TCP 协议之上的。那么，Redis 大概也是有协议的，我们后面再看。

动手

思考了上面的两点，我们可以尝试动手。

我们可以先用 telnet 访问以下本地的 Redis Server，例如 ：telnet 127.0.0.1 6379，如下：

➜  master telnet 127.0.0.1 6379
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
set baby hello
+OK
get baby
$5
hello
del baby
:1
xxx
-ERR unknown command 'xxx'

步骤：

1. 我们连接上了本机的 Redis Server。
2. 执行 set baby hello 命令，也就是保存一个键值对。
3. 返回了 +OK 字符串
4. 然后我们获取刚刚的 baby 字符串。
5. 返回了 $5 换行 hello
6. 然后我们删除了 baby 字符串。
7. 返回了 :1 ，1表示删除成功。
8. 然后我们尝试执行一个不存在的命令。
9. 返回了 -ERR unknown command 'xxx'.

我们使用 Redis 官方提供的 redis-cli 客户端执行这些命令看看结果：

➜  master redis-cli
127.0.0.1:6379> set baby hello
OK
127.0.0.1:6379> get baby
"hello"
127.0.0.1:6379> del baby
(integer) 1
127.0.0.1:6379> xxx
(error) ERR unknown command 'xxx'
127.0.0.1:6379> 

很明显，redis-cli 客户端和 telnet 的使用区别就是返回值的不同，telnet 多了一些奇怪的字符，或者在一些返回值前面加入了一些符合，例如在 OK 前面加入了+ 号。在get baby 后，返回了一个 $5 字符串。我们猜想，telnet 得到的数据是 Redis-Server 真正返回的数据，redis-cli 对这些数据进行了处理。

好了，大概了解了操作，我们用 Java 写一个 Socket 访问一下 Redis Server。

用 Java Socket 访问 Redis Server

代码很简单，如下：

static Socket client = new Socket();
static InputStream is;
static OutputStream os;
static {
    try {
        client.connect(new InetSocketAddress("127.0.0.1", 6379));
        is = client.getInputStream();
        os = client.getOutputStream();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

public static void main(String[] args) throws IOException {

    writeAndFlush("set baby hello \n");

    printResult();
    // result : +OK

    writeAndFlush("get baby \n");

    Sleep.sleep(1);// 等 redis 返回数据

    printResult();
    // result : $5
    // result : hello

    writeAndFlush("del baby \n");

    Sleep.sleep(1);// 等 redis 返回数据

    printResult();
    // result  :1

    writeAndFlush("xxx \n");

    Sleep.sleep(1);// 等 redis 返回数据

    printResult();
    // -ERR unknown command `xxx`, with args beginning with:

    writeAndFlush("mget hello baby \r\n");

    Sleep.sleep(1);
    printResult();

    closeStream();
}

static void writeAndFlush(String content) {

    try {
        os.write(content.getBytes());
        os.flush();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

public static void closeStream() {
    try {
        is.close();
        os.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

static void printResult() {
    try {

        int a = is.available();
        byte[] b = new byte[a];
        is.read(b);

        String result = new String(b);
        System.out.println(result);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

可以看到， 使用 Java Socket 和使用 telnet 的效果是相同的。

所以，要想达到 redis-cli 的效果，那么就需要对返回值进行处理，例如 $5 、:1 这些符号，到底是什么意思？即：解析 redis 自己的应用层协议。

Redis 序列化协议（RESP）

答案就在 redis 的官方文档: 通信协议（protocol）

redis 协议称之为 RESP（REdis Serialization Protocol），即 redis 序列化协议。

该协议的设计目标：

1. 实现简单。
2. 快速解析。
3. 人类易读。

所有的命令一律以 \r\n 结尾。

Redis 收到命令后，对命令进行处理，然后返回数据。

redis 1.2 版本后，支持批量回复：Buik Reply。

关于回复，有多种类型：
通过检查服务器发回数据的第一个字节， 可以确定这个回复是什么类型：

• 状态回复（status reply）的第一个字节是 "+"
• 错误回复（error reply）的第一个字节是 "-"
• 整数回复（integer reply）的第一个字节是 ":"
• 批量回复（bulk reply）的第一个字节是 "$"
• 多条批量回复（multi bulk reply）的第一个字节是 "*"

我们回到我们的 Socket 小程序里，可以看到，

• 当我执行 set 命令，返回的是 +OK，即这个是状态回复。
• 当我们执行 xxx 命令，返回值的开头是 - 号，即这个是错误回复。
• 当我们执行 get 命令，返回的是 $5 hello，即这个是批量回复，同时5表示后面将返回 5 个字节。字符串的最大长度为 512 MB。
• 当我们执行del命令，返回的是:1，表示这个是整数回复，只在操作真正被执行了的时候， 才返回 1 ， 否则返回 0， 1表示 true。
• 当我们执行 mget hello baby \r\n 时，返回的第一个字符就是 * 号，表示这是一个多条批量回复。* 号后面的值记录了多条回复的数量，我们这里返回的是 *2\r\n $5\r\n world \r\n $-1\r\n， *2 表示后面有 2 条回复。$5 表示后面有 5 个字节。 $-1 表示 baby 这个key 是没有数据的，-1 表示什么都没有。

通过对协议的解析，我们就能做出一个类似 redis-cli 的客户端。

我这里抛转引玉，写了一个最简单的，大家看看就好 ：）

public static void respParseHandler(String result) {
       try {
           if (result.startsWith("+")) {
               // 状态回复
               System.out.println(result.substring(1));
               return;
           }
           if (result.startsWith("-")) {
               // 错误回复
               System.err.println(result.substring(1));
               return;
           }

           if (result.startsWith(":")) {
               // 整数回复
               if (result.substring(1).equalsIgnoreCase("1")) {
                   System.out.println("success");
               } else {
                   System.out.println("error");
               }
               return;
           }

           if (result.startsWith("$")) {
               // 批量回复
               if (result.substring(1, 3).equalsIgnoreCase("-1")) {
                   System.out.println("no data, redis return -1");
                   return;
               }
   
               int line = result.indexOf("\r\n");
               System.out.println(result.substring(line + 2));
               return;
           }

           if (result.startsWith("*")) {
               // 多条批量回复
               char num = result.charAt(1);
               int first = result.indexOf('$');
               for (int i = 0; i < Integer.valueOf(String.valueOf(num)); i++) {

                   int next = result.indexOf('$', first + 1);
                   if (next != -1) {
                       respParseHandler(result.substring(first, next));
                   } else {
                       respParseHandler(result.substring(first));
                   }
                   first = next;
               }
           }
       } catch (Exception e) {
           e.printStackTrace();
       }
   }