基于Strophe.js心跳插件strophe.ping.js优化

【原创博文,转载请注明出处!】

目前游戏项目中长连接使用的库是Strophe组件,主要就是strophe.js。
不少优秀同志为这个库编写了一系列开源插件Github库在这里。

Strophe.js库插件使用介绍
Strophe.js库插件目录

为了保证链接的有效性,"心跳❤️"机制是必不可少的。"心跳"逻辑实现起来很简单,刚开始自己使用"Strophe"里面的send方法写了一个心跳脚本(也就是发一个消息给服务器,服务器再反馈一个消息)。但是这个库在长链接无效的时候(俗称“假链接”),使用send方法会报错╮(╯╰)╭,最后还是老老实实使用IQ类型发送心跳吧。所以就寻找到strophe.ping.js这个库。(当然啰,这个strophe.ping.js很简短,我已经修改成Xmpp-ping.js,并将全部代码放在下面了(^^))。
其中strophe.ping.js这个文件,也就是为strophe这个库写的心跳插件,太旧了!!几年没有更新,直接移植到项目运行各种报错☹️(ಥ﹏ಥ),我自己通过谷歌和百度没找到解决方法,估计是用的人也少吧。于是我自己参考strophe.ping.js文件,重新写了个插件Xmpp-ping.js,整个文件代码就在下面,需要者自取。

/*
 * 心跳组件Xmpp-ping.js
 * @Author: Rephontil 
 * @Date: 2018-09-14 09:46:44 
 * @Last Modified by: Damo
 * @Last Modified time: 2018-09-14 11:00:23
 */

var Strophe = require("strophe").Strophe;

Strophe.addConnectionPlugin('ping', {
    connection: null,

    // Strophe.Connection constructor 构造函数
    init: function(conn) {
        this.connection = conn;
        Strophe.addNamespace('PING', "urn:xmpp:ping");
        console.log("Strophe.Connection constructor Initialized!");
    },

    /**
     * Function: ping
     *
     * Parameters:
     * (String) to - The JID you want to ping
     * (Function) success - Callback function on success
     * (Function) error - Callback function on error
     * (Integer) timeout - Timeout in milliseconds
     */
    ping(jid, success, error, timeout) {
        var id = this.connection.getUniqueId('ping');
        // var iq = $iq({type: 'get', to: jid, id: id}).c(
                        // 'ping', {xmlns: Strophe.NS.PING});
        var IQ = this.builderIQ({type: 'get', to: jid, id: id}).c('ping', {xmlns: Strophe.NS.PING});
        this.connection.sendIQ(IQ, success, error, timeout);
    },

    /**
     * Function: pong
     *
     * Parameters:
     * (Object) ping - The ping stanza from the server.
     */
    pong(ping) {
        var from = ping.getAttribute('from');
        var id = ping.getAttribute('id');
        // var iq = $iq({type: 'result', to: from,id: id});
        var IQ = this.builderIQ({type: 'result', to: from,id: id});
        console.log("xmppPong ---->  from = ",from);
        console.log("xmppPong ---->  IQ = ",IQ);
        console.log("xmppPong ---->  id = ",id);
        this.connection.sendIQ(IQ);
    },

    /**
     * Function: addPingHandler
     *
     * Parameters:
     * (Function) handler - Ping handler
     *
     * Returns:
     * A reference to the handler that can be used to remove it.
     */
    addPingHandler(handler) {
        return this.connection.addHandler(handler, Strophe.NS.PING, "iq", "get");
    },

    /**
     * 构建IQ类型消息体
     * @param {消息结构体} attrs 
     */
    builderIQ(attrs){
        return new Strophe.Builder("iq", attrs); 
    },
});


我自己写的Xmpp-ping.js文件中增加了一个方法 builderIQ()用于替换strophe.js库里面的$iq()方法,原先GitHub上面插件库strophe.ping.js就是使用strophe.js自己的$iq()方法,但是由于过时被我替换了。

 /**
     * 构建IQ类型消息体
     * @param {消息结构体} attrs 
     */
    builderIQ(attrs){
        return new Strophe.Builder("iq", attrs); 
    }

使用方法:初始化Strophe,获取长连接实例如connection

connection = new Strophe.Connection(`"服务器url"`, null, DOMImplementation, DOMParser);

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

推荐阅读更多精彩内容