使用和通过DWR实现AJAX校验动态树

Struts 2与AJAX（第二部分） 在上一篇文章《Struts 2与AJAX（第一部分）》，我已经简单地介绍了的一些用法，接下来我将继续深入讲解的使用和通过DWR实现AJAX校验。 更多 在Struts 2的showcase中有两个的例子，分别是静态树与动态树。所谓的静态树即是在编写JSP代码时通过生成树节点。我的上一篇文章的例子就是一个典型的静态树。而动态树则是在程序运行期间，Struts 2 运行时（Runtime）根据程序中的数据动态创建树节点。虽然在两个例子中的theme属性都为“ajax”，但是从严格意义上来说，这两种树都不属于AJAX树，因为它们都是在输出页面时将全部节点加载到其中，而不是在父节点展开时通过XHR（XMLHttpRequest）获取节点数据。 动态树下面我们先看一下动态树的例子，接着再一步步地将其改造为名副其实的AJAX 树。下例将会把WEB应用程序的目录树展现在JSP页面中。因此，我需要先包装一下java.io.File 类，代码如下： package tutorial; import java.io.File; public class FileWrapper { private File file; public FileWrapper(String path) { file = new File(path); } public FileWrapper(File file) { this.file = file; } public String getId() { return "file_" + file.hashCode(); } public String getName() { return file.getName(); } public String getAbsolutePath() { return file.getAbsolutePath(); } public FileWrapper[] getChildren() { File[] files = file.listFiles(); if(files != null && files.length > 0) { int length = files.length; FileWrapper[] wrappers = new FileWrapper[length]; for(int i = 0; i < length; ++i) { wrappers[i] = new FileWrapper(files[i]); } return wrappers; } return new FileWrapper[0]; } }清单1 src/tutorial/FileWrapper.java 之所以需要对File类进行如此包装，是因为用于动态树时，rootNode、nodeIdProperty、nodeTitleProperty 和 childCollectionProperty等属性都必填的。 然后是Action类的代码如下： package tutorial; import javax.servlet.http.HttpServletRequest; import org.apache.struts2.interceptor.ServletRequestAware; import com.opensymphony.xwork2.ActionSupport; public class DynamicTreeAction extends ActionSupport implements ServletRequestAware { private static final long serialVersionUID = 1128593047269036737L; private HttpServletRequest request; private FileWrapper root; public void setServletRequest(HttpServletRequest request) { this.request = request; } public FileWrapper getRoot() { return root; } @Override public String execute() { root = new FileWrapper(request.getSession().getServletContext().getRealPath("/")); return SUCCESS; } }清单2 src/tutorial/DynamicTreeAction.java 上述代码取得WEB应用程序的根目录的绝对路径后，初始化FileWrapper对象root。该对象将为JSP页面的的根节点。如下代码所示： <%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%> <%@ taglib prefix="s" uri="/struts-tags"%>

Dynamic Tree Example

清单3 WebContent/Tree.jsp 因为的treeCollapsedTopic和treeExpandedTopic属性都没有起作用，所以如果我们想要监听这两个事件，就必须使用上述代码的方法。 最后是struts.xml配置文件： Tree.jsp 清单4 src/struts.xml 发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/DynamicTree.action，有如下图所示页面： 图1 动态树示例 AJAX 树正如我在文章开头所说，Struts 2所提供的静态树和动态树都不是严格意义上的AJAX树。下面就让我们来实现一个如假包换的AJAX树。首先要说明的是，Struts 2的默认是不支持这种按需加载数据的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://Program Files//Tomcat 5.5//webapps//Struts2_Ajax2","index":0,"isFolder":true},"tree":{"widgetId":"appFiles","objectId":""}}&dojo.preventCache=1182913465392清单5 XHR样本 显而易见，请求中包含三个参数，分别是action为“getChildren”（固定值），data一个包含当前节点与树信息的JSON串和dojo.preventCache随机串，用于缓存不同节点的请求响应（父节点只会在第一次被展开时到服务器端加载数据，之后都是从浏览器的缓存中读取数据，可以提高应用程序性能）。 首先我要先写一个加载树节点数据的Action类，代码如下： package tutorial; import java.util.Map; import com.googlecode.jsonplugin.JSONExeption; import com.googlecode.jsonplugin.JSONUtil; public class AjaxTreeAction extends DynamicTreeAction { private static final long serialVersionUID = 3970019751740942311L; private String action; private String data; private FileWrapper[] wrappers; public void setAction(String action) { this.action = action; } public void setData(String data) { this.data = data; } public FileWrapper[] getWrappers() { return wrappers; } @Override public String execute() { if("getChildren".equals(action)) { try { Object o = JSONUtil.deserialize(data); String path = ((Map) ((Map) o).get("node")).get("objectId").toString(); wrappers = new FileWrapper(path).getChildren(); } catch (JSONExeption e) { e.printStackTrace(); } return "ajax"; } return super.execute(); } }清单6 src/tutorial/AjaxTreeAction.java 上述代码可能需要解释一下： action属性对应于XHR中的action，如果它为“getChildren”时，则需要进行加载子节点操作。否则，会读取树的根节点，并返回JSP页面； 通过上面XHR的分析，大家可以知道data是代表树和当前节点的JSON串，故应将其反串行化为Map对象，并将其 objectId属性取出。通常情况下，Dojo树的objectId属性代表服务器端的对象的标识，在本例中为文件夹的绝对路径； wrappers属性表示当前文件夹下的文件数组，它被传送到Freemarker页面，翻译为Dojo树节点数组的JSON串。 下面是Freemarker页面的代码： [ <#list wrappers as r> { "title": "${r.name}", "isFolder": <#if r.children?size gt 0>true<#else>false, "id": "${r.id}", "objectId": "${r.absolutePath?js_string}" }<#if r_has_next>, ]清单7 WebContent/AjaxTree.ftl 以上代码中<#list>的写法是Freemarker中遍历集合的写法；而<#if r.children?size gt 0>判断“r”对象的children属性是否为空；r.absolutePath?js_string 就是将“r”的absolutePath属性的值输出为Javascript 的字串符形式；<#if r_has_next>判断集合是否有下一项数据。如果希望更详细地了解Freemarker的使用，请参考该手册。 接下来，让我们看看Action的配置代码片段： AjaxTree.jsp AjaxTree.ftl 清单8 src/struts.xml配置片段 最后是JSP页面代码： <%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%> <%@ taglib prefix="s" uri="/struts-tags"%>

AJAX Tree Example

清单9 WebContent/AjaxTree.jsp 由于上面所提及的原因，我在上述的代码中并没有使用标志，而是使用了Dojo的写法——创建 widgetId 为“treeController”的 TreeRPCController 并将设为树的控制器。 发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/AjaxTree.action，点开某个节点，在节点加载的过程中，加号图标变成时钟状图标，如下图所示页面： 图2 AJAX树示例 自定义的AJAX的主题（theme）Struts 2的标志过人之外在于它允许开发人员自定义标志的页面输出。要做到这一点，你所需要做的只是创建一个自定义的theme并将其应用到相应标志。下面就让我自定义一个真正的AJAX的的theme。 首先，你的源文件的根目录下新建包“template.realajax”。 然后，在上一步所建的包中新建“tree.ftl”文件，内容如下： /* ]]> */ // --> <#-- Added by Max -->

<#-- End -->

gridIconSrcT="<@s.url value='${parameters.blankIconSrc}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcL?exists> gridIconSrcL="<@s.url value='${parameters.gridIconSrcL}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcV?exists> gridIconSrcV="<@s.url value='${parameters.gridIconSrcV}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcP?exists> gridIconSrcP="<@s.url value='${parameters.gridIconSrcP}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcC?exists> gridIconSrcC="<@s.url value='${parameters.gridIconSrcC}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcX?exists> gridIconSrcX="<@s.url value='${parameters.gridIconSrcX}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcY?exists> gridIconSrcY="<@s.url value='${parameters.gridIconSrcY}' encode="false" includeParams='none'/>" <#if parameters.gridIconSrcZ?exists> gridIconSrcZ="<@s.url value='${parameters.gridIconSrcZ}' encode="false" includeParams='none'/>" <#if parameters.expandIconSrcPlus?exists> expandIconSrcPlus="<@s.url value='${parameters.expandIconSrcPlus}' includeParams='none'/>" <#if parameters.expandIconSrcMinus?exists> expandIconSrcMinus="<@s.url value='${parameters.expandIconSrcMinus?html}' includeParams='none'/>" <#if parameters.iconWidth?exists> iconWidth="<@s.url value='${parameters.iconWidth?html}' encode="false" includeParams='none'/>" <#if parameters.iconHeight?exists> iconHeight="<@s.url value='${parameters.iconHeight?html}' encode="false" includeParams='none'/>" <#if parameters.toggleDuration?exists> toggleDuration=${parameters.toggleDuration?c} <#if parameters.templateCssPath?exists> templateCssPath="<@s.url value='${parameters.templateCssPath}' encode="false" includeParams='none'/>" <#if parameters.showGrid?exists> showGrid="${parameters.showGrid?default(true)?string}" <#if parameters.showRootGrid?exists> showRootGrid="${parameters.showRootGrid?default(true)?string}" <#if parameters.id?exists> id="${parameters.id?html}" <#if parameters.treeSelectedTopic?exists> publishSelectionTopic="${parameters.treeSelectedTopic?html}" <#if parameters.treeExpandedTopic?exists> publishExpandedTopic="${parameters.treeExpandedTopic?html}" <#if parameters.treeCollapsedTopic?exists> publishCollapsedTopic="${parameters.treeCollapsedTopic?html}" <#if parameters.toggle?exists> toggle="${parameters.toggle?html}" controller="${parameters.id?html}_controller" <#-- Added by Max --> > <#if parameters.label?exists>

id="${stack.findValue(parameters.nodeIdProperty)}" <#else> id="${parameters.id}_root" > <#elseif parameters.rootNode?exists> ${stack.push(parameters.rootNode)} <#-- Edited by Max -->

<#-- End --> <#assign oldNode = stack.pop()/> <#-- pop the node off of the stack, but don't show it --> 清单10 src/template/realajax/tree.ftl 对上述稍作解释，上述代码主要在原版的src/template/ajax/tree.ftl的基础上添加了TreeRPCController的控件，并只输出根节点。由于没有类似nodeObjectIdProperty的属性，所以我用了value属性表示objectId对应的属性名称。 接着新建tree-close.ftl文件，内容和原版的一样，如下所示： <#if parameters.label?exists>

清单11 src/template/realajax/tree-close.ftl 再下来就应该是将theme应用到，如下代码所示： <%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%> <%@ taglib prefix="s" uri="/struts-tags"%> */ // -->

AJAX Tree Example

清单12 WebContent/AjaxTreeTheme.jsp 上述代码中的用法，除了theme改为“realajax”和多了value="absolutePath"外，几乎和静态树中的一样。 为了不影响前一个例子，我们为该JSP文件配置类型相同的Action，如下代码所示： AjaxTreeTheme.jsp AjaxTree.ftl 清单13 src/struts.xml配置片段 发布运行应用程序，在浏览器地址栏中键入http://localhost:8080/Struts2_Ajax2/AjaxTreeTheme.action，结果如图2所示。 总结 通过上述例子，大家知道Struts 2 的AJAX 标志是基于Dojo控件开发的，所以如果大家希望熟练地使用这些标志，最好去了解一下Dojo。 本来还打算介绍一下Struts 2与DWR，不过看看文章的篇幅似乎足够自成一篇了，因此DWR相关的内容要留待下文继续了。 ============================================================ <%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%> <%@ taglib prefix="s" uri="/struts-tags"%>

Tree