DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
用 Ajax + J2EE 打造網上會議室:架構、設計與核心程式碼
編輯:AJAX詳解     

這一年大家都在談 Web 2.0,Ajax 也跟著紅了起來。我先前寫過一篇〈忽悠一下 AJAX〉,簡單剖析了它的技術實質。老實說我不太喜歡跟風,但 Ajax 確實有幾處是真有用的。

前陣子為 EasyJF 開源團隊做了網上會議系統,就用到了 Ajax。以下把設計思路整理出來,與大家分享。

一、系統功能

會議系統主要服務 EasyJF 團隊的線上會議。它模擬傳統會議形式,可同時開啟多個不同主題的會議室,每個會議室都要具備訪問權限控制;會議中可指定發言模式(排隊發言與自由發言兩種);系統自動記錄每個會議室的發言內容,供與會者長期查閱。

使用者層面支援訪客帳號進入,同時保留與其他用戶系統對接的能力,例如 EasyJF 官網的開源論壇。會議形式暫以文字聊天為主,但已預留語音與視訊的擴展介面。

二、技術體系

  • 伺服器端以 Java 語言實作,MVC 採用 EasyJWeb 框架。
  • 客戶端透過 Ajax 與伺服器端交換數據。
  • 會議歷史訊息以純文字格式儲存,方便部署運行,也便於管理。

三、伺服器端設計

伺服器端是整個系統的核心,設計好壞直接決定系統品質。

先做抽象分析。一個會議室物件應包含:會議主題、簡介、人數上限、公告、會議室類型、訪問權限設定、房間密碼、當前在線人員、當前發言人、排隊等待發言的人員等。將其封裝為 Java 物件:

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 分鐘內的訊息
    }
}

發言記錄也要封裝成類,描述發言人、接收人、內容、時間、類型等:

public class Chat {
    private String  cid;
    private String  sender;
    private String  reciver;
    private String  content;
    private Date    vdate;
    private Integer types;
    private Integer status;
}

與會者資訊則包括名稱、IP、狀態等:

public class ChatUser {
    private String  ip;
    private String  port;
    private String  userName;
    private Date    lastAccessTime;
    private Integer status;
}

另外還需要一個 Talker 類,記錄當前發言人、發言開始時間與預計結束時間。

設計上的關鍵決定是:會議室服務以多執行緒方式運行——每啟動一個會議就開一條執行緒,各執行緒維護自己的會議狀態(與會者、發言人)、負責保存歷史記錄並在必要時清空記憶體。

四、客戶端設計

客戶端分兩部分。第一部分是會議室管理界面,負責會議室的「增刪改查」以及啟動/關閉會議服務。這部分直接用 EasyJWeb Tools 的 AbstractCrudAction 業務引擎快速搞定,界面由代碼生成工具產出即可,屬於傳統 Java Web 技術,沒什麼特別要考量的。

第二部分才是重點:會議主界面。所有與會操作都在這裡發生,需要不斷與伺服器端交換資料——使用者發言、他人給我的訊息、會議室狀態等。其中有些要求即時響應(如發言),有些可以定時拉取(如會議狀態)。

Java Web 與伺服器端交換資料大致有兩條路:直接刷新頁面,或用 Socket 直連 Web 伺服器埠。Socket 編程相對複雜,所以選了前者;而前者又可細分為傳統表單提交、傳統自動刷新,以及使用 ActiveXObject(如 xmlhttp)直接與伺服器通訊的 Ajax 方式。由於 Ajax 讓使用者感覺不到頁面刷新,體驗明顯優於手動或自動刷新,最終決定採用 Ajax。

發言時直接用 xmlhttp 物件 POST 資料;為了持續接收別人的發言,客戶端要啟動計時器,週期性地向伺服器下載新訊息並渲染到主界面。參會人數、當前發言人、會議公告等狀態資訊同樣靠計時器輪詢。至於鎖定會議室、踢人、指定發言時長、為會議室設定密碼等管理操作,也都透過 xmlhttp 把命令送到後端。

五、核心程式碼

1. 伺服器端

由於會議系統要與 EasyJF 官網的論壇、後台管理整合,實作時把 ChatService 與 ChatRoom 合併進同一個類:

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, users, talkers, manager;
    private Talker currentTalker;

    private String  cid, title, intro, owner, vrtype, vrvalue;
    private String  announce, passWord, filePath;
    private int     maxUser, interval, status;
    private boolean isStop = false;

    /** 停止所有會議室 */
    public static void clear() {
        if (!service.isEmpty()) {
            Iterator it = service.values().iterator();
            while (it.hasNext()) {
                ((ChatService) it.next()).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 = get(name);
        if (chatRoom != null) {
            chatRoom.stop();
            service.remove(name);
        }
        return true;
    }

    /** 取得會議室 */
    public static ChatService get(String name) {
        return service.containsKey(name) ? (ChatService) service.get(name) : 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();
    }
}

2. MVC 層的 Action

由於採用 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);
    }
}

3. 客戶端 Ajax

伺服器回傳的都是格式化的 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;
}

// 處理返回結果
// req: xmlhttp 物件;method: 處理函數名(需接受一個節點參數)
function handleAjaxResult(req, method) {
    return function () {
        if (req.readyState == 4 && req.status == 200) {
            var objXMLDoc = new ActiveXObject("Microsoft.XMLDOM");
            objXMLDoc.loadXML(req.responseText);
            eval("if(objXMLDoc.firstChild)"
                + method + "(objXMLDoc.firstChild.nextSibling);");
        }
    };
}

// 執行一次 Ajax 命令
// url: POST 目標;postData: 送出的資料;handleMethod: 回呼處理函數
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 reciver = EditForm.reciver.value;
    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);
}

六、上線預覽

實際運行效果可到 EasyJF 開源團隊官網查看。

結語

從技術構成看,Ajax 主要就是 JavaScript、DHTML、CSS、XMLDOM、XMLHTTP 這些我們很早就接觸過的東西。XMLDOM 與 XMLHTTP 本身沒什麼門檻,寫的時候把參考文件打開複製即可;但 DHTML 與 JavaScript 涉及的内容多得多,不能只看文件,得真正消化並能靈活運用,這就必須靠大量練習。

我的建議是不要濫用 Ajax。高手不妨多花心思在業務建模與系統級演算法設計上;新手則該把基本功練紮實——用戶端的 DHTML、CSS、JavaScript、XML,以及 J2EE 服務端的分類設計模式、UML 建模、Servlet、JDBC 或 ORM、XML、EJB 與主流框架工具。這些才是硬道理。

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