Redis协议:RESP

Redis服务器与客户端通过RESP(REdis Serialization Protocol)协议通信。

RESP协议支持的数据类型

Simple String第一个字节以+开头,随后紧跟内容字符串(不能包含CR LF),最后以CRLF结束。很多Redis命令执行成功时会返回"OK","OK"就是一个Simple String

"+OK\\r\\n"

Error的结构与Simple String很像,但是第一个字节以-开头:

"-ERR unknown command 'foobar'"

-符号后的第一个单词代表错误类型,ERR代表一般错误,WRONGTYPE代表在某种数据结构上执行了不支持的操作。

Integer第一个字节以:开头,随后紧跟数字,以CRLF结束:

":1000\\r\\n"

很多Redis命令会返回Integer,例如INCR LLEN等。

Bulk String是一种二进制安全的字符串结构,整个结构包含两部分。第一部分以$开头,后面紧跟字符串的字节长度,CRLF结尾。第二部分是真正的字符串内容,CRLF结尾,最大长度限制为512MB。一个Bulk String结构的"Hello World!"是:

"$12\\r\\nHello World!\\r\\n"

空字符串是:

"$0\\r\\n\\r\\n"  

nil是:

"$-1\\r\\n"

Array也可以看成由两部分组成,第一部分以*开头,后面紧跟一个数字代表Array的长度,以CRLF结束。第二部分是每个元素的具体值,可能是Integer,可能是Bulk StringArray结构的["hello", "world"]是:

"*2\\r\\n$5\\r\\nhello\\r\\n$5\\r\\nworld\\r\\n"

Array

"*-1\\r\\n"
通过RESP协议与服务端通信

了解了Redis协议的基本数据类型,就可以通过Socket与Redis Server进行通信:

package me.likeyao.yingzong.example;

import java.io.InputStream;
import java.io.OutputStream;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.nio.charset.Charset;

/**
 * Created by yingzong on 16/6/15.
 */
public class SimpleProtocol {

    public static void main(String[] args) throws Exception{
        Socket socket = new Socket();
        //TIME_WAIT状态下可以复用端口
        socket.setReuseAddress(true);
        //空闲时发送数据包,确认服务端状态
        socket.setKeepAlive(true);
        //关闭Nagle算法,尽快发送
        socket.setTcpNoDelay(true);
        //调用close方法立即关闭socket,丢弃所有未发送的数据包
        socket.setSoLinger(true, 0);
        //连接server
        socket.connect(new InetSocketAddress("localhost", 6379), 3000);
        //设置读取时超时时间
        socket.setSoTimeout(3000);

        OutputStream os = socket.getOutputStream();
        /**
         * SET 命令
         * 协议: array 3个元素 SET simpleKey simpleValue
         */
        os.write(getBytes("*3\\r\\n$3\\r\\nSET\\r\\n$9\\r\\nsimpleKey\\r\\n$11\\r\\nsimpleValue\\r\\n"));
        os.flush();

        InputStream is = socket.getInputStream();

        /**
         * 解析SET命令的返回结果
         */
        String result = analysisResult(is);

        System.out.println("SET command response : " + result);
        System.out.println();

        /**
         * GET 命令
         * 协议: array 2个元素 GET simpleKey
         */
        os.write(getBytes("*2\\r\\n$3\\r\\nGET\\r\\n$9\\r\\nsimpleKey\\r\\n"));
        os.flush();

        /**
         * 解析GET命令返回结果
         */
        String value = analysisResult(is);
        System.out.println("GET command response : " + value);

        is.close();
        os.close();
        socket.close();
    }

    /**
     * 解析返回结果
     * @param is
     * @return
     * @throws Exception
     */
    private static String analysisResult(InputStream is) throws Exception{
        /**
         * 第一个字节指定返回的数据结构类型
         */
        byte type = (byte)is.read();

        System.out.println("response type is : " + (char)type);

        if(type == '+'){
            //Simple String类型
            return readCRLF(is);
        }else if(type == '$'){
            //Bulk String类型
            int len = readIntCRLF(is);
            System.out.println("$ value len : " + len);
            return readFixedLen(is, len);
        }

        return null;
    }

    /**
     * 读取int值,直到遇到CRLF
     * @param is
     * @return
     * @throws Exception
     */
    private static int readIntCRLF(InputStream is) throws Exception{
        return Integer.parseInt(readCRLF(is));
    }

    /**
     * 读取字符串,直到遇到CRLF
     * @param is
     * @return
     * @throws Exception
     */
    private static String readCRLF(InputStream is) throws Exception{
        byte b = (byte)is.read();
        StringBuilder sb = new StringBuilder();
        //不是最后一个输入字节时
        while(b != -1){
            //判断是否是CR,如果不是加入sb中
            if(b != '\\r'){
                sb.append((char)b);
            }else{
                //如果是CR,继续读取一个字节,如果不是LF,报错
                byte oneMore = (byte)is.read();
                if(oneMore != '\\n'){
                    throw new RuntimeException("CRLF error!");
                }else{
                    break;
                }
            }
            b = (byte)is.read();
        }
        return sb.toString();
    }

    /**
     * 读取固定字节长度的字符串
     * @param is
     * @param len
     * @return
     * @throws Exception
     */
    private static String readFixedLen(InputStream is, int len) throws Exception{
        byte[] bytes = new byte[len];
        for(int i = 0; i < len; i++){
            bytes[i] = (byte)is.read();
        }
        //CR
        is.read();
        //LF
        is.read();
        return new String(bytes, "UTF-8");
    }

    private static byte[] getBytes(String str) throws Exception{
        return str.getBytes(Charset.forName("UTF-8"));
    }

}


=>
response type is : +
SET command response : OK

response type is : $
$ value len : 11
GET command response : simpleValue

代码执行了两个命令:

SET simpleKey "simpleValue"  => "OK"

GET simpleKey => "simpleValue"

analysisResult方法目前只支持了+ $两种格式的解析,其他格式解析方式类似,就不一一实现了。

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

推荐阅读更多精彩内容

  • 网络通信离不开各种各样的协议,著名的tcp,http等协议构建了我们常见的web应用。http协议是基于tcp的应...
    人世间阅读 1,669评论 0 1
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,857评论 6 13
  • 小伙伴们都说女孩子长胖了,我在做新的尝试…… 希望找到不一样的自己
    所谓荼靡阅读 238评论 1 2
  • 满清在入主中原之前,在关外建立了大金国,大金国的国都原先在辽阳,后迁都沈阳。大金国的皇帝是努尔哈赤,在萨尔浒战役中...
    戚盛鹏阅读 593评论 0 0
  • 不知道从什么时候开始,我们的朋友圈里充斥着各种广告:鞋子,奶粉、护肤品......不同微商做生意也各有一套。有些人...
    宜之秋阅读 298评论 0 0