nodejs仿照WebSocket实现QuickSocket实时通讯框架

一、QuickSocket协议部分

1、标志位:QS,长度16位
2、帧类型:1~255,长度8位,目前定义三种类型,可扩展

0 -> 保留,不可用
1 -> MSG 消息类型
2 -> PING 主动心跳包
3 -> PONG 返回心跳包

3、数据长度:0 ~ 65535,长度16位

如果超过最大长度会丢弃超出部分数据

4、校验码:0 ~ 255, 长度8位,校验协议头部数据

校验码计算方式:头部所有字节取异或

5、数据:长度 0 ~ 65535字节

QuickSocket协议

代码 https://github.com/sxyudi/QuickSocket

二、实现部分
1、QsServer端,建立socket监听服务器,处理事件信息

QsServer.prototype.listen = function(options, customer) {

    options = options || {};
    options.host = options.host || '127.0.0.1';
    options.port = options.port || 80;

    const that = this;
    this.server = net.createServer(function(socket) { 
        console.log("client comming", socket.remoteAddress, socket.remotePort);
        const client = new QsClient(socket);
        client.uid = this.uid++;
        client.ts = Math.floor(Date.now() / 1000);
        that.clients.push(client);
        that.onConnect(client, customer);
    });

    this.server.on("listening", function() {
        console.log("start listening...", options.host, options.port);
        that.onListening(customer);
    });

    this.server.on("error", function(err) {
        console.log("listen error");
        that.onError(err, customer);
    });

    this.server.on("close", function() {
        console.log("server stop listener");
        that.onClose(customer);
    });

    this.server.listen({
        port: options.port,
        host: options.host,
        exclusive: true,
    });
};

2、QsClient端,建立socket链接,处理事件信息

// 处理接受数据
QsClient.prototype.onData = function(data) {

    // 上一次剩余没有处理完的半包;
    if (this.last_pkg) {
        this.last_pkg = Buffer.concat([this.last_pkg, data], this.last_pkg.length + data.length);
    } else {
        this.last_pkg = data;   
    }

    let offset = 0;
    let pkg_head = qspkg.read_pkg_head(this.last_pkg, offset);
    if (!pkg_head.type) {
        if (pkg_head.offset >= this.last_pkg.length) {
            this.last_pkg = null;
        } else if (pkg_head.offset > offset) {
            const buf = Buffer.allocUnsafe(this.last_pkg.length - pkg_head.offset);
            this.last_pkg.copy(buf, 0, pkg_head.offset, this.last_pkg.length);
            this.last_pkg = buf;
        }
        return;
    }

    while(pkg_head.offset + pkg_head.len <= this.last_pkg.length) { // 判断是否有完整的包;
        if (pkg_head.len > 0) {
            // 根据长度信息来读取我们的数据,架设我们穿过来的是文本数据
            const pkg_data = Buffer.allocUnsafe(pkg_head.len);
            this.last_pkg.copy(pkg_data, 0, pkg_head.offset, pkg_head.offset + pkg_head.len);
            this.dispathData(pkg_head.type, pkg_data);
        } else {
            this.dispathData(pkg_head.type);
        }
        offset = pkg_head.offset + pkg_head.len;
        if (offset >= this.last_pkg.length) { // 正好我们的包处理完了;
            break;
        }
        pkg_head = qspkg.read_pkg_head(this.last_pkg, offset);
        if (!pkg_head.type) {
            offset = pkg_head.offset;
            break;
        }
    }
    if (offset >= this.last_pkg.length) {
        this.last_pkg = null;
    } else if (offset > 0) {
        const buf = Buffer.allocUnsafe(this.last_pkg.length - offset);
        this.last_pkg.copy(buf, 0, offset, this.last_pkg.length);
        this.last_pkg = buf;
    }
}

3、qspgk 根据协议处理数据

读取包头部分
    // 根据封包协议我们读取包头;
    read_pkg_head: function(pkg_data, offset) {
        const head = {};
        while (offset + qspkg.HEAD_LEN <= pkg_data.length) {
            const q = pkg_data.readUInt8(offset);
            const s = pkg_data.readUInt8(offset + 1);
            const type = pkg_data.readUInt8(offset + 2);
            const len = pkg_data.readUInt16LE(offset + 3);
            const code = pkg_data.readUInt8(offset + 5);
            if (q !== FLAG_Q || s !== FLAG_S) {
                offset++;
                head.offset = offset;
            } else if (qspkg.calc_head_sum(pkg_data, offset) !== code) {
                offset++;
                head.offset = offset;
            } else {
                head.type = type;
                head.offset = offset + qspkg.HEAD_LEN;
                head.len = len;
                break;
            }
        }
        return head;
    }
封装包头和数据
    // 把一个要发送的数据,封包 包头 + 数据
    // data string 二进制的buffer
    package_data: function(type, data) {
        const data_len = data ? data.length : 0;
        const buf = Buffer.allocUnsafe(qspkg.HEAD_LEN + data_len);
        buf.writeUInt8(FLAG_Q, 0);
        buf.writeUInt8(FLAG_S, 1);
        buf.writeUInt8(type, 2);
        buf.writeUInt16LE(data_len, 3);
        buf.writeUInt8(qspkg.calc_head_sum(buf, 0), 5);
        if (data_len > 0) {
            buf.fill(data, qspkg.HEAD_LEN);
        }
        return buf;
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,837评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,551评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,417评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,448评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,524评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,554评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,569评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,316评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,766评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,077评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,240评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,912评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,560评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,176评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,425评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,114评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,114评论 2 352

推荐阅读更多精彩内容