Struts 2与AJAX（第二部分）
在上一篇文章《Struts2与AJAX（第一部分）》，我已经简单地介绍了<s:tree/>的一些用法，接下来我将继续深入讲解<s:tree/>的使用和通过DWR实现AJAX校验。
更多<s:tree/>
在Struts2的showcase中有两个<s:tree/>的例子，分别是静态树与动态树。所谓的静态树即是在编写JSP代码时通过<s:treenode/>生成树节点。我的上一篇文章的例子就是一个典型的静态树。而动态树则是在程序运行期间，Struts2运行时（Runtime）根据程序中的数据动态创建树节点。虽然在两个例子中<s:tree/>的theme属性都为“ajax”，但是从严格意义上来说，这两种树都不属于AJAX树，因为它们都是在输出页面时将全部节点加载到其中，而不是在父节点展开时通过XHR（XMLHttpRequest）获取节点数据。
动态树下面我们先看一下动态树的例子，接着再一步步地将其改造为名副其实的AJAX树。下例将会把WEB应用程序的目录树展现在JSP页面中。因此，我需要先包装一下java.io.File类，代码如下：
packagetutorial;
importjava.io.File;
publicclassFileWrapper{
privateFilefile;
publicFileWrapper(Stringpath){
file=newFile(path);
}
publicFileWrapper(Filefile){
this.file=file;
}
publicStringgetId(){
return"file_"+file.hashCode();
}
publicStringgetName(){
returnfile.getName();
}
publicStringgetAbsolutePath(){
returnfile.getAbsolutePath();
}
publicFileWrapper[]getChildren(){
File[]files=file.listFiles();
if(files!=null&&files.length>0){
intlength=files.length;
FileWrapper[]wrappers=newFileWrapper[length];
for(inti=0;i<length;++i){
wrappers[i]=newFileWrapper(files[i]);
}
returnwrappers;
}
returnnewFileWrapper[0];
}
}清单1src/tutorial/FileWrapper.java
之所以需要对File类进行如此包装，是因为<s:tree/>用于动态树时，rootNode、nodeIdProperty、nodeTitleProperty和childCollectionProperty等属性都必填的。
然后是Action类的代码如下：
packagetutorial;
importjavax.servlet.http.HttpServletRequest;
importorg.apache.struts2.interceptor.ServletRequestAware;
importcom.opensymphony.xwork2.ActionSupport;
publicclassDynamicTreeActionextendsActionSupportimplementsServletRequestAware{
privatestaticfinallongserialVersionUID=1128593047269036737L;
privateHttpServletRequestrequest;
privateFileWrapperroot;
publicvoidsetServletRequest(HttpServletRequestrequest){
this.request=request;
}
publicFileWrappergetRoot(){
returnroot;
}
@Override
publicStringexecute(){
root=newFileWrapper(request.getSession().getServletContext().getRealPath("/"));
returnSUCCESS;
}
}清单2src/tutorial/DynamicTreeAction.java
上述代码取得WEB应用程序的根目录的绝对路径后，初始化FileWrapper对象root。该对象将为JSP页面的<s:tree/>的根节点。如下代码所示：
<%@pagelanguage="java"contentType="text/html;charset=utf-8"
pageEncoding="utf-8"%>
<%@taglibprefix="s"uri="/struts-tags"%>
<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<htmlxmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts2AJAX-MoreTree</title>
<s:headtheme="ajax"debug="true"/>
<scripttype="text/javascript">
/*<![CDATA[*/
functiontreeNodeSelected(arg){
alert(arg.source.title+'selected');
}
functiontreeNodeExpanded(arg){
alert(arg.source.title+'expanded');
}
functiontreeNodeCollapsed(arg){
alert(arg.source.title+'collapsed');
}
dojo.addOnLoad(function(){
vart=dojo.widget.byId('appFiles');
dojo.event.topic.subscribe(t.eventNames.expand,treeNodeExpanded);
dojo.event.topic.subscribe(t.eventNames.collapse,treeNodeCollapsed);
vars=t.selector;
dojo.event.connect(s,'select','treeNodeSelected');
});
/*]]>*/
</script>
</head>
<body>
<h2>
DynamicTreeExample
</h2>
<divstyle="float:left;margin-right:50px;">
<s:treeid="appFiles"theme="ajax"rootNode="root"
nodeTitleProperty="name"nodeIdProperty="id"
childCollectionProperty="children"/>
</div>
</body>
</html>清单3WebContent/Tree.jsp
因为<s:tree/>的treeCollapsedTopic和treeExpandedTopic属性都没有起作用，所以如果我们想要监听这两个事件，就必须使用上述代码的方法。
最后是struts.xml配置文件：
<?xmlversion="1.0"encoding="UTF-8"?>
<!DOCTYPEstrutsPUBLIC
"-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<packagename="Struts2_AJAX_DEMO"extends="struts-default">
<actionname="DynamicTree"class="tutorial.DynamicTreeAction">
<result>Tree.jsp</result>
</action>
</package>
</struts>清单4src/struts.xml
发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/DynamicTree.action，有如下图所示页面：
图1动态树示例
AJAX树正如我在文章开头所说，Struts2所提供的静态树和动态树都不是严格意义上的AJAX树。下面就让我们来实现一个如假包换的AJAX树。首先要说明的是，Struts2的<s:tree/>默认是不支持这种按需加载数据的AJAX树。不过因为它是基于Dojo的树控件（Widget）所以要扩展也很方便。
Dojo通过名为“TreeRPCController”的控件实现AJAX树，它会监听被控制树的事件。当发生展开节点的事件时，TreeRPCController就会向URL发送XHR请求，该URL由TreeRPCController的RPCUrl属性定义。XHR请求格式类似如下格式：
http://localhost:8080/Struts2_Ajax2/AjaxTree.action?action=getChildren&data={"node":{"widgetId":"file_226092423","objectId":"C:\\ProgramFiles\\Tomcat5.5\\webapps\\Struts2_Ajax2","index":0,"isFolder":true},"tree":{"widgetId":"appFiles","objectId":""}}&dojo.preventCache=1182913465392清单5XHR样本
显而易见，请求中包含三个参数，分别是action为“getChildren”（固定值），data一个包含当前节点与树信息的JSON串和dojo.preventCache随机串，用于缓存不同节点的请求响应（父节点只会在第一次被展开时到服务器端加载数据，之后都是从浏览器的缓存中读取数据，可以提高应用程序性能）。
首先我要先写一个加载树节点数据的Action类，代码如下：
packagetutorial;
importjava.util.Map;
importcom.googlecode.jsonplugin.JSONExeption;
importcom.googlecode.jsonplugin.JSONUtil;
publicclassAjaxTreeActionextendsDynamicTreeAction{
privatestaticfinallongserialVersionUID=3970019751740942311L;
privateStringaction;
privateStringdata;
privateFileWrapper[]wrappers;
publicvoidsetAction(Stringaction){
this.action=action;
}
publicvoidsetData(Stringdata){
this.data=data;
}
publicFileWrapper[]getWrappers(){
returnwrappers;
}
@Override
publicStringexecute(){
if("getChildren".equals(action)){
try{
Objecto=JSONUtil.deserialize(data);
Stringpath=((Map)((Map)o).get("node")).get("objectId").toString();
wrappers=newFileWrapper(path).getChildren();
}catch(JSONExeptione){
e.printStackTrace();
}
return"ajax";
}
returnsuper.execute();
}
}清单6src/tutorial/AjaxTreeAction.java
上述代码可能需要解释一下：
action属性对应于XHR中的action，如果它为“getChildren”时，则需要进行加载子节点操作。否则，会读取树的根节点，并返回JSP页面；
通过上面XHR的分析，大家可以知道data是代表树和当前节点的JSON串，故应将其反串行化为Map对象，并将其objectId属性取出。通常情况下，Dojo树的objectId属性代表服务器端的对象的标识，在本例中为文件夹的绝对路径；
wrappers属性表示当前文件夹下的文件数组，它被传送到Freemarker页面，翻译为Dojo树节点数组的JSON串。
下面是Freemarker页面的代码：
[
<#listwrappersasr>
{"title":"${r.name}","isFolder":<#ifr.children?sizegt0>true<#else>false</#if>,"id":"${r.id}","objectId":"${r.absolutePath?js_string}"}<#ifr_has_next>,</#if>
</#list>
]清单7WebContent/AjaxTree.ftl
以上代码中<#list></#lsit>的写法是Freemarker中遍历集合的写法；而<#ifr.children?sizegt0>判断“r”对象的children属性是否为空；r.absolutePath?js_string就是将“r”的absolutePath属性的值输出为Javascript的字串符形式；<#ifr_has_next></#if>判断集合是否有下一项数据。如果希望更详细地了解Freemarker的使用，请参考该手册。
接下来，让我们看看Action的配置代码片段：
<actionname="AjaxTree"class="tutorial.AjaxTreeAction">
<result>AjaxTree.jsp</result>
<resultname="ajax"type="freemarker">AjaxTree.ftl</result>
</action>清单8src/struts.xml配置片段
最后是JSP页面代码：
<%@pagelanguage="java"contentType="text/html;charset=utf-8"
pageEncoding="utf-8"%>
<%@taglibprefix="s"uri="/struts-tags"%>
<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<htmlxmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts2AJAX-MoreTree</title>
<s:headtheme="ajax"debug="true"/>
<scripttype="text/javascript">
/*<![CDATA[*/
functiontreeNodeSelected(arg){
alert(arg.source.title+'selected');
}
dojo.addOnLoad(function(){
vart=dojo.widget.byId('appFiles');
vars=t.selector;
dojo.event.connect(s,'select','treeNodeSelected');
});
/*]]>*/
</script>
</head>
<body>
<h2>
AJAXTreeExample
</h2>
<divstyle="float:left;margin-right:50px;">
<scripttype="text/javascript">
/*<![CDATA[*/
dojo.require("dojo.lang.*");
dojo.require("dojo.widget.*");
dojo.require("dojo.widget.Tree");
dojo.require("dojo.widget.TreeRPCController");
/*]]>*/
</script>
<divdojoType="TreeRPCController"widgetid="treeController"
DNDcontroller="create"RPCUrl="<s:url/>"></div>
<divdojoType="Tree"widgetid="appFiles"toggle="fade"controller="treeController">
<divdojoType="TreeNode"title='<s:propertyvalue="root.name"/>'
widgetId='<s:propertyvalue="root.id"/>'
isFolder='<s:propertyvalue="root.children.length>0"/>'
objectId='<s:propertyvalue="root.absolutePath"/>'>
</div>
</div>
</div>
</body>
</html>清单9WebContent/AjaxTree.jsp
由于上面所提及的原因，我在上述的代码中并没有使用<s:tree/>标志，而是使用了Dojo的写法——创建widgetId为“treeController”的TreeRPCController并将设为树的控制器。
发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/AjaxTree.action，点开某个节点，在节点加载的过程中，加号图标变成时钟状图标，如下图所示页面：
图2AJAX树示例
自定义<s:tree/>的AJAX的主题（theme）Struts2的标志过人之外在于它允许开发人员自定义标志的页面输出。要做到这一点，你所需要做的只是创建一个自定义的theme并将其应用到相应标志。下面就让我自定义一个真正的AJAX的<s:tree/>的theme。
首先，你的源文件的根目录下新建包“template.realajax”。
然后，在上一步所建的包中新建“tree.ftl”文件，内容如下：
<scripttype="text/javascript">
/*<![CDATA[*/
dojo.require("dojo.lang.*");
dojo.require("dojo.widget.*");
dojo.require("dojo.widget.Tree");
dojo.require("dojo.widget.TreeRPCController");<#--AddedbyMax-->
/*]]>*/
</script>
<#--AddedbyMax-->
<divdojoType="TreeRPCController"
widgetid="${parameters.id?html}_controller"
DNDcontroller="create"
RPCUrl="<@s.url/>">
</div>
<#--End-->
<divdojoType="Tree"
<#ifparameters.blankIconSrc?exists>
gridIconSrcT="<@s.urlvalue='${parameters.blankIconSrc}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcL?exists>
gridIconSrcL="<@s.urlvalue='${parameters.gridIconSrcL}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcV?exists>
gridIconSrcV="<@s.urlvalue='${parameters.gridIconSrcV}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcP?exists>
gridIconSrcP="<@s.urlvalue='${parameters.gridIconSrcP}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcC?exists>
gridIconSrcC="<@s.urlvalue='${parameters.gridIconSrcC}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcX?exists>
gridIconSrcX="<@s.urlvalue='${parameters.gridIconSrcX}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcY?exists>
gridIconSrcY="<@s.urlvalue='${parameters.gridIconSrcY}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.gridIconSrcZ?exists>
gridIconSrcZ="<@s.urlvalue='${parameters.gridIconSrcZ}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.expandIconSrcPlus?exists>
expandIconSrcPlus="<@s.urlvalue='${parameters.expandIconSrcPlus}'includeParams='none'/>"
</#if>
<#ifparameters.expandIconSrcMinus?exists>
expandIconSrcMinus="<@s.urlvalue='${parameters.expandIconSrcMinus?html}'includeParams='none'/>"
</#if>
<#ifparameters.iconWidth?exists>
iconwidth="<@s.urlvalue='${parameters.iconWidth?html}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.iconHeight?exists>
iconheight="<@s.urlvalue='${parameters.iconHeight?html}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.toggleDuration?exists>
toggleDuration=${parameters.toggleDuration?c}
</#if>
<#ifparameters.templateCssPath?exists>
templateCssPath="<@s.urlvalue='${parameters.templateCssPath}'encode="false"includeParams='none'/>"
</#if>
<#ifparameters.showGrid?exists>
showGrid="${parameters.showGrid?default(true)?string}"
</#if>
<#ifparameters.showRootGrid?exists>
showRootGrid="${parameters.showRootGrid?default(true)?string}"
</#if>
<#ifparameters.id?exists>
id="${parameters.id?html}"
</#if>
<#ifparameters.treeSelectedTopic?exists>
publishSelectionTopic="${parameters.treeSelectedTopic?html}"
</#if>
<#ifparameters.treeExpandedTopic?exists>
publishExpandedTopic="${parameters.treeExpandedTopic?html}"
</#if>
<#ifparameters.treeCollapsedTopic?exists>
publishCollapsedTopic="${parameters.treeCollapsedTopic?html}"
</#if>
<#ifparameters.toggle?exists>
toggle="${parameters.toggle?html}"
</#if>
controller="${parameters.id?html}_controller"<#--AddedbyMax-->
>
<#ifparameters.label?exists>
<divdojoType="TreeNode"title="${parameters.label?html}"
<#ifparameters.nodeIdProperty?exists>
id="${stack.findValue(parameters.nodeIdProperty)}"
<#else>
id="${parameters.id}_root"
</#if>
>
<#elseifparameters.rootNode?exists>
${stack.push(parameters.rootNode)}
<#--EditedbyMax-->
<divdojoType="TreeNode"
title="${stack.findValue(parameters.nodeTitleProperty)}"
widgetid="${stack.findValue(parameters.nodeIdProperty)}"
isFolder="<#ifstack.findValue(parameters.childCollectionProperty)?sizegt0>true<#else>false</#if>"
objectid="${stack.findValue(parameters.nameValue)}">
</div>
<#--End-->
<#assignoldNode=stack.pop()/><#--popthenodeoffofthestack,butdon'tshowit-->
</#if>清单10src/template/realajax/tree.ftl
对上述稍作解释，上述代码主要在原版的src/template/ajax/tree.ftl的基础上添加了TreeRPCController的控件，并只输出根节点。由于<s:tree/>没有类似nodeObjectIdProperty的属性，所以我用了value属性表示objectId对应的属性名称。
接着新建tree-close.ftl文件，内容和原版的一样，如下所示：
<#ifparameters.label?exists></div></#if></div>清单11src/template/realajax/tree-close.ftl
再下来就应该是将theme应用到<s:tree/>，如下代码所示：
<%@pagelanguage="java"contentType="text/html;charset=utf-8"
pageEncoding="utf-8"%>
<%@taglibprefix="s"uri="/struts-tags"%>
<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<htmlxmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts2AJAX-MoreTree</title>
<s:headtheme="ajax"debug="true"/>
<scripttype="text/javascript">
/*<![CDATA[*/
functiontreeNodeSelected(arg){
alert(arg.source.title+'selected');
}
dojo.addOnLoad(function(){
vart=dojo.widget.byId('appFiles');
vars=t.selector;
dojo.event.connect(s,'select','treeNodeSelected');
});
/*]]>*/
</script>
</head>
<body>
<h2>
AJAXTreeExample
</h2>
<divstyle="float:left;margin-right:50px;">
<s:treeid="appFiles"theme="realajax"rootNode="root"
nodeTitleProperty="name"nodeIdProperty="id"
childCollectionProperty="children"value="absolutePath"/>
</div>
</body>
</html>清单12WebContent/AjaxTreeTheme.jsp
上述代码中<s:tree/>的用法，除了theme改为“realajax”和多了value="absolutePath"外，几乎和静态树中的一样。
为了不影响前一个例子，我们为该JSP文件配置类型相同的Action，如下代码所示：
<actionname="AjaxTreeTheme"class="tutorial.AjaxTreeAction">
<result>AjaxTreeTheme.jsp</result>
<resultname="ajax"type="freemarker">AjaxTree.ftl</result>
</action>清单13src/struts.xml配置片段
发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/AjaxTreeTheme.action，结果如图2所示。
总结
通过上述例子，大家知道Struts2的AJAX标志是基于Dojo控件开发的，所以如果大家希望熟练地使用这些标志，最好去了解一下Dojo。
本来还打算介绍一下Struts2与DWR，不过看看文章的篇幅似乎足够自成一篇了，因此DWR相关的内容要留待下文继续了。
相关推荐
结束数据方法的参数，该如何定义？-- 集合为自定义实体类中的结合属性，有几个实体类，改变下标就行了。<input id="add" type="button" value="新增visitor&quo