[url]http://www.blogjava.net/max/archive/2007/06/27/126648.html[/url]
在上一篇文章《Struts 2與AJAX(第一部分)》,我已經簡單地介紹了<s:tree />的一些用法,接下來我将繼續深入講解<s:tree />的使用和通過DWR實作AJAX校驗。
更多<s:tree />
在Struts 2的showcase中有兩個<s:tree />的例子,分别是靜态樹與動态樹。所謂的靜态樹即是在編寫JSP代碼時通過<s:treenode />生成樹節點。我的上一篇文章的例子就是一個典型的靜态樹。而動态樹則是在程式運作期間,Struts 2 運作時(Runtime)根據程式中的資料動态建立樹節點。雖然在兩個例子中<s:tree />的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類進行如此包裝,是因為<s:tree />用于動态樹時,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頁面的<s:tree />的根節點。如下代碼所示:
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts 2 AJAX - More Tree</title>
<s:head theme="ajax" debug="true" />
<script type="text/javascript">
function treeNodeSelected(arg) {
alert(arg.source.title + ' selected');
}
function treeNodeExpanded(arg) {
alert(arg.source.title + ' expanded');
}
function treeNodeCollapsed(arg) {
alert(arg.source.title + ' collapsed');
}
dojo.addOnLoad(function() {
var t = dojo.widget.byId('appFiles');
dojo.event.topic.subscribe(t.eventNames.expand, treeNodeExpanded);
dojo.event.topic.subscribe(t.eventNames.collapse, treeNodeCollapsed);
var s = t.selector;
dojo.event.connect(s, 'select', 'treeNodeSelected');
});
</script>
</head>
<body>
<h2>
Dynamic Tree Example
</h2>
<div style="float:left; margin-right: 50px;">
<s:tree id="appFiles" theme="ajax" rootNode="root"
nodeTitleProperty="name" nodeIdProperty="id"
childCollectionProperty="children" />
</div>
</body>
</html>清單3 WebContent/Tree.jsp
因為<s:tree />的treeCollapsedTopic和treeExpandedTopic屬性都沒有起作用,是以如果我們想要監聽這兩個事件,就必須使用上述代碼的方法。
最後是struts.xml配置檔案:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="Struts2_AJAX_DEMO" extends="struts-default">
<action name="DynamicTree" class="tutorial.DynamicTreeAction">
<result>Tree.jsp</result>
</action>
</package>
</struts>清單4 src/struts.xml
釋出運作應用程式,在浏覽器位址欄中鍵入http://localhost:8080/Struts2_Ajax2/DynamicTree.action,有如下圖所示頁面:
圖1 動态樹示例
AJAX 樹正如我在文章開頭所說,Struts 2所提供的靜态樹和動态樹都不是嚴格意義上的AJAX樹。下面就讓我們來實作一個如假包換的AJAX樹。首先要說明的是,Struts 2的<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:\\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</#if>, "id": "${r.id}", "objectId": "${r.absolutePath?js_string}" }<#if r_has_next>,</#if>
</#list>
]清單7 WebContent/AjaxTree.ftl
以上代碼中<#list></#lsit>的寫法是Freemarker中周遊集合的寫法;而<#if r.children?size gt 0>判斷“r”對象的children屬性是否為空;r.absolutePath?js_string 就是将“r”的absolutePath屬性的值輸出為Javascript 的字串符形式;<#if r_has_next></#if>判斷集合是否有下一項資料。如果希望更詳細地了解Freemarker的使用,請參考該手冊。
接下來,讓我們看看Action的配置代碼片段:
<action name="AjaxTree" class="tutorial.AjaxTreeAction">
<result>AjaxTree.jsp</result>
<result name="ajax" type="freemarker">AjaxTree.ftl</result>
</action>清單8 src/struts.xml配置片段
最後是JSP頁面代碼:
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts 2 AJAX - More Tree</title>
<s:head theme="ajax" debug="true" />
<script type="text/javascript">
function treeNodeSelected(arg) {
alert(arg.source.title + ' selected');
}
dojo.addOnLoad(function() {
var t = dojo.widget.byId('appFiles');
var s = t.selector;
dojo.event.connect(s, 'select', 'treeNodeSelected');
});
</script>
</head>
<body>
<h2>
AJAX Tree Example
</h2>
<div style="float:left; margin-right: 50px;">
<script type="text/javascript">
dojo.require("dojo.lang.*");
dojo.require("dojo.widget.*");
dojo.require("dojo.widget.Tree");
dojo.require("dojo.widget.TreeRPCController");
</script>
<div dojoType="TreeRPCController" widgetId="treeController"
DNDcontroller="create" RPCUrl="<s:url />"></div>
<div dojoType="Tree" widgetId="appFiles" toggle="fade" controller="treeController">
<div dojoType="TreeNode" title='<s:property value="root.name" />'
widgetId='<s:property value="root.id" />'
isFolder='<s:property value="root.children.length > 0" />'
objectId='<s:property value="root.absolutePath" />'>
</div>
</div>
</div>
</body>
</html>清單9 WebContent/AjaxTree.jsp
由于上面所提及的原因,我在上述的代碼中并沒有使用<s:tree />标志,而是使用了Dojo的寫法——建立 widgetId 為“treeController”的 TreeRPCController 并将設為樹的控制器。
釋出運作應用程式,在浏覽器位址欄中鍵入http://localhost:8080/Struts2_Ajax2/AjaxTree.action,點開某個節點,在節點加載的過程中,加号圖示變成時鐘狀圖示,如下圖所示頁面:
圖2 AJAX樹示例
自定義<s:tree />的AJAX的主題(theme)Struts 2的标志過人之外在于它允許開發人員自定義标志的頁面輸出。要做到這一點,你所需要做的隻是建立一個自定義的theme并将其應用到相應标志。下面就讓我自定義一個真正的AJAX的<s:tree/>的theme。
首先,你的源檔案的根目錄下建立包“template.realajax”。
然後,在上一步所建的包中建立“tree.ftl”檔案,内容如下:
<script type="text/javascript">
dojo.require("dojo.lang.*");
dojo.require("dojo.widget.*");
dojo.require("dojo.widget.Tree");
dojo.require("dojo.widget.TreeRPCController"); <#-- Added by Max -->
</script>
<#-- Added by Max -->
<div dojoType="TreeRPCController"
widgetId="${parameters.id?html}_controller"
DNDcontroller="create"
RPCUrl="<@s.url />">
</div>
<#-- End -->
<div dojoType="Tree"
<#if parameters.blankIconSrc?exists>
gridIconSrcT="<@s.url value='${parameters.blankIconSrc}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcL?exists>
gridIconSrcL="<@s.url value='${parameters.gridIconSrcL}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcV?exists>
gridIconSrcV="<@s.url value='${parameters.gridIconSrcV}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcP?exists>
gridIconSrcP="<@s.url value='${parameters.gridIconSrcP}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcC?exists>
gridIconSrcC="<@s.url value='${parameters.gridIconSrcC}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcX?exists>
gridIconSrcX="<@s.url value='${parameters.gridIconSrcX}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcY?exists>
gridIconSrcY="<@s.url value='${parameters.gridIconSrcY}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.gridIconSrcZ?exists>
gridIconSrcZ="<@s.url value='${parameters.gridIconSrcZ}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.expandIconSrcPlus?exists>
expandIconSrcPlus="<@s.url value='${parameters.expandIconSrcPlus}' includeParams='none'/>"
</#if>
<#if parameters.expandIconSrcMinus?exists>
expandIconSrcMinus="<@s.url value='${parameters.expandIconSrcMinus?html}' includeParams='none'/>"
</#if>
<#if parameters.iconWidth?exists>
iconWidth="<@s.url value='${parameters.iconWidth?html}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.iconHeight?exists>
iconHeight="<@s.url value='${parameters.iconHeight?html}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.toggleDuration?exists>
toggleDuration=${parameters.toggleDuration?c}
</#if>
<#if parameters.templateCssPath?exists>
templateCssPath="<@s.url value='${parameters.templateCssPath}' encode="false" includeParams='none'/>"
</#if>
<#if parameters.showGrid?exists>
showGrid="${parameters.showGrid?default(true)?string}"
</#if>
<#if parameters.showRootGrid?exists>
showRootGrid="${parameters.showRootGrid?default(true)?string}"
</#if>
<#if parameters.id?exists>
id="${parameters.id?html}"
</#if>
<#if parameters.treeSelectedTopic?exists>
publishSelectionTopic="${parameters.treeSelectedTopic?html}"
</#if>
<#if parameters.treeExpandedTopic?exists>
publishExpandedTopic="${parameters.treeExpandedTopic?html}"
</#if>
<#if parameters.treeCollapsedTopic?exists>
publishCollapsedTopic="${parameters.treeCollapsedTopic?html}"
</#if>
<#if parameters.toggle?exists>
toggle="${parameters.toggle?html}"
</#if>
controller="${parameters.id?html}_controller" <#-- Added by Max -->
>
<#if parameters.label?exists>
<div dojoType="TreeNode" title="${parameters.label?html}"
<#if parameters.nodeIdProperty?exists>
id="${stack.findValue(parameters.nodeIdProperty)}"
<#else>
id="${parameters.id}_root"
</#if>
>
<#elseif parameters.rootNode?exists>
${stack.push(parameters.rootNode)}
<#-- Edited by Max -->
<div dojoType="TreeNode"
title="${stack.findValue(parameters.nodeTitleProperty)}"
widgetId="${stack.findValue(parameters.nodeIdProperty)}"
isFolder="<#if stack.findValue(parameters.childCollectionProperty)?size gt 0>true<#else>false</#if>"
objectId="${stack.findValue(parameters.nameValue)}">
</div>
<#-- End -->
<#assign oldNode = stack.pop()/> <#-- pop the node off of the stack, but don't show it -->
</#if> 清單10 src/template/realajax/tree.ftl
對上述稍作解釋,上述代碼主要在原版的src/template/ajax/tree.ftl的基礎上添加了TreeRPCController的控件,并隻輸出根節點。由于<s:tree />沒有類似nodeObjectIdProperty的屬性,是以我用了value屬性表示objectId對應的屬性名稱。
接着建立tree-close.ftl檔案,内容和原版的一樣,如下所示:
<#if parameters.label?exists></div></#if></div>清單11 src/template/realajax/tree-close.ftl
再下來就應該是将theme應用到<s:tree />,如下代碼所示:
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Struts 2 AJAX - More Tree</title>
<s:head theme="ajax" debug="true" />
<script type="text/javascript">
function treeNodeSelected(arg) {
alert(arg.source.title + ' selected');
}
dojo.addOnLoad(function() {
var t = dojo.widget.byId('appFiles');
var s = t.selector;
dojo.event.connect(s, 'select', 'treeNodeSelected');
});
</script>
</head>
<body>
<h2>
AJAX Tree Example
</h2>
<div style="float:left; margin-right: 50px;">
<s:tree id="appFiles" theme="realajax" rootNode="root"
nodeTitleProperty="name" nodeIdProperty="id"
childCollectionProperty="children" value="absolutePath" />
</div>
</body>
</html>清單12 WebContent/AjaxTreeTheme.jsp
上述代碼中<s:tree />的用法,除了theme改為“realajax”和多了value="absolutePath"外,幾乎和靜态樹中的一樣。
為了不影響前一個例子,我們為該JSP檔案配置類型相同的Action,如下代碼所示:
<action name="AjaxTreeTheme" class="tutorial.AjaxTreeAction">
<result>AjaxTreeTheme.jsp</result>
<result name="ajax" type="freemarker">AjaxTree.ftl</result>
</action>清單13 src/struts.xml配置片段
釋出運作應用程式,在浏覽器位址欄中鍵入http://localhost:8080/Struts2_Ajax2/AjaxTreeTheme.action,結果如圖2所示。
總結
通過上述例子,大家知道Struts 2 的AJAX 标志是基于Dojo控件開發的,是以如果大家希望熟練地使用這些标志,最好去了解一下Dojo。
本來還打算介紹一下Struts 2與DWR,不過看看文章的篇幅似乎足夠自成一篇了,是以DWR相關的内容要留待下文繼續了。
[url][/url][url][/url][url][/url]