基于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