默了默

在上一篇文章《Struts 2與AJAX（第一部分）》，我已經(jīng)簡單地介紹了<s:tree />的一些用法，接下來我將繼續(xù)深入講解<s:tree />的使用和通過DWR實(shí)現(xiàn)AJAX校驗(yàn)。

更多<s:tree />

在Struts 2的showcase中有兩個(gè)<s:tree />的例子，分別是靜態(tài)樹與動(dòng)態(tài)樹。所謂的靜態(tài)樹即是在編寫JSP代碼時(shí)通過<s:treenode />生成樹節(jié)點(diǎn)。我的上一篇文章的例子就是一個(gè)典型的靜態(tài)樹。而動(dòng)態(tài)樹則是在程序運(yùn)行期間，Struts 2 運(yùn)行時(shí)（Runtime）根據(jù)程序中的數(shù)據(jù)動(dòng)態(tài)創(chuàng)建樹節(jié)點(diǎn)。雖然在兩個(gè)例子中<s:tree />的theme屬性都為“ajax”，但是從嚴(yán)格意義上來說，這兩種樹都不屬于AJAX樹，因?yàn)樗鼈兌际窃谳敵鲰撁鏁r(shí)將全部節(jié)點(diǎn)加載到其中，而不是在父節(jié)點(diǎn)展開時(shí)通過XHR（XMLHttpRequest）獲取節(jié)點(diǎn)數(shù)據(jù)。

動(dòng)態(tài)樹

下面我們先看一下動(dòng)態(tài)樹的例子，接著再一步步地將其改造為名副其實(shí)的AJAX 樹。下例將會(huì)把WEB應(yīng)用程序的目錄樹展現(xiàn)在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];
   }
}

之所以需要對(duì)File類進(jìn)行如此包裝，是因?yàn)?lt;s:tree />用于動(dòng)態(tài)樹時(shí)，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;
   }
}

上述代碼取得WEB應(yīng)用程序的根目錄的絕對(duì)路徑后，初始化FileWrapper對(duì)象root。該對(duì)象將為JSP頁面的<s:tree />的根節(jié)點(diǎn)。如下代碼所示：

因?yàn)?lt;s:tree />的treeCollapsedTopic和treeExpandedTopic屬性都沒有起作用，所以如果我們想要監(jiān)聽這兩個(gè)事件，就必須使用上述代碼的方法。

最后是struts.xml配置文件：

發(fā)布運(yùn)行應(yīng)用程序，在瀏覽器地址欄中鍵入http://localhost:8080/Struts2_Ajax2/DynamicTree.action，有如下圖所示頁面：

圖1 動(dòng)態(tài)樹示例

AJAX 樹

正如我在文章開頭所說，Struts 2所提供的靜態(tài)樹和動(dòng)態(tài)樹都不是嚴(yán)格意義上的AJAX樹。下面就讓我們來實(shí)現(xiàn)一個(gè)如假包換的AJAX樹。首先要說明的是，Struts 2的<s:tree />默認(rèn)是不支持這種按需加載數(shù)據(jù)的AJAX樹。不過因?yàn)樗腔贒ojo的樹控件（Widget）所以要擴(kuò)展也很方便。

Dojo 通過名為“TreeRPCController”的控件實(shí)現(xiàn) AJAX 樹，它會(huì)監(jiān)聽被控制樹的事件。當(dāng)發(fā)生展開節(jié)點(diǎn)的事件時(shí)，TreeRPCController就會(huì)向URL發(fā)送XHR請(qǐng)求，該URL由TreeRPCController的RPCUrl 屬性定義。XHR請(qǐng)求格式類似如下格式：

顯而易見，請(qǐng)求中包含三個(gè)參數(shù)，分別是action為“getChildren”（固定值），data一個(gè)包含當(dāng)前節(jié)點(diǎn)與樹信息的JSON串和dojo.preventCache隨機(jī)串，用于緩存不同節(jié)點(diǎn)的請(qǐng)求響應(yīng)（父節(jié)點(diǎn)只會(huì)在第一次被展開時(shí)到服務(wù)器端加載數(shù)據(jù)，之后都是從瀏覽器的緩存中讀取數(shù)據(jù)，可以提高應(yīng)用程序性能）。

首先我要先寫一個(gè)加載樹節(jié)點(diǎn)數(shù)據(jù)的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();
   }
}

上述代碼可能需要解釋一下：

1. action屬性對(duì)應(yīng)于XHR中的action，如果它為“getChildren”時(shí)，則需要進(jìn)行加載子節(jié)點(diǎn)操作。否則，會(huì)讀取樹的根節(jié)點(diǎn)，并返回JSP頁面；
2. 通過上面XHR的分析，大家可以知道data是代表樹和當(dāng)前節(jié)點(diǎn)的JSON串，故應(yīng)將其反串行化為Map對(duì)象，并將其 objectId屬性取出。通常情況下，Dojo樹的objectId屬性代表服務(wù)器端的對(duì)象的標(biāo)識(shí)，在本例中為文件夾的絕對(duì)路徑；
3. wrappers屬性表示當(dāng)前文件夾下的文件數(shù)組，它被傳送到Freemarker頁面，翻譯為Dojo樹節(jié)點(diǎn)數(shù)組的JSON串。

下面是Freemarker頁面的代碼：

以上代碼中<#list></#lsit>的寫法是Freemarker中遍歷集合的寫法；而<#if r.children?size gt 0>判斷“r”對(duì)象的children屬性是否為空；r.absolutePath?js_string 就是將“r”的absolutePath屬性的值輸出為Javascript 的字串符形式；<#if r_has_next></#if>判斷集合是否有下一項(xiàng)數(shù)據(jù)。如果希望更詳細(xì)地了解Freemarker的使用，請(qǐng)參考該手冊。

接下來，讓我們看看Action的配置代碼片段：

最后是JSP頁面代碼：

由于上面所提及的原因，我在上述的代碼中并沒有使用<s:tree />標(biāo)志，而是使用了Dojo的寫法——?jiǎng)?chuàng)建 widgetId 為“treeController”的 TreeRPCController 并將設(shè)為樹的控制器。

發(fā)布運(yùn)行應(yīng)用程序，在瀏覽器地址欄中鍵入http://localhost:8080/Struts2_Ajax2/AjaxTree.action，點(diǎn)開某個(gè)節(jié)點(diǎn)，在節(jié)點(diǎn)加載的過程中，加號(hào)圖標(biāo)變成時(shí)鐘狀圖標(biāo)，如下圖所示頁面：

圖2 AJAX樹示例

自定義<s:tree />的AJAX的主題（theme）

Struts 2的標(biāo)志過人之外在于它允許開發(fā)人員自定義標(biāo)志的頁面輸出。要做到這一點(diǎn)，你所需要做的只是創(chuàng)建一個(gè)自定義的theme并將其應(yīng)用到相應(yīng)標(biāo)志。下面就讓我自定義一個(gè)真正的AJAX的<s:tree/>的theme。

首先，你的源文件的根目錄下新建包“template.realajax”。

然后，在上一步所建的包中新建“tree.ftl”文件，內(nèi)容如下：

對(duì)上述稍作解釋，上述代碼主要在原版的src/template/ajax/tree.ftl的基礎(chǔ)上添加了TreeRPCController的控件，并只輸出根節(jié)點(diǎn)。由于<s:tree />沒有類似nodeObjectIdProperty的屬性，所以我用了value屬性表示objectId對(duì)應(yīng)的屬性名稱。

接著新建tree-close.ftl文件，內(nèi)容和原版的一樣，如下所示：

再下來就應(yīng)該是將theme應(yīng)用到<s:tree />，如下代碼所示：

上述代碼中<s:tree />的用法，除了theme改為“realajax”和多了value="absolutePath"外，幾乎和靜態(tài)樹中的一樣。

為了不影響前一個(gè)例子，我們?yōu)樵揓SP文件配置類型相同的Action，如下代碼所示：

發(fā)布運(yùn)行應(yīng)用程序，在瀏覽器地址欄中鍵入http://localhost:8080/Struts2_Ajax2/AjaxTreeTheme.action，結(jié)果如圖2所示。

總結(jié)

通過上述例子，大家知道Struts 2 的AJAX 標(biāo)志是基于Dojo控件開發(fā)的，所以如果大家希望熟練地使用這些標(biāo)志，最好去了解一下Dojo。