Web 2.0 熱潮帶紅了一批技術,AJAX 便是其中頗為實用的一員。本文以 EasyJF 開源團隊實際開發的線上會議系統為例,分享從功能規劃、技術選型到核心代碼的完整設計思路。
這套會議系統主要服務於團隊成員的線上討論,模擬傳統會議形式:可同時開設多個不同主題的會議室,每個會議室都需要訪問權限控制;會議中可指定發言模式(排隊發言或自由發言);系統自動記錄每個會議室的發言,供與會者長期查閱。
用戶方面支持游客帳號入會,同時預留了與其他用戶系統(如官網論壇)的對接接口。目前以文字聊天為主,並為語音、視頻保留了擴展空間。
服務器端是整個系統的核心。第一步是對會議室進行抽象建模,一個會議室對象應包含主題、簡介、人數上限、公告、類型、訪問權限、房間密碼、當前與排隊發言人等信息,封裝為 ChatRoom:
public class ChatRoom {
private String cid; // 主鍵
private String title; // 會議室主題
private String intro; // 會議室簡介
private String announce; // 會議室公告
private String owner; // 創建人
private Integer maxUser; // 最大在線人數
private Integer intervals; // 最大刷新時間間隔
private String vrtype; // 訪問權限
private String vrvalue; // 訪問值
private Integer status; // 會議室狀態
private Date inputTime;
}
再來需要一個管理會議室的類,負責啟動、關閉會議等操作,同時承擔定時檢測在線狀態(防止用戶意外掉線)、把內存中的歷史發言寫入文本文件等工作。這些職責可以交給 ChatService:
public class ChatService implements Runnable {
private static final Map service = new HashMap(); // 當前所有會議室
private static final int maxServices = 10; // 可同時開啟的最大會議室數
private static final SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd");
private final List msgs; // 聊天信息 Chat
private final List users; // 在線用戶 ChatUser
private final List talkers; // 排隊發言人 Talker
private final List manager; // 會議室管理員
private Talker currentTalker; // 當前發言人
public ChatService() {
this.msgs = new ArrayList();
this.users = new ArrayList();
this.talkers = new ArrayList();
this.manager = new ArrayList();
this.maxUser = 1000; // 最大 1000 人同時在線
this.interval = 1000 * 60 * 5; // 5 分鐘以前的舊信息
}
}
發言信息封裝為 Chat 類,記錄發言人、接收人、內容、時間與類型:
public class Chat {
private String cid;
private String sender;
private String reciver;
private String content;
private Date vdate;
private Integer types;
private Integer status;
}
與會者信息則用 ChatUser 表示,包含名稱、IP、端口與狀態;當前發言人另用 Talker 類描述,記錄發言開始與預計結束時間。
public class ChatUser {
private String ip;
private String port;
private String userName;
private Date lastAccessTime;
private Integer status;
}
在運行方式上,會議室服務採用多線程:每啟動一個會議就新開一條線程,各自維護自己的會議狀態、在線人員、發言人,並負責保存歷史與清理內存。
客戶端分為兩部分。第一部分是會議室管理界面,負責會議室的增刪改查以及啟動、關閉操作,直接借助 EasyJWeb Tools 的 AbstractCrudAction 業務引擎與代碼生成工具即可快速完成,屬於傳統 Java Web 技術。
第二部分才是會議系統主體,又分為兩個頁面:會議室選擇頁(列出已啟動的會議室供用戶進入)與會議主界面(所有交互都在這裡進行)。主界面需要不斷與服務器交換數據,包括用戶發言、他人發言、會議室狀態等;其中發言需要即時響應,而狀態類信息則可定時刷新。
在與服務器通信的方式上,Socket 編程相對複雜,因此選擇「刷新頁面」這條路;而在多種刷新方案中,AJAX 因為用戶幾乎感覺不到頁面刷新、體驗最佳而脫穎而出。於是,用戶發言時直接用 XMLHttpRequest POST 到服務器;同時在客戶端啟動定時器,週期性地拉取他人的發言與會議狀態(在線人數、當前發言人、公告等)並刷新到界面。鎖定會議室、踢人、指定發言時長、加密碼等操作,也都通過 XMLhttp 向服務器發送命令來實現。
由於系統與官網論壇、後台管理集成在一起,ChatService 同時承擔了會議室管理與會議服務兩職:
package com.easyjf.chat.business;
public class ChatService implements Runnable {
private static final Map service = new HashMap();
private static final int maxServices = 10;
private static final SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd");
private final List msgs;
private final List users;
private final List talkers;
private final List manager;
private Talker currentTalker;
private String cid;
private String title;
private String intro;
private String owner;
private int maxUser;
private int interval;
private String vrtype;
private String vrvalue;
private String announce;
private String passWord;
private int status;
private String filePath;
private boolean isStop = false;
public ChatService() {
this.msgs = new ArrayList();
this.users = new ArrayList();
this.talkers = new ArrayList();
this.manager = new ArrayList();
this.maxUser = 1000;
this.interval = 1000 * 60 * 5;
}
// 停止所有會議室
public static void clear() {
if (!service.isEmpty()) {
Iterator it = service.values().iterator();
while (it.hasNext()) {
ChatService chat = (ChatService) it.next();
chat.stop();
}
}
service.clear();
}
// 創建會議室
public static ChatService create(String name) {
ChatService ret = null;
if (service.containsKey(name)) {
ChatService s = (ChatService) service.get(name);
s.stop();
service.remove(name);
}
if (service.size() < maxServices) {
ret = new ChatService();
service.put(name, ret);
}
return ret;
}
// 停止某個會議室
public static boolean close(String name) {
ChatService chatRoom = ChatService.get(name);
if (chatRoom != null) {
chatRoom.stop();
service.remove(name);
}
return true;
}
// 取得會議室信息
public static ChatService get(String name) {
if (service.containsKey(name)) return (ChatService) service.get(name);
else return null;
}
public void run() {
while (!isStop) {
this.Flash();
try {
Thread.sleep(5000);
} catch (Exception e) {
e.printStackTrace();
}
}
}
public void stop() {
this.FlashAll();
isStop = true;
}
// 會議室中有人發言
public boolean talk(Chat chat) {
boolean ret = false;
if (canTalk(chat.getSender())) {
this.msgs.add(chat);
ret = true;
}
return ret;
}
public boolean exit(ChatUser user) {
talk(geneSystemMsg(user.getUserName() + "退出了會議室!"));
return this.users.remove(user);
}
// 刷新信息,保存會議信息
public void Flash() {
FlashChatMsg();
FlashChatUser();
}
}
由於採用 EasyJWeb 作為 MVC 框架,處理 AJAX 變得相當輕鬆:
package com.easyjf.chat.action;
public class ChatAction extends AbstractCmdAction {
private ChatService chatRoom;
public Object doBefore(WebForm form, Module module) {
if (chatRoom == null) chatRoom = ChatService.get((String) form.get("cid"));
return super.doBefore(form, module);
}
public Page doInit(WebForm form, Module module) {
return doMain(form, module);
}
// 用戶登錄進入會議室
public Page doMain(WebForm form, Module module) {
if (chatRoom != null) {
ChatUser user = getChatUser();
if (!chatRoom.join(user)) form.addResult("msg", "不能加入房間,可能是權限不夠!");
form.addResult("chatRoom", chatRoom);
form.addResult("user", user);
} else {
form.addResult("msg", "會議未啟動或者會議室不存在!");
}
return module.findPage("main");
}
// 處理用戶發言
public Page DOSend(WebForm form, Module module) {
if (chatRoom == null) return new Page("err", "/err.Html", "html");
Chat chat = (Chat) form.toPo(Chat.class);
chat.setCid(chatRoom.geneId());
chatRoom.talk(chat);
return doRecive(form, module);
}
// 用戶接收發言
public Page doRecive(WebForm form, Module module) {
if (chatRoom == null) return new Page("err", "/err.Html", "html");
String lastReadId = CommUtil.null2String(form.get("lastReadId"));
form.addResult("list", chatRoom.getNewestMsg(getChatUser(), lastReadId));
return module.findPage("msgList");
}
// 刷新會議狀態
public Page doLoadConfig(WebForm form, Module module) {
if (chatRoom == null) return new Page("err", "/err.Html", "html");
form.addResult("userList", chatRoom.getUsers());
form.addResult("talkerList", chatRoom.getTalkers());
return module.findPage("config");
}
// 用戶退出
public Page doExit(WebForm form, Module module) {
if (chatRoom == null) return new Page("err", "/err.Html", "html");
chatRoom.exit(getChatUser());
form.addResult("msg", "退出成功");
ActionContext.getContext().getSession().removeAttribute("chatUser");
return new Page("msg", "/chat/xmlMsg.XML", Globals.PAGE_TEMPLATE_TYPE);
}
}
服務器返回給客戶端的都是格式化的 XML 文檔,客戶端負責創建請求、發送命令並解析返回:
function newXMLHttpRequest() {
var xmlreq = false;
if (window.XMLHttpRequest) {
xmlreq = new XMLHttpRequest();
} else if (window.ActiveXObject) {
try {
xmlreq = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e1) {
try {
xmlreq = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e2) {}
}
}
return xmlreq;
}
// 處理返回信息,method 為處理函數名(須帶一個參數)
function handleAjaxResult(req, method) {
return function () {
if (req.readyState == 4) {
if (req.status == 200) {
var objXMLDoc = new ActiveXObject("Microsoft.XMLDOM");
objXMLDoc.loadXML(req.responseText);
eval("if(objXMLDoc.firstChild)" + method + "(objXMLDoc.firstChild.nextSibling);");
}
}
};
}
// 執行客戶端 AJAX 命令
function executeAjaxCommand(url, postData, handleMethod) {
var req = newXMLHttpRequest();
req.onreadystatechange = handleAjaxResult(req, handleMethod);
req.open("POST", url, true);
req.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
req.setRequestHeader("charset", "utf-8");
req.send(postData);
}
// 用戶發言
function DOSend() {
if (!check()) return false;
var msg = EditForm.content.value;
var reciver = EditForm.reciver.value;
var url = "/chat.ejf?easyJWebCommand=send&cid=" + roomId + "&lastReadId=" + lastReadId;
var postData = "sender=" + myName + "&reciver=" + reciver + "&content=" + msg;
clearTimeout(reciveTime);
executeAjaxCommand(url, postData, "recive");
EditForm.content.value = "";
}
// 接收發言信息
function doRecive() {
var url = "/chat.ejf?easyJWebCommand=recive&cid=" + roomId + "&lastReadId=" + lastReadId;
executeAjaxCommand(url, "", "recive");
}
// 處理接收到的發言
function recive(list) {
var id = "";
for (var oNode = list.firstChild; oNode; oNode = oNode.nextSibling) {
chatContent.innerHtml += showMsg(oNode);
id = oNode.getAttribute("cid");
}
if (id != "") lastReadId = id;
chatContent.scrollTop = chatContent.scrollHeight;
reciveTime = setTimeout("doRecive();", 5000);
}
從技術本質看,AJAX 無非是 JavaScript、DHTML、CSS、xmlDOM、xmlhttp 這些我們很早就接觸過的技術組合。xmlDOM 與 xmlhttp 沒什麼玄機,寫的時候把參考文檔打開照搬即可;反倒是 DHTML 與 JavaScript 涉及的知識更廣,光看文檔不夠,必須真正吃透並靈活運用,這就需要在實戰中反覆練習。
也建議大家不要濫用 AJAX:高手不妨多鑽研業務與系統級算法設計;新手則應把基本功打牢——客戶端涵蓋 DHTML、CSS、JavaScript、XML,服務器端涵蓋設計模式、UML 建模、Servlet、JDBC 或 ORM、EJB 與各類框架工具,這些才是立身之本。