DIV CSS 佈局教程網

用 jQuery、HTML、CSS 打造 Web IM 即時聊天:串接 Openfire 的完整實作
編輯:JQuery特效代碼     

瀏覽器裡做即時聊天,難點從來不是聊天視窗,而是「訊息怎麼送出去」。這篇文章示範一條完整路徑:瀏覽器以 JavaScript 透過 HTTP 長連接,把 XMPP 封包交給 JabberHTTPBind,再由它轉送給 Openfire 伺服器,對方才會收到訊息。

整體通信流程

用戶 A 在瀏覽器以 jsjac 函式庫送出一則訊息到 JabberHTTPBind 這個 Servlet 容器;JabberHTTPBind 收到後,向 Openfire 送出 XMPP 協定的 XML 報文;Openfire 解析後轉發給指定的用戶 B;JabberHTTPBind 取得 Openfire 回傳的資料,解析後在當前 Session 中找到對應的連線,把訊息推給用戶 B。也就是說,瀏覽器端的所有資料都必須經由 JabberHTTPBind 解析與轉換,才能抵達 Openfire。

成品預覽

可以送表情、改字型樣式(對方看到的也是你設定的樣式),右側可展開/收合商品詳情。

登入與註冊畫面;sendTo 表示登入後要與誰對話,並會建立一個聊天視窗。

登入成功後,可在日誌控制台看到登入狀態,或是在 Firebug 中觀察連線請求的細節。

登入失敗時,畫面只停在 connecting,沒有後續——這通常代表 JabberHTTPBind 沒收到回應,優先檢查伺服器位址設定。

登入後即可對指定用戶發訊息;若要開新對象,按 new Chat 建立新會話。

有新訊息時,瀏覽器標題欄會閃爍提示。

若所有聊天視窗都是關閉狀態,右下角會出現閃動的消息圖示。

開發環境與依賴

系統:Windows;JavaEE 伺服器:Tomcat 5.0.28+ 或 Tomcat 6;瀏覽器:IE6+、Firefox 3.5+、Chrome;JDK 1.6+;Openfire 3.7.1;IDE:Eclipse 3.2 或 MyEclipse 6.5。

Java 端需要 JDK 1.4+、serializer.jar、xalan.jar、jhb-1.0.jar、log4j-1.2.16.jar。其中 jhb-1.0.jar 就是 JabberHTTPBind,作者把編譯後的 class 打包成了 jar。

JavaScript 端:jquery-1.7.1.min.js、jsjac.js(通信核心)、jquery.easydrag.js(視窗拖曳)、local.chat-2.0.js(本地會話視窗)、remote.jsjac.chat-2.0.js(遠程訊息)、send.message.editor-1.0.js(編輯器)。

準備工作

jsjac 下載:https://github.com/sstrigler/JSJaC/。若不偏好 jsjac,也有 jQuery 的 XMPP 外掛可選:https://github.com/maxpowel/jQuery-XMPP-plugin。其他能與 Openfire 溝通的函式庫清單見 https://xmpp.org/xmpp-software/libraries/。easydrag:https://fromvega.com/code/easydrag/jquery.easydrag.js;jQuery:https://code.jquery.com/jquery-1.7.1.min.js。

一、主畫面 index.jsp

<%@ page language="java" pageEncoding="UTF-8" %>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<script type="text/javascript">
window.contextPath = "<%=path%>";
window["serverDomin"] = "192.168.8.22";
</script>
<script type="text/javascript" src="jslib/jquery-1.7.1.min.js"></script>
<script type="text/javascript" src="jslib/jsjac.js"></script>
<script type="text/javascript" src="jslib/send.message.editor-1.0.js"></script>
<script type="text/javascript" src="jslib/jquery.easydrag.js"></script>
<script type="text/javascript" src="jslib/remote.jsjac.chat-2.0.js"></script>
<script type="text/javascript" src="jslib/local.chat-2.0.js"></script>
<script type="text/javascript">
$(function () {
  $("#login").click(function () {
    var userName = $(":text[name='userName']").val();
    var receiver = $("*[name='to']").val();
    // 建立聊天視窗,指定發送者與接收者
    $.WebIM({ sender: userName, receiver: receiver });
    // 登入 openfire
    remote.jsjac.chat.login(document.userForm);
    $("label").text(userName);
    $("form").hide();
    $("#newConn").show();
  });
  $("#logout").click(function () {
    remote.jsjac.chat.logout();
    $("form").show();
    $("#newConn").hide();
    $("#chat").hide(800);
  });
  $("#newSession").click(function () {
    $.WebIM.newWebIM({ receiver: $("#sendTo").val() });
  });
});
</script>

這一段程式裡最要緊的是連線位址設定,一旦寫錯就完全無法通信:

window.contextPath = "<%=path%>";
window["serverDomin"] = "192.168.8.22";

另外兩個進入點也要記住:$.WebIM() 是主函式,可覆寫 local.chat 中的基本設定並建立聊天視窗;$.WebIM.newWebIM() 則是再開一個視窗、只換成新的接收者。

二、遠程通信設定與事件註冊

登入時的參數組成為:

httpbase: window.contextPath + "/JHB/",  // 後台 http-bind 服務器 URL
domain:   window["serverDomin"],          // 當前有效域名
username: "",                            // 登入用戶名
pass:     "",                            // 密碼
timerval: 2000,                          // 請求超時(毫秒)
resource: "WebIM",                       // 連線資源標識
register: true                           // 是否註冊

remote.jsjac.chat-2.0.js 是與 jsjac 串接的核心,負責連線、狀態、訊息收發與錯誤處理:

remote.jsjac.chat = {
  // 設定使用者狀態
  setState: function () {
    var onlineStatus = {};
    onlineStatus["available"]   = "在線";
    onlineStatus["chat"]       = "歡迎聊天";
    onlineStatus["away"]       = "離開";
    onlineStatus["xa"]         = "不可用";
    onlineStatus["dnd"]        = "請勿打擾";
    onlineStatus["invisible"]  = "隱身";
    onlineStatus["unavailable"]= "離線";
    remote.jsjac.chat.state = onlineStatus;
    return onlineStatus;
  },

  // 登入
  login: function (loginForm) {
    remote.console.clear("debug");
    try {
      var connectionConfig = remote.jsjac;
      var connection = new JSJaCHttpBindingConnection(connectionConfig);
      remote.connection = connection;
      remote.jsjac.chat.setupEvent(connection);
      if (loginForm) {
        connectionConfig.username = loginForm.userName.value;
        connectionConfig.pass     = loginForm.password.value;
        connectionConfig.register = loginForm.register.checked;
      }
      connection.connect(connectionConfig);
    } catch (e) {
      remote.console.errorEL().html(e.toString());
    } finally { return false; }
  },

  // 註冊所有事件回呼
  setupEvent: function (con) {
    var remoteChat = remote.jsjac.chat;
    con.registerHandler('message',        remoteChat.handleMessage);
    con.registerHandler('presence',       remoteChat.handlePresence);
    con.registerHandler('iq',             remoteChat.handleIQ);
    con.registerHandler('onconnect',      remoteChat.handleConnected);
    con.registerHandler('onerror',        remoteChat.handleError);
    con.registerHandler('status_changed', remoteChat.handleStatusChanged);
    con.registerHandler('ondisconnect',   remoteChat.handleDisconnected);
    con.registerIQGet('query', NS_VERSION, remoteChat.handleIqVersion);
    con.registerIQGet('query', NS_TIME,    remoteChat.handleIqTime);
  },

  // 發送訊息
  sendMessage: function (msg, to) {
    try {
      if (msg == "") { return false; }
      var user = "";
      if (to) {
        if (!~to.indexOf("@")) {
          user += "@" + remote.jsjac.domain;
          to   += "/" + remote.jsjac.resource;
        } else if (~to.indexOf("/")) {
          user = to.substr(0, to.indexOf("/"));
        }
      } else {
        alert("你沒有指定發送者的名稱");
        return false;
      }
      var message = new JSJaCMessage();
      message.setTo(new JSJaCJID(to));
      message.setType("chat");
      message.setBody(msg);
      remote.connection.send(message);
      return false;
    } catch (e) { return false; }
  },

  // 收到訊息
  handleMessage: function (aJSJaCPacket) {
    var user = aJSJaCPacket.getFromJID().toString();
    var content = aJSJaCPacket.getBody();
    $.WebIM.messageHandler(user, content);
  },

  // 離線
  logout: function () {
    var presence = new JSJaCPresence();
    presence.setType("unavailable");
    if (remote.connection) {
      remote.connection.send(presence);
      remote.connection.disconnect();
    }
  }
};

錯誤碼的處理也值得一看,特別是 409:

case "401": content = "登陸驗證失敗!"; break;
case "409": remote.jsjac.chat.reconnection(); break;   // 重複註冊=已註冊,直接改登入
case "503": content = "無法連接到IM服務器,請檢查相關配置!"; break;
case "500": // 服務器內部錯誤,提供重新連線連結

三、本地聊天視窗 local.chat-2.0.js

這個檔案負責視窗的一切:版面、字型工具列、表情、訊息渲染、拖曳、提示閃爍。它不含通信邏輯,只在使用者按下傳送時呼叫 remote.jsjac.chat.sendMessage(text, receiver)。幾個關鍵片段:

// 判斷是否為手機用戶端:手機只收純文字,PC 可收 HTML
isMobileClient: function (receiver) {
  var moblieClients = ["iphone","ipad","ipod","wp7","android",
                       "blackberry","Spark","warning","symbian"];
  for (var i in moblieClients) {
    if (~receiver.indexOf(moblieClients[i])) { return true; }
  }
  return false;
}

// 新訊息時閃爍標題
messageTip: function () {
  if (count % 2 == 0) {
    window.focus();
    document.title = "你來了新消息,請查收!";
  } else { document.title = ""; }
  if (count > 4) { document.title = ""; count = 0; }
  else { window.setTimeout(_opts.messageTip, 1000); count++; }
}

// 建立新視窗
newWebIM: function (settings) {
  var chatUser = remote.userAddress(settings.receiver);
  var userJID = "u" + hex_md5(chatUser);   // 以 JID 的 md5 當視窗 id
  _opts.initWebIM(userJID, chatUser);
  $("#" + userJID).find(remote.receiver).val(chatUser);
  $("#" + userJID).show(220);
}

用 hex_md5(userJID) 當視窗 DOM id 是個實用小技巧:JID 含有 @ 與 /,直接當 id 或選擇器會出問題,雜湊之後就安全了。

四、訊息編輯器 send.message.editor-1.0.js

輸入區不是 textarea,而是一個 designMode = "on" 的 iframe,这样才能支援字型、顏色、表情等富文本:

init: function (userJID) {
  var doc = sendMessageEditor.getDoc();
  doc.open();
  doc.write(['<html><head><style>body{border:0;margin:0;padding:3px;
    font-size:12px;font-family:Courier,serif,monospace;}</style></head>',
    '<body jid="', userJID, '"></body></html>'].join(""));
  doc.designMode = "on";
  doc.close();
},
execCmd: function (cmd, value, d){
  var doc = d || sendMessageEditor.getDoc();
  doc.execCommand(cmd, false, value === undefined ? null : value);
},
insertAtCursor: function (text, d, w){ /* 跨瀏覽器插入 HTML/文字 */ }

五、樣式與 Servlet 設定

chat-2.0.css 定義視窗外觀:.chat-main 絕對定位並預設 display:none、.radius 以 border-radius 做圓角、工具列以 tb-sprite.gif 精靈圖切出粗體/斜體/底線/表情等圖示。

web.xml 則是把 JabberHTTPBind 掛上去的關鍵:

<servlet>
  <servlet-name>Jabber HTTP Binding Servlet</servlet-name>
  <servlet-class>org.jabber.JabberHTTPBind.JHBServlet</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>Jabber HTTP Binding Servlet</servlet-name>
  <url-pattern>/JHB/</url-pattern>
</servlet-mapping>
<welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
</welcome-file-list>

這個 /JHB/ 路徑必須與前面的 httpbase 設定一致,否則瀏覽器的請求會落到 404。

實作提醒

這套架式的優點是複用成熟協定:XMPP/Openfire 負責帳號、好友、離線訊息與 presence,前端只需專注於呈現。缺點是鏈路長、環節多,除錯時務必逐層確認:瀏覽器請求有沒有發出 → JHB 有沒有收到 → Openfire 有沒有回應 → 對方 Session 是否還活著。

需要提醒的是,這份程式碼寫於 2012 年前後,其中 jQuery.browser、document.execCommand、designMode 等 API 今日多已淘汰或重新定義;資安方面,密碼以明文表單傳送、以 md5 當作身分識別,都不符合現代標準。若要沿用這套架構,建議至少把認證改為 SASL 並全程走 TLS,前端則改用 WebSocket 取代 HTTP BOSH 長輪詢。原始碼可透過作者信箱 hoojo_@126.com 或部落格索取。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved