通用的WebSocket封装

一个通用的websocket封装实例,包括Api的回调,消息发送,连接关闭。连接出错重连,重连次数限制,重连超时停止操作等

/**
 * 
 * @param {配置} originalConfig 
 */
var wbst = /** @class */ (function (window) {
    //重连开始时间
    var reConnectBeginTime;
    //重连计数
    var reConnectNum = 1;
    //重连次数限定
    var limitReConnectNum = 3;
    //重连timer
    var reConnectTimer;
    // 构造函数
    function websocket(originalConfig) {
        /**
         * originalConfig 
         *      url         string  //链接的url
         *      host        string  //主机名   有url则不传,url需要有主机名
         *      protocols   string  //链接使用的协议 ws wss 默认根据location进行判断 http ws or htps wss   
         *                              有url则不传,url需要有协议
         *      port        string  //例 ':8080' 端口号 有url则不传,url需要有端口
         *      message     string  //连接成功后默认发送的数据,并且在执行send如果没有传递参数,则默认发送该值
         * 
         *      onopen: function () {}, //连接成功后触发发
         *      onmessage: function () {},  //接收到消息触发
         *      onclose: function () {},    //关闭后触发
         *      onbeforeclose:function(){}  //关闭之前触发
         *      onerror: function () {},    //发生错误后触发
         * 
         */
        /**
         * Wbst实例     close   //关闭连接
         *              send    //发送消息
         */
        //默认配置参数
        var defaultConfig = {
            protocol: location.protocol == 'http:' ? 'ws:' : 'wss:',
            port: location.port,
            ws: null,
            timeout: 5000,
            onopen: function () { },
            onmessage: function () { },
            onclose: function () { },
            onerror: function () { },
            onbeforeclose: function () { }
        }
        //主机名
        var host = location.hostName;
        //路径
        var pathName = location.pathname;
        //是否心跳状态,为false不可操作,等待重连
        this.isHeartFlat = false;
        //重连状态
        this.isReconnect = false;

        originalConfig ?
            this.config = Object.assign({}, defaultConfig, originalConfig) :
            this.config = defaultConfig;

        this.config.protocol.indexOf(':') == -1 ? config.protocol += ':' : '';
        //如果没有定义url,则拼接url
        if (typeof this.config.url == 'undefined') {
            this.config.url = this.config.protocol + "http://" + host + ":" + this.config.port + pathName;
        }

        //发送消息函数
        this.send = function (message) {
            if (!this.ws) {
                console.error("websocket链接已关闭", this);
                return;
            }
            //如果没有传值,则默认发送配置的默认消息
            if (typeof message == 'undefined' && typeof this.config.message != 'undefined') {
                message = this.config.message;
            }
            //判断心跳检测,连接是否存在或已连接
            if (!this.isHeartFlat) {
                // console.error("websocket未连接或出现故障或已断开,正在重新发送...");
                var _self = this;
                // var timeout = setTimeout(function () {}, 0);
                var timeout = setTimeout(function () {
                    var interval = setInterval(function () {
                        if (_self.ws.readyState === 1) {
                            clearTimeout(timeout);
                            clearInterval(interval);
                            timeout = null;
                            interval = null;
                            _self.send(message);
                            // console.log("websocket已发送请求");
                        } else {
                            clearTimeout(timeout);
                            clearInterval(interval);
                            console.error("websocket链接异常", this);
                        }
                    }, 100);
                }, 0);
                return;
            } else {
                this.ws.send(message);
            }
        }
        //关闭连接
        this.close = function () {
            if (!this.ws) {
                console.error("链接已关闭");
                return;
            }
            this.config.onbeforeclose(this.config, this.ws);
            this.ws.close();
        }

        this.init();
    }
    //初始化
    websocket.prototype.init = function () {
        var _self = this;

        window.WebSocket = window.WebSocket || window.MozWebSocket;
        if (!window.WebSocket) {
            console.error("浏览器不支持WebSocket");
            return;
        }

        var ws = new WebSocket(this.config.url);
        ws.onopen = function (e) {
            _self.onopen(e);
        };
        ws.onmessage = function (e) {
            _self.onmessage(e);
        };
        ws.onclose = function (e) {
            _self.onclose(e);
        };
        ws.onerror = function (e) {
            _self.onerror(e);
        }

        this.ws = ws;
        return;
    }
    //连接成功
    websocket.prototype.onopen = function (e) {
        this.isHeartFlat = true;
        this.config.onopen(e);
        if (typeof this.config.message != 'undefined') {
            this.ws.send(this.config.message);
        }
    }
    //接收消息回调
    websocket.prototype.onmessage = function (e) {
        this.config.onmessage(e);
    }
    //连接出错回调,默认执行重连操作
    websocket.prototype.onerror = function (e) {
        var _self = this;

        //心跳值为false
        this.isHeartFlat = false;
        this.config.onerror(e);

        if (reConnectNum <= limitReConnectNum) {
            //开始重连
            console.error('WebSocket连接出错,正在重连...');
            clearTimeout(reConnectTimer);
            reConnectTimer = setTimeout(function () {
                if (reConnectNum == 1) {
                    reConnectBeginTime = new Date();
                }

                console.log('尝试第' + reConnectNum + '次重连');
                _self.isReconnect = true;
                _self.reConnect();

                //如果心跳值为true,则重连成功
                if (_self.isHeartFlat) {
                    clearTimeout(reConnectTimer);
                    reConnectTimer = null;
                }
            }, 2000);
        } else {
            console.error('重连次数超出设定值,不再重连,请检查配置项');
        }
    }
    //关闭回调
    websocket.prototype.onclose = function (e) {
        this.isHeartFlat = false;
        this.config.onclose(e);
    }
    //重连操作
    websocket.prototype.reConnect = function () {
        //如果没有触发重连操作,则不执行
        if (!this.isReconnect) return;

        //判断重连超时,若超时,则不再重连
        if (new Date() - reConnectBeginTime > this.config.timeout) {
            console.error("websocket重连超时");
            this.isReconnect = false;
            //清除重连延时器
            clearTimeout(reConnectTimer);
            reConnectTimer = null;
            return;
        }

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

推荐阅读更多精彩内容

  • 原文地址:http://www.ibm.com/developerworks/cn/java/j-lo-WebSo...
    敢梦敢当阅读 8,895评论 0 50
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,733评论 0 15
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,094评论 1 32
  • 山高峰远烟雾漫, 林盛野深村更深。 人声阵阵喊青天, 晨孩熟路寻奶吃。
    海南黑哥阅读 261评论 2 12
  • 这不是一次愉快的旅行,至少对我来说不是。一个小小的大巴车里塞满了三四十个人,男男女女,神色各异,被送到一个固定的地...
    桜妧阅读 287评论 0 0