【原創(chuàng)博文,轉(zhuǎn)載請注明出處踪栋!】
目前游戲項目中長連接使用的庫是Strophe組件祭饭,主要就是strophe.js。
不少優(yōu)秀同志為這個庫編寫了一系列開源插件Github庫在這里盹舞。
為了保證鏈接的有效性产镐,"心跳??"機制是必不可少的。"心跳"邏輯實現(xiàn)起來很簡單踢步,剛開始自己使用"Strophe"
里面的send
方法寫了一個心跳腳本(也就是發(fā)一個消息給服務(wù)器癣亚,服務(wù)器再反饋一個消息)。但是這個庫在長鏈接無效的時候(俗稱“假鏈接”)获印,使用send
方法會報錯╮(╯╰)╭述雾,最后還是老老實實使用IQ
類型發(fā)送心跳吧。所以就尋找到strophe.ping.js
這個庫兼丰。(當(dāng)然啰玻孟,這個strophe.ping.js
很簡短,我已經(jīng)修改成Xmpp-ping.js
鳍征,并將全部代碼放在下面了(^^))黍翎。
其中strophe.ping.js
這個文件,也就是為strophe
這個庫寫的心跳插件艳丛,太舊了O坏А!幾年沒有更新氮双,直接移植到項目運行各種報錯??(?﹏?)碰酝,我自己通過谷歌和百度沒找到解決方法,估計是用的人也少吧戴差。于是我自己參考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 構(gòu)造函數(shù)
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");
},
/**
* 構(gòu)建IQ類型消息體
* @param {消息結(jié)構(gòu)體} attrs
*/
builderIQ(attrs){
return new Strophe.Builder("iq", attrs);
},
});
我自己寫的Xmpp-ping.js文件中增加了一個方法 builderIQ()
用于替換strophe.js庫里面的$iq()
方法弄痹,原先GitHub上面插件庫strophe.ping.js就是使用strophe.js自己的$iq()
方法饭入,但是由于過時被我替換了嵌器。
/**
* 構(gòu)建IQ類型消息體
* @param {消息結(jié)構(gòu)體} attrs
*/
builderIQ(attrs){
return new Strophe.Builder("iq", attrs);
}
使用方法:初始化Strophe,獲取長連接實例如connection
:
connection = new Strophe.Connection(`"服務(wù)器url"`, null, DOMImplementation, DOMParser);
connection.ping.ping( "服務(wù)器url",function(stanza){
//成功回調(diào)
connection.ping.pong(stanza); //響應(yīng)pong
""},function(stanza){
//失敗回調(diào)
//記錄失敗次數(shù)谐丢,達(dá)到閾值爽航,嘗試重連。
},timeOut);