默了默

在上一篇文章《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];
   }
}

之所以需要對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;
   }
}

上述代碼取得WEB應用程序的根目錄的絕對路徑后，初始化FileWrapper對象root。該對象將為JSP頁面的<s:tree />的根節點。如下代碼所示：

因為<s:tree />的treeCollapsedTopic和treeExpandedTopic屬性都沒有起作用，所以如果我們想要監聽這兩個事件，就必須使用上述代碼的方法。

最后是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請求格式類似如下格式：

顯而易見，請求中包含三個參數，分別是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();
   }
}

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

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

下面是Freemarker頁面的代碼：

以上代碼中<#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的配置代碼片段：

最后是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”文件，內容如下：

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

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

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

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

為了不影響前一個例子，我們為該JSP文件配置類型相同的Action，如下代碼所示：

發布運行應用程序，在瀏覽器地址欄中鍵入http://localhost:8080/Struts2_Ajax2/AjaxTreeTheme.action，結果如圖2所示。

總結

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