Spring整合DWR comet 实现无刷新 多人聊天室

<--加载Spring容器配置-->

<listener>

<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

</listener>

<--设置Spring容器加载配置文件路径-->

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>classpath*:applicationContext-*.xml</param-value>

</context-param>

<listener>

<listener-class>org.directwebremoting.servlet.DwrListener</listener-class>

</listener>

<servlet>

<servlet-name>dwr-invoker</servlet-name>

<servlet-class>org.directwebremoting.servlet.DwrServlet</servlet-class>

<init-param>

<param-name>debug</param-name>

<param-value>true</param-value>

</init-param>

<--dwr的comet控制-->

<init-param>

<param-name>pollAndCometEnabled</param-name>

<param-value>true</param-value>

</init-param>

</servlet>

<servlet-mapping>

<servlet-name>dwr-invoker</servlet-name>

<url-pattern>/dwr/*</url-pattern>

</servlet-mapping>

<?xmlversion="1.0"encoding="UTF-8"?>

<beansxmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:aop="http://www.springframework.org/schema/aop"

xmlns:tx="http://www.springframework.org/schema/tx"

xmlns:util="http://www.springframework.org/schema/util"

xmlns:context="http://www.springframework.org/schema/context"

xsi:schemaLocation="http://www.springframework.org/schema/beans

'target='_blank'>http://www.springframework.org/schema/beans/spring-beans-3.0.xsd[/code]
http://www.springframework.org/schema/aop

'target='_blank'>http://www.springframework.org/schema/aop/spring-aop-3.0.xsd[/code]
http://www.springframework.org/schema/tx

'target='_blank'>http://www.springframework.org/schema/tx/spring-tx-3.0.xsd[/code]
http://www.springframework.org/schema/util

'target='_blank'>http://www.springframework.org/schema/util/spring-util-3.0.xsd[/code]
http://www.springframework.org/schema/context

'target='_blank'>http://www.springframework.org/schema/context/spring-context-3.0.xsd">[/code]
</beans>


4、在WEB-INF目录添加dwr.xml文件，基本代码如下

<?xmlversion="1.0"encoding="UTF-8"?>

<!DOCTYPEdwrPUBLIC"-//GetAheadLimited//DTDDirectWebRemoting3.0//EN""http://getahead.org/dwr/dwr30.dtd">

<dwr>

</dwr>


以上的准备基本完毕，下面来完成无刷新聊天室代码

二、聊天室相关业务实现
1、聊天实体类Model

packagecom.hoo.entity;


importjava.util.Date;


/**

*<b>function:</b>

*@authorhoojo

*@createDate2011-6-3下午06:40:07

*@fileMessage.java

*@packagecom.hoo.entity

*@projectDWRComet

*@blog'target='_blank'>http://blog.csdn.net/IBM_hoojo[/code]
*@emailhoojo_@126.com

*@version1.0

*/

publicclassMessage{

privateintid;

privateStringmsg;

privateDatetime;

//getter、setter

}


2、编写聊天信息的事件

packagecom.hoo.chat;


importorg.springframework.context.ApplicationEvent;


/**

*<b>function:</b>发送聊天信息事件

*@authorhoojo

*@createDate2011-6-7上午11:24:21

*@fileMessageEvent.java

*@packagecom.hoo.util

*@projectDWRComet

*@blog'target='_blank'>http://blog.csdn.net/IBM_hoojo[/code]
*@emailhoojo_@126.com

*@version1.0

*/

publicclassChatMessageEventextendsApplicationEvent{


privatestaticfinallongserialVersionUID=1L;


publicChatMessageEvent(Objectsource){

super(source);

}

}


继承ApplicationEvent，构造参数用于传递发送过来的消息。这个事件需要一个监听器监听，一旦触发了这个事件，我们就可以向客户端发送消息。

3、发送消息服务类，用户客户端发送消息。dwr需要暴露这个类里面的发送消息的方法

packagecom.hoo.chat;


importorg.springframework.beans.BeansException;

importorg.springframework.context.ApplicationContext;

importorg.springframework.context.ApplicationContextAware;

importcom.hoo.entity.Message;


/**

*<b>function:</b>客户端发消息服务类业务

*@authorhoojo

*@createDate2011-6-7下午02:12:47

*@fileChatService.java

*@packagecom.hoo.chat

*@projectDWRComet

*@blog'target='_blank'>http://blog.csdn.net/IBM_hoojo[/code]
*@emailhoojo_@126.com

*@version1.0

*/

publicclassChatServiceimplementsApplicationContextAware{

privateApplicationContextctx;

publicvoidsetApplicationContext(ApplicationContextctx)throwsBeansException{

this.ctx=ctx;

}


/**

*<b>function:</b>向服务器发送信息，服务器端监听ChatMessageEvent事件，当有事件触发就向所有客户端发送信息

*@authorhoojo

*@createDate2011-6-8下午12:37:24

*@parammsg

*/

publicvoidsendMessage(Messagemsg){

//发布事件

ctx.publishEvent(newChatMessageEvent(msg));

}

}


上面的sendMessage需要浏览器客户端调用此方法完成消息的发布，传递一个Message对象，并且是触发ChatMessageEvent事件。

4、编写监听器监听客户端是否触发ChatMessageEvent

packagecom.hoo.chat;


importjava.util.Collection;

importjava.util.Date;

importjavax.servlet.ServletContext;

importorg.directwebremoting.ScriptBuffer;

importorg.directwebremoting.ScriptSession;

importorg.directwebremoting.ServerContext;

importorg.directwebremoting.ServerContextFactory;

importorg.springframework.context.ApplicationEvent;

importorg.springframework.context.ApplicationListener;

importorg.springframework.web.context.ServletContextAware;

importcom.hoo.entity.Message;


/**

*<b>function:</b>监听客户端事件，想客户端推出消息

*@authorhoojo

*@createDate2011-6-7上午11:33:08

*@fileSendMessageClient.java

*@packagecom.hoo.util

*@projectDWRComet

*@blog'target='_blank'>http://blog.csdn.net/IBM_hoojo[/code]
*@emailhoojo_@126.com

*@version1.0

*/

@SuppressWarnings("unchecked")

publicclassChatMessageClientimplementsApplicationListener,ServletContextAware{


privateServletContextctx;

publicvoidsetServletContext(ServletContextctx){

this.ctx=ctx;

}


@SuppressWarnings("deprecation")

publicvoidonApplicationEvent(ApplicationEventevent){

//如果事件类型是ChatMessageEvent就执行下面操作

if(eventinstanceofChatMessageEvent){

Messagemsg=(Message)event.getSource();

ServerContextcontext=ServerContextFactory.get();

//获得客户端所有chat页面scriptsession连接数


Collection<ScriptSession>sessions=context.getScriptSessionsByPage(ctx.getContextPath()+"/chat.jsp");

for(ScriptSessionsession:sessions){

ScriptBuffersb=newScriptBuffer();

Datetime=msg.getTime();

Strings=time.getYear()+"-"+(time.getMonth()+1)+"-"+time.getDate()+""

+time.getHours()+":"+time.getMinutes()+":"+time.getSeconds();

//执行setMessage方法


sb.appendScript("showMessage({msg:'")

.appendScript(msg.getMsg())

.appendScript("',time:'")

.appendScript(s)

.appendScript("'})");

System.out.println(sb.toString());

//执行客户端scriptsession方法，相当于浏览器执行JavaScript代码

//上面就会执行客户端浏览器中的showMessage方法，并且传递一个对象过去


session.addScript(sb);

}

}

}

}


上面的代码主要是监听客户端的事件，一旦客户端有触发ApplicationEvent事件或是其子类，就会执行onApplicationEvent方法。代码中通过instanceof判断对象实例，然后再执行。如果有触发ChatMessageEvent事件，就获取所有连接chat.jsp这个页面的ScriptSession。然后像所有的ScriptSession中添加script。这样被添加的ScriptSession就会在有连接chat.jsp的页面中执行。
所以这就是客户端为什么会执行服务器端的JavaScript代码。但前提是需要在web.xml中添加dwrComet配置以及在chat页面添加ajax反转。

5、下面开始在bean容器和dwr的配置中添加我们的配置
applicationContext-beans.xml配置

<beanid="chatService"class="com.hoo.chat.ChatService"/>

<beanid="chatMessageClient"class="com.hoo.chat.ChatMessageClient"/>


上面的chatService会在dwr配置中用到
dwr.xml配置

<allow>

<convertmatch="com.hoo.entity.Message"converter="bean">

<paramname="include"value="msg,time"/>

</convert>


<createcreator="spring"javascript="ChatService">

<paramname="beanName"value="chatService"/>

</create>

</allow>


charService的sendMessage方法传递的是Message对象，所以要配置Message对象的convert配置。
上面的create的creator是spring，表示在spring容器中拿chatService对象。里面的参数的beanName表示在spring容器中找name等于charService的bean对象。

6、客户端chat.jsp页面代码

<%@pagelanguage="java"import="java.util.*"pageEncoding="UTF-8"%>

<%

Stringpath=request.getContextPath();

StringbasePath=request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";

%>


<!DOCTYPEHTMLPUBLIC"-//W3C//DTDHTML4.01Transitional//EN">

<html>

<head>

<basehref="<%=basePath%>">


<title>Chat</title>


<metahttp-equiv="pragma"content="no-cache">

<metahttp-equiv="cache-control"content="no-cache">

<metahttp-equiv="expires"content="0">

<scripttype="text/javascript"src="${pageContext.request.contextPath}/dwr/engine.js"></script>

<scripttype="text/javascript"src="${pageContext.request.contextPath}/dwr/util.js"></script>

<scripttype="text/javascript"src="${pageContext.request.contextPath}/dwr/interface/ChatService.js"></script>

<scripttype="text/javascript">

functionsend(){

vartime=newDate();

varcontent=dwr.util.getValue("content");

varname=dwr.util.getValue("userName");

varinfo=encodeURI(encodeURI(name+"say:\n"+content));

varmsg={"msg":info,"time":time};

dwr.util.setValue("content","");

if(!!content){

ChatService.sendMessage(msg);

}else{

alert("发送的内容不能为空！");

}

}


functionshowMessage(data){

varmessage=decodeURI(decodeURI(data.msg));

vartext=dwr.util.getValue("info");

if(!!text){

dwr.util.setValue("info",text+"\n"+data.time+""+message);

}else{

dwr.util.setValue("info",data.time+""+message);

}

}

</script>

</head>


<bodyonload="dwr.engine.setActiveReverseAjax(true);">

<textarearows="20"cols="60"id="info"readonly="readonly"></textarea>

<hr/>

昵称：<inputtype="text"id="userName"/><br/>

消息：<textarearows="5"cols="30"id="content"></textarea>

<inputtype="button"value="Send"onclick="send()"style="height:85px;width:85px;"/>

</body>

</html>


首先，你需要导入dwr的engine.js文件，这个很重要，是dwr的引擎文件。其次你使用的那个类的方法，也需要在导入进来。一般是interface下的，并且在dwr.xml中配置过的create。
上面的js中调用的charService类中的sendMessage方法，所以在jsp页面中导入的是ChatService.js。
在body的onload事件中，需要设置反转Ajax，这个很重要。
showMessage是ChatMessageClient的onApplicationEvent方法中的appendScript中需要执行的方法。data参数也是在那里传递过来的。
每当发送sendMessage方法后就会触发ChatMessageEvent事件，然后监听的地方就会执行onApplicationEvent方法，在这个方法中又会执行浏览器中的showMessage方法。