DWR Server Push(服務器推技術) 實現即時聊天

當你有QQ消息時,QQ小圖標會晃動,我們甚至還可以設定QQ有消息時,自動彈出來!
這些在C/S模式下很容易實現!如果要在B/S模式如何來實現呢?
我們肯定會想到在客服端調用ajax在後臺不斷查詢服務器.看是否有關於自己消息.如果有則查詢返回.這種做法肯定會大量佔用系統資源!不可取!
現在DWR反轉AJAX功能.允許我們從服務器端來控制客服端.而不需要客戶端來請求.服務器可以自動把消息發給指定客戶端!

以下DEMO,已經實現了對指定用戶發送消息功能,並且即時顯示在指定用戶界面上面.當然你可以修改這些,讓它彈出來顯示,或者像QQ一樣在你頁面某個角落讓消息圖標閃動:)
下面我做一個簡單說明:


用戶JAVABEAN User.java
package com.chat;

/**
 * 用戶
 *
 *
 */
public class User {

 private String userid;

 private String username;

 public String getUserid() {
  return userid;
 }

 public void setUserid(String userid) {
  this.userid = userid;
 }

 public String getUsername() {
  return username;
 }

 public void setUsername(String username) {
  this.username = username;
 }

 public User(String userid, String username) {
  super();
  this.userid = userid;
  this.username = username;
 }

}

聊天處理類 ChatManager.java

package com.chat;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;

import org.directwebremoting.ScriptSession;
import org.directwebremoting.ServerContext;
import org.directwebremoting.ServerContextFactory;
import org.directwebremoting.WebContextFactory;
import org.directwebremoting.proxy.dwr.Util;

/**
 * 處理聊天相關
 *
 *
 */
public class ChatManager {

 /** 保存當前在線用戶列表 */
 public static List<User> users = new ArrayList<User>();

 /**
  * 更新在線用戶列表
  * @param username 待添加到列表用戶名
  * @param flag 是添加用戶到列表,還是隻獲得當前列表
  * @param request
  * @return 用戶userid
  */
 public String updateUsersList(String username, boolean flag, HttpServletRequest request) {
  User user = null;
  if (flag) { 
   // 這裏取會話(HttpSession)id爲用戶id
   user = new User(request.getSession().getId(), username);
   //保存用戶到列表
   users.add(user); 
   //將用戶id和頁面腳本session綁定
   this.setScriptSessionFlag(user.getUserid());
  }
  //獲得DWR上下文
  ServletContext sc = request.getSession().getServletContext();
  ServerContext sctx = ServerContextFactory.get(sc);
  //獲得當前瀏覽 index.jsp 頁面所有腳本session
  Collection sessions = sctx.getScriptSessionsByPage("/chat/index.jsp");
  Util util = new Util(sessions);
  //處理這些頁面中一些元素
  util.removeAllOptions("users");
  util.addOptions("users", users, "username");
  util.removeAllOptions("receiver");
  util.addOptions("receiver", users,"userid","username");
  if(!flag){
   return null;
  }
  return user.getUserid();
 }

 /**
  * 將用戶id和頁面腳本session綁定
  * @param userid
  */
 public void setScriptSessionFlag(String userid) {
  WebContextFactory.get().getScriptSession().setAttribute("userid", userid);
 }

 /**
  * 根據用戶id獲得指定用戶頁面腳本session
  * @param userid
  * @param request
  * @return
  */
 @SuppressWarnings("unchecked")
 public ScriptSession getScriptSession(String userid, HttpServletRequest request) {
  ScriptSession scriptSessions = null;
  Collection<ScriptSession> sessions = new HashSet<ScriptSession>();
  sessions.addAll(ServerContextFactory.get(request.getSession().getServletContext())
    .getScriptSessionsByPage("/chat/index.jsp"));
  for (ScriptSession session : sessions) {
   String xuserid = (String) session.getAttribute("userid");
   if (xuserid != null && xuserid.equals(userid)) {
    scriptSessions = session;
   }
  }
  return scriptSessions;
 }
 
 /**
  * 發送消息
  * @param sender 發送者
  * @param receiverid 接收者id
  * @param msg 消息內容
  * @param request
  */
 public void send(String sender,String receiverid,String msg,HttpServletRequest request){
  ScriptSession session = this.getScriptSession(receiverid, request);
  Util util = new Util(session);
  util.setStyle("showMessage", "display", "");
  util.setValue("sender", sender);
  util.setValue("msg", msg);
 }
}

聊天主頁面 index.jsp

<%@ page language="java" pageEncoding="GBK"%> 
<html> 
    <head> 
        <title>chat</title> 
        <meta http-equiv="pragma" content="no-cache"> 
        <meta http-equiv="cache-control" content="no-cache"> 
        <meta http-equiv="expires" content="0"> 
        <script type='text/javascript' src='dwr/interface/ChatManager.js'></script> 
        <script type='text/javascript' src='dwr/engine.js'></script> 
        <script type='text/javascript' src='dwr/util.js'></script> 
        <script type="text/javascript" src="chat/chat.js"></script> 
    </head> 
    <body> 
        <input type="hidden" name="userid" /> 
        <br> 
        暱稱:  
        <input type="text" name="username" /> 
        <input type="button" value="註冊" οnclick="register(this);" /> 
        <br /> 
        <br /> 
        我要對  
        <select name="receiver" id="receiver" disabled=true" > 
        </select> 
        說:  
        <input type="text" name="message" id="message" disabled="true" /> 
        <input type="button" value="發送" id="send" name="send" disabled="true" 
            οnclick="send();" /> 
        <br /> 
        <br /> 
        在線用戶列表:  
        <ul id="users"> 
        </ul> 
 
        <div id="showMessage" style="display: none"> 
            <span id="sender"></span>對你說:  
            <span id="msg"></span> 
        </div> 
    </body> 
</html>

JAVASCRIPT 文件 chat.js

/**
 * 註冊帳號
 */
function register(button) {
 if ($('username').value == "" || $('username').value.length <= 0) {
  alert("請輸入暱稱");
  return;
 }

 /* 下面是對一些按鈕禁用和激活操作 */
 $('username').disabled = true;
 button.disabled = true;
 $('message').disabled = false;
 $('send').disabled = false;
 $('receiver').disabled = false;

 /* 把我輸入用戶名註冊到服務器,並獲得用戶id(這裏用session id 代替) */
 ChatManager.updateUsersList($('username').value, true, function(data) {
  if (data != null && data.length > 0) {
   $('userid').value = data; // 註冊成功,把userid放到當前頁面
  }
 });
}

/**
 * 頁面初始化
 */
function init() {
 dwr.engine.setActiveReverseAjax(true); // 激活反轉 重要
 ChatManager.updateUsersList(null, false); // 當你打開界面時候,先獲得在線用戶列表.
}

/**
 * 發送消息
 */
function send() {
 var sender = dwr.util.getValue('username'); // 獲得發送者名字
 var receiver = dwr.util.getValue('receiver'); // 獲得接受者id
 var msg = dwr.util.getValue('message'); // 獲得消息內容
 ChatManager.send(sender, receiver, msg); // 發送消息
}

window.onload = init;//頁面加載完畢後執行初始化方法init

配置文件 web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" xmlns="
http://java.sun.com/xml/ns/j2ee"
 xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="
http://java.sun.com/xml/ns/j2ee
 
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
 <welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
 </welcome-file-list>
 <servlet>
  <servlet-name>dwr-invoker</servlet-name>
  <servlet-class>
   org.directwebremoting.servlet.DwrServlet
  </servlet-class>
  <init-param>
   <description>調試DWR,發佈系統時應將其設爲false</description>
   <param-name>debug</param-name>
   <param-value>true</param-value>
  </init-param>
  <init-param>
   <description>使用服務器推技術(反轉AJAX)</description>
   <param-name>activeReverseAjaxEnabled</param-name>
   <param-value>true</param-value>
  </init-param>
  <init-param>
   <param-name>
    initApplicationScopeCreatorsAtStartup
   </param-name>
   <param-value>true</param-value>
  </init-param>
  <init-param>
   <param-name>maxWaitAfterWrite</param-name>
   <param-value>100</param-value>
  </init-param>
  <load-on-startup>4</load-on-startup>
 </servlet>
 <servlet-mapping>
  <servlet-name>dwr-invoker</servlet-name>
  <url-pattern>/dwr/*</url-pattern>
 </servlet-mapping>
</web-app>

DWR配置文件 dwr.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN" "
http://getahead.org/dwr/dwr20.dtd">
<dwr>
 <allow>
  <convert converter="bean" match="com.chat.User" />
  <create creator="new" javascript="ChatManager">
   <param name="class" value="com.chat.ChatManager" />
  </create>
 </allow>
</dwr>

 

engine.js util.js dwr 自帶,在 dwr.jar 包中可以找到。 ChatManager.js 是由 DWRServlet 根據 dwr.xml 定義自動生成。要想查看可以在瀏覽器地址欄輸入:

http://localhost:8080/chat/dwr/interface/ChatManager.js 結果如下

 // Provide a default path to dwr.engine
if (dwr == null) var dwr = {};
if (dwr.engine == null) dwr.engine = {};
if (DWREngine == null) var DWREngine = dwr.engine;

if (ChatManager == null) var ChatManager = {};
ChatManager._path = '/chat/dwr';
ChatManager.send = function(p0, p1, p2, callback) {
  dwr.engine._execute(ChatManager._path, 'ChatManager', 'send', p0, p1, p2, false, callback);
}
ChatManager.getScriptSession = function(p0, callback) {
  dwr.engine._execute(ChatManager._path, 'ChatManager', 'getScriptSession', p0, false, callback);
}
ChatManager.updateUsersList = function(p0, p1, callback) {
  dwr.engine._execute(ChatManager._path, 'ChatManager', 'updateUsersList', p0, p1, false, callback);
}
ChatManager.setScriptSessionFlag = function(p0, callback) {
  dwr.engine._execute(ChatManager._path, 'ChatManager', 'setScriptSessionFlag', p0, callback);
}

發佈了1 篇原創文章 · 獲贊 4 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章