一、引言
如果你是 Java 軟體與 AJAX 開發者,Google Web Toolkit(GWT)想必早已引起你的關注。Google 於 2006 年 5 月在 Apache 許可協議下發布了這套免費開發工具包,目的正是簡化以 Java 開發 AJAX 應用。最初的 beta 版適用於 Windows 與 Linux,稍後才有 Mac OS X 版本。本文將完整探討如何在 Mac OS X 上,結合熟悉的 Java 工具(Apache Ant、Tomcat 5.0、IntelliJ IDEA)開發一個簡單的 AJAX 應用(本文假定讀者具備一定的 Java 與 Ant 基礎)。
我下載的是 GWT 的 Linux beta 版,以 Java 開發、用 Ant 構建文件編譯,最後發布到 Tomcat 5.0。這個 Ant 文件實際上運行的是 GWT 的 Java-to-JavaScript 編譯器——所謂「編譯器」,其實只是一個執行 GWT Java 類、為應用編寫 JavaScript 的命令行腳本。GWT beta 提供兩種開發方式:主機方式使用嵌入式 GWT 瀏覽器,代碼運行於 JVM 中;但對 Linux 版使用者而言,只有等 Google 發布 Mac OS X 版後才能使用。
在創建遠程過程調用(RPC)服務的同時,本文將探討幾項典型的 GWT 開發任務:以構建文件自動化開發與發布(運行編譯器、發布輸出、把服務端 Java 類發佈到 Tomcat、Jetty 或 Resin 等容器);用 Firefox 的 DOM Inspector 觀察生成的 HTML;在不存取內在 HTML 的前提下重設頁面部件;確保輸出符合特定 XHTML 文檔類型的標記要求。
示例應用會在瀏覽器中顯示一個表單,請使用者輸入姓名、年齡與原籍國家;提交後,程式在文字域中顯示服務器響應,而無需刷新頁面。
圖1. 一個由 GWT 生成的簡單視圖
例如當使用者留空某文字框並點擊 Submit 時,會顯示錯誤訊息:
圖2. 應用程式以紅色顯示錯誤訊息
在 AJAX 應用中使用 RPC,可免去顯式處理 XMLHttpRequest 與相關返回值的麻煩,因為 GWT 物件會替你搞定。你定義的每個服務都需實現兩個 Java 接口與一個 Java 類,編譯前須確保 gwt-user.jar 位於 classpath 中。服務接口需擴展 RemoteService:
package com.parkerriver.gwt.testapp.client;
import com.google.gwt.user.client.rpc.RemoteService;
public interface ShowRespService extends RemoteService {
String displayResponse(String req);
}
此外還需定義一個客戶端接口用於調用服務方法,GWT 採用回調設計模式,AsyncCallback 物件負責處理服務響應:
package com.parkerriver.gwt.testapp.client;
import com.google.gwt.user.client.rpc.AsyncCallback;
public interface ShowRespServiceAsync {
public void displayResponse(String s, AsyncCallback callback);
}
最後定義一個實現遠程服務接口、位於服務器端的 Java 類。它必須繼承 RemoteServiceServlet(本身繼承自 HttpServlet),並連同接口一起發布到 servlet 容器:
package com.parkerriver.gwt.testapp.server;
import com.parkerriver.gwt.testapp.client.ShowRespService;
import com.google.gwt.user.server.rpc.RemoteServiceServlet;
import java.util.Date;
public class ShowRespServiceImpl extends RemoteServiceServlet
implements ShowRespService {
public String displayResponse(String req) {
if(req.length() < 1) {
throw new IllegalArgumentException(
"Blank submissions from the client are invalid.");
}
StringBuffer buf = new StringBuffer("Your submission: ");
Date date = new Date();
String serverInfo = this.getServletContext().getServerInfo();
buf.append(req); buf.append("\n");
buf.append("Server response: "); buf.append(date.toString()); buf.append("\n");
buf.append(serverInfo);
return buf.toString();
}
}
GWT 內含命令列腳本 applicationCreator,能生成框架性的工程目錄。解壓 GWT 後即可在頂層目錄找到它:
applicationCreator -out /Users/bruceperry/1gwt/secondapp/ com.parkerriver.gwt.testapp.client.MyForm
圖3. 一個 GWT 與 IntelliJ 工程目錄
它會生成 ./src 目錄及 MyForm-compile、MyForm-shell 腳本;我的 Ant 文件執行 MyForm-compile。./src 中包含與包名匹配的嵌套目錄:
圖4. 一個 GWT 應用的 Java 包與模塊
MyForm.gwt.xml 是生成的配置檔(GWT 稱之為「模塊」),指定應用程式入口點類:
<module> <inherits name='com.google.gwt.user.User'/> <entry-point class='com.parkerriver.gwt.testapp.client.MyForm'/> </module>
其餘如 ./classes、./WEB-INF、./gwtproj.ipr 均為 IntelliJ Web 工程的必要組成;./www 目錄則在 GWT 編譯器生成代碼後才出現。
MyForm.java 實現了 GWT API 的 EntryPoint 接口,因此必須實現 onModuleLoad() 方法——當瀏覽器加載 AJAX 應用時,此方法由瀏覽器的 JavaScript 引擎調用。GWT 編譯器會把這個類編譯成 JavaScript,MyForm.java 負責建立表單 widget 並處理 OK、Submit 按鈕的響應。若需實現 JavaScript DOM 編程(如 showRpcStatus() 方法),可用 Java 調用 com.google.gwt.user.client.DOM 類。
Ant 構建文件主要完成:把 Java 編譯到 ./classes;執行 GWT 編譯腳本(本例為 MyForm-compile);把 ./www 下生成的代碼移到已發布到 Tomcat 的 Web 應用;把編譯後的 servlet 及相關接口複製到同一 Web 應用。注意:編譯 Java 類與初始化 JavaScript 轉換這兩個目標,任一環節出錯都可能使整個構建失敗。
屬性檔 gwtproj.properties 定義了部署路徑等:
web.deploy.location=/users/bruceperry/parkerriver/gwt web.classes.location=/users/bruceperry/parkerriver/WEB-INF/classes
下列 XML 描述 Ant 文件的主要功能(節選):
<?xml version="1.0" encoding="UTF-8"?>
<project name="gwtproj" default="all">
<property file="gwtproj.properties"/>
<dirname property="module.gwtproj.basedir" file="${ant.file}"/>
<property name="gwtproj.output.dir" value="${module.gwtproj.basedir}/classes"/>
<target name="gwt-compile" depends="compile.production.classes"
description="use gwt's compiler">
<delete><fileset dir="${web.deploy.location}" includes="**/*"/></delete>
<exec executable="${module.gwtproj.basedir}/MyForm-compile" failonerror="true"/>
<copy todir="${web.deploy.location}">
<fileset dir="${module.gwtproj.basedir}/www"/></copy>
</target>
<target name="compile.production.classes"
description="Compile the gwtproj production classes">
<mkdir dir="${gwtproj.output.dir}"/>
<javac destdir="${gwtproj.output.dir}" debug="on" failonerror="true"
nowarn="off" memoryMaximumSize="128m" fork="true"
executable="${module.jdk.home.gwtproj}/bin/javac">
<classpath refid="gwtproj.module.classpath"/>
<src refid="gwtproj.module.sourcepath"/>
</javac>
</target>
<target name="deploy.classes" depends="gwt-compile"
description="copy classes to web directory">
<copy todir="${web.classes.location}">
<fileset dir="${gwtproj.output.dir}"/></copy>
</target>
<target name="all" depends="deploy.classes" description="build all"/>
</project>
可在 IDE 中,或在含該構建文件的目錄下以 ant -buildfile gwtproj.xml 運行。多數情況下,修改應用並運行 Ant 後,重載瀏覽器即可看到變化。
安裝時必須把 gwt-user.jar 加入 Web 應用的 /WEB-INF/lib 目錄。我把生成的 JAR 連同 Javax 包(gwt-user-deploy.jar)都放進該目錄,因為 Tomcat 若已含 servlet API 類,便不會加載單個 Web 應用的庫檔。
applicationCreator 也會生成 HTML 前端(本例為 MyForm.html)。若應用必須符合某種標準,該怎麼辦?以 XHTML Transitional 為例,先在檔案頂部加入 DOCTYPE 與相關屬性:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/2000/REC-xhtml1-20000126/DTD/xhtml1-transitional.dtd"> <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
再上傳到 W3C 驗證器(https://validator.w3.org/),依結果微調(如適當閉合 meta 標籤、為 script 加上 type="text/javascript")。若要符合更嚴格的 XHTML Strict,改動會更複雜——例如 W3C 驗證器會把 iframe 標籤標為「undefined element」,而它正是 GWT 歷史支持功能所必需,Strict 中已刪除 iframe。這對你或許不成問題(未來版本可能解決),也可另尋策略,如擴展 GWT 類、自建相容 widget。
Web 開發中常見的難題是視覺設計——設計者往往希望頁面如 Adobe Illustrator 般精準。開發複雜 AJAX 工程時未必能完美實現,但至少可用 Firefox 的 DOM Inspector 觀察 Java 類最終生成的 HTML,再從中調整。
圖5. 使用 DOM Inspector 觀察後台實現內容
例如可看到 Java 代碼中的 com.google.gwt.user.client.ui.Grid 物件被實現為 HTML table,其中含 OK、Submit 按鈕的 TD 標籤關聯了 style="vertical-align:top"。相關 Java 代碼為:
// 設置 OK 按鈕單元格的垂直位置
grid.getCellFormatter().setVerticalAlignment(3, 0,
HasVerticalAlignment.ALIGN_TOP);
若不做這個調用,按鈕可能會在文字域中央上下浮動。
Google 發布的 GWT 已引起業界廣泛關注。既然它旨在簡化以 Java 開發 AJAX 應用,而 AJAX 又是 Web 2.0 時代的技術基礎,這份轟動便在意料之中。本文僅給出使用 GWT 與熟悉 Java 工具開發簡單 AJAX 應用的示例,更深入的探索才剛剛開始。