手寫一個 Redis 客戶端，So easy～-有解無憂

前言

這篇文章很簡單，就是寫一個 Java 版本的 Redis Client，而且不是一個生產級別的專案，只是一個驗證型別的 demo，用于了解 “實作一個 Redis Client” 需要注意哪些事情，

思考

首先，Redis 是一個服務器，有 ip，有埠，那么，我們就可以用 Java 的 Socket 來和他互動，也可以用 telnet 來互動，說白了，就是一個 TCP 服務器，只要打開了 TCP 通道，然后進行一次連接 3 次握手，建立起全雙工通道，就能夠互相發送資料，
從我們之前的編程經驗中，我知道，和一個服務器互動，通常是需要協議的，例如 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'

步驟：

我們連接上了本機的 Redis Server，
執行 set baby hello 命令，也就是保存一個鍵值對，
回傳了 +OK 字串
然后我們獲取剛剛的 baby 字串，
回傳了 $5 換行 hello
然后我們洗掉了 baby 字串，
回傳了 :1 ，1表示洗掉成功，
然后我們嘗試執行一個不存在的命令，
回傳了 -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：
http://redisdoc.com/topic/protocol.html)

redis 協議稱之為 RESP（REdis Serialization Protocol），即 redis 序列化協議，

該協議的設計目標：

實作簡單，
快速決議，
人類易讀，

所有的命令一律以 \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();
    }
}

作者：莫那一魯道
鏈接：https://www.jianshu.com/p/1aab4cbe4c3b
近期熱文推薦：

1.Java 15 正式發布， 14 個新特性，重繪你的認知！！

2.終于靠開源專案弄到 IntelliJ IDEA 激活碼了，真香！

3.我用 Java 8 寫了一段邏輯，同事直呼看不懂，你試試看，，

4.吊打 Tomcat ，Undertow 性能很炸！！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/207944.html

標籤：Java

上一篇：Spring Security 實戰干貨：OAuth2第三方授權初體驗

下一篇：程式人生｜從網癮少年到微軟、BAT、位元組offer收割機逆襲之路