简简单单写一个 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();
        }
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容

  • 重点参考链接: http://www.cnblogs.com/wangyuyu/p/3786236.html Re...
    Kevin_Junbaozi阅读 2,171评论 0 21
  • 超强、超详细Redis入门教程 转载2017年03月04日 16:20:02 16916 转载自: http://...
    邵云涛阅读 17,427评论 3 313
  • 本文是我自己在秋招复习时的读书笔记,整理的知识点,也是为了防止忘记,尊重劳动成果,转载注明出处哦!如果你也喜欢,那...
    波波波先森阅读 3,421评论 0 40
  • 连日的忙碌,不说多么辛苦,也是心力憔悴的一段焦虑时光。今天,终于放假一天。怎么度过呢? 早上老公悄...
    打灯笼的小星星阅读 846评论 1 2
  • 每年汉族的清明节后的十天左右,傣族的傣历新年泼水节就到了。泼水节又叫“浴佛节”,对于一直传承佛陀教义的南传佛教的傣...
    南之叶阅读 537评论 0 1