手寫Redis客戶端-實現(xiàn)自己的Jedis

上一篇纤掸，我們詳細研究了Redis底層使用的協(xié)議——RESP(REdis Serialization Protocol)，這篇我們在基于理解了RESP原理的基礎上，手寫一個Redis客戶端忧侧，實現(xiàn)一個自己的Jedis（mini版）虐块。
還沒了解Redis底層RESP協(xié)議 的同學吨艇，可以先移步Redis底層協(xié)議RESP詳解，對RESP做一個大致的了解巍实。

Redis分為服務器端/客戶端，并且客戶端除了CLI終端命令行方式哩牍，還支持大多數(shù)主流編程語言棚潦；那么可以大膽推測，這些跨語言的客戶端的實現(xiàn)膝昆，都是遵循RESP協(xié)議規(guī)范的丸边；也都是通過網(wǎng)絡通信、與服務器端進行連接和傳輸數(shù)據(jù)的荚孵。

RESP回顧

RESP在Redis中用作請求-響應協(xié)議的方式如下：

• 客戶端將命令作為Bulk Strings的RESP數(shù)組發(fā)送到Redis服務器妹窖。

• 服務器根據(jù)命令實現(xiàn)回復一種RESP類型。

在RESP中收叶，某些數(shù)據(jù)的類型取決于第一個字節(jié)：

• “+”代表簡單字符串Simple Strings

• “+”代表錯誤類型

• “:”代表整數(shù)

• “$”代表Bulk Strings

• “*”代表數(shù)組
  此外骄呼，RESP能夠使用稍后指定的Bulk Strings或Array的特殊變體來表示Null值。
  在RESP中判没，協(xié)議的不同部分始終以“\r\n”（CRLF）結(jié)束蜓萄。

通過攔截TCP傳輸?shù)臄?shù)據(jù)，我們在redis-cli客戶端執(zhí)行SET key value ;
攔截到對應的resp通信協(xié)議串

*3
$3
SET
$3
key
$5
value

基于上篇對RESP的分析澄峰，我們應該能快速推斷嫉沽，如果要執(zhí)行SET abc 1234，對應的resp通信協(xié)議串為：

*3
$3
SET
$3
abc
$4
1234

原理其實很簡單俏竞；我們實現(xiàn)的客戶端绸硕，只要將這個協(xié)議串，基于socket發(fā)送給redis-server魂毁，進完成了一個set操作玻佩，在redis-server執(zhí)行了SET abc 1234;
按resp協(xié)議的請求-響應模型，如果redis-server執(zhí)行成功漱牵，會返回+OK\r\n夺蛇；

簡潔版Jedis

下面，我們基于以上推斷酣胀，快速實現(xiàn)一個簡潔版Redis客戶端刁赦；

分析：

1、建立連接
SimpleJedis的構(gòu)造方法闻镶，完成建立連接甚脉；
我們平時使用Jedis時，其實本質(zhì)也是一樣的實現(xiàn)铆农；

Jedis jedis = new Jedis("172.17.19.22");//創(chuàng)建client
jedis.set("key", "value");//創(chuàng)建socket連接牺氨，發(fā)送socket流

2狡耻、set 命令
SimpleJedis#set(K, V)方法執(zhí)行set命令；
客戶端發(fā)給redis-server的序列串猴凹，就是按前面的分析夷狰，分別替換K的長度和實際K內(nèi)容，以及V的長度和V的內(nèi)容郊霎；

3沼头、get 命令
get(Key)命令，應該給redis-server發(fā)送什么樣的協(xié)議串呢书劝？
這個需要按 上篇文章那樣进倍，去攔截TCP傳輸?shù)臄?shù)據(jù)，以此來窺探购对。攔截get命令的TCP數(shù)據(jù)猾昆，就不具體演示了，可以參考上一篇文章骡苞。
這里我直接給出結(jié)論垂蜗；
當執(zhí)行 get abc;命令時，發(fā)送給redis-server的協(xié)議串是：

*2
$3
GET
$3
abc

第一行*2表示這條發(fā)給Redis server的命令是數(shù)組烙如，數(shù)組有2個元素(其實就是get么抗、abc、這倆字符串)亚铁；
后面的4行數(shù)據(jù)蝇刀，分別是對數(shù)組2個元素的表示，每個元素用兩行徘溢；具體含義可以參見上一篇文章吞琐。

最后給出完整示例：

/**
 * 簡潔版-Redis客戶端
 * A new redis client for Java.
 */
public class SimpleJedis {

    private Socket socket = null;

    public SimpleJedis() {
        try {
            socket = new Socket("127.0.0.1", 6379);

            socket.setReuseAddress(true);
            socket.setKeepAlive(true);
            socket.setTcpNoDelay(true);
            socket.setSoLinger(true, 0);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public String set(final String key, String value) throws IOException {

        StringBuilder stringBuilder = new StringBuilder();

        stringBuilder.append("*3").append("\r\n");

        stringBuilder.append("$3").append("\r\n");

        stringBuilder.append("SET").append("\r\n");

        stringBuilder.append("$").append(key.length()).append("\r\n");

        stringBuilder.append(key).append("\r\n");

        stringBuilder.append("$").append(value.length()).append("\r\n");

        stringBuilder.append(value).append("\r\n");
        socket.getOutputStream().write(stringBuilder.toString().getBytes());

        InputStream inputStream = socket.getInputStream();
        byte b[] = new byte[inputStream.available()];
        inputStream.read(b);
        return new String(b);
    }

    public String get(final String key) throws IOException {

        StringBuilder sb = new StringBuilder();

        sb.append("*2").append("\r\n");

        sb.append("$3").append("\r\n");

        sb.append("GET").append("\r\n");

        sb.append("$").append(key.length()).append("\r\n");

        sb.append(key).append("\r\n");

        socket.getOutputStream().write(sb.toString().getBytes());

        InputStream inputStream = socket.getInputStream();
        byte b[] = new byte[1024];
        int len = inputStream.read(b);
        return new String(b, 0, len).split("\r\n")[1];
    }

    public static void main(String[] args) throws IOException {
        SimpleJedis myJedis = new SimpleJedis();

        System.out.println(myJedis.set("mt", "2020"));//+OK
        System.out.println(myJedis.get("mt"));// "2020"
    }
}

啟動redis-server后，運行程序然爆，就能驗證結(jié)果了站粟。

進化版

朝著架構(gòu)師的目標，向前邁一步曾雕。一個可復用的客戶端組件奴烙，應該怎樣設計、實現(xiàn)呢剖张！

建立連接后 傳輸數(shù)據(jù)切诀，是redis規(guī)范約定的“協(xié)議”。
我們在使用Jedis客戶端時搔弄，直接操作的是API幅虑；執(zhí)行set、get操作顾犹，并沒有讓我們自己進行按“協(xié)議”拼裝數(shù)據(jù)倒庵；
同時客戶端傳輸數(shù)據(jù)到server端褒墨，對我們使用者來說，也是無感知的擎宝。
因此我們不妨也分層來實現(xiàn)郁妈。

要實現(xiàn)一個redis客戶端，需要考慮

• 傳輸層 Connection

• 協(xié)議層 RedisProtocol

• API層 RedisClient

以下是對應的實現(xiàn):

傳輸層 Connection

負責連接的建立绍申，數(shù)據(jù)發(fā)送與接收圃庭；

/**
 * 傳輸層
 * 負責連接的建立，數(shù)據(jù)發(fā)送與接收
 */
public class Connection {


    private Socket socket;
    private String host;
    private int port;
    private OutputStream outputStream;
    private InputStream inputStream;

    public Connection(String host, int port) {
        this.host = host;
        this.port = port;
    }

    public Connection connection() {
        try {
            socket = new Socket(host, port);
            outputStream = socket.getOutputStream();
            inputStream = socket.getInputStream();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return this;
    }

    public Connection sendCommand(RedisProtocol.Command command, byte[]... args) {
        connection();
        RedisProtocol.sendCommand(outputStream, command, args);
        return this;
    }

    public String getStatusReply() {
        try {
            byte[] bytes = new byte[1024];
            inputStream.available();
            int len = inputStream.read(bytes);
            return new String(bytes, 0, len);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

協(xié)議層 RedisProtocol

負責RESP協(xié)議串的拼裝失晴；

/**
 * redis客戶端
 * 消息協(xié)議層
 */
public class RedisProtocol {

    public static final String DOLLAR_BYTE = "$";
    public static final String ASTERISK_BYTE = "*";
    public static final String BLANK_STRING = "\r\n";

    /**
     * redis操作命令 枚舉
     */
    public static enum Command {
        PING, SET, GET
    }

    /**
     * 發(fā)送命令
     *
     * @param os
     * @param command
     * @param args
     */
    public static void sendCommand(OutputStream os, Command command, byte[]... args) {
        StringBuffer sb = new StringBuffer();
        sb.append(ASTERISK_BYTE).append(args.length + 1).append(BLANK_STRING);
        sb.append(DOLLAR_BYTE).append(command.name().length()).append(BLANK_STRING);
        sb.append(command.name()).append(BLANK_STRING);

        for (byte[] arg : args) {
            sb.append(DOLLAR_BYTE).append(arg.length).append(BLANK_STRING);
            sb.append(new String(arg)).append(BLANK_STRING);
        }

        try {
            os.write(sb.toString().getBytes());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

API層 RedisClient

頂層API，供用戶使用拘央；

public class RedisCilent {


    private Connection connection;

    public RedisCilent(String host, int port) {
        connection = new Connection(host, port);
    }


    public String set(String key, String value) {
        connection.sendCommand(RedisProtocol.Command.SET, key.getBytes(), value.getBytes());
        return connection.getStatusReply();
    }


    public String get(String key) {
        connection.sendCommand(RedisProtocol.Command.GET, key.getBytes());
        return connection.getStatusReply();
    }


    public static void main(String[] args) {
        RedisCilent cilent = new RedisCilent("127.0.0.1", 6379);
        System.out.println(cilent.set("mt", "2011"));
        System.out.println(cilent.get("mt"));
    }
}

舉一反三

我們經(jīng)常使用Jedis涂屁，對Redis進行各種操作。一番探究下來灰伟，其實本質(zhì)就是客戶端程序和服務端建立連接拆又，在指定的端口傳輸“指令數(shù)據(jù)”；
只是“指令數(shù)據(jù)”栏账，需要按照約定的格式帖族。

Jedis客戶端和redis-server之間就是普通的網(wǎng)絡通信。特殊之處挡爵，就是Redis采用的序列化協(xié)議RESP是非二進制竖般、人類可讀的。

其實茶鹃，其他組件的客戶端涣雕，也是通過類似的模式；
1闭翩、MySQL客戶端挣郭，和mysql-server進行交互，也是通過TCP疗韵，默認在3306端口兑障；
2、Zookeeper客戶端蕉汪，和server端交互流译、傳輸指令，也是通過TCP連接肤无，默認在2181端口先蒋；
3、……
這些客戶端和對應server的交互宛渐，本身就是基于tcp的一個Request/Response模式竞漾。
是不是眯搭，可以列舉很多呢。其實了解了底層原理业岁，一通百通鳞仙。

我們實現(xiàn)的mini版 Jedis，只是實現(xiàn)了最核心的set笔时、get操作棍好；然而對于操作Redis來說，雖然這是最基礎允耿、最核心的借笙，但真正完備的Redis客戶端，還應該支持 諸如連接斷開重試较锡、pipeline管道操作等业稼。
但本文的最終目的并不是重復造一個輪子，而是通過對底層原理的研究蚂蕴，做到反推低散、和驗證，進而舉一反三骡楼。
（偷偷告訴你熔号，進階版Jedis更像Jedis的源碼哦~）

本文首發(fā)于公眾號 架構(gòu)道與術(shù)(ToBeArchitecturer)，歡迎關(guān)注鸟整、共同進步~

關(guān)注公眾號引镊，回復redis，獲得完整源碼篮条。