DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 XML 搭起 GWT 與 PHP 之間的橋樑
編輯:XML詳解     

為什麼需要這座橋

GWT 讓你用 Java 撰寫前端,編譯後成為 JavaScript 在瀏覽器執行;要取用後端資料時,最直覺的方式是呼叫以 Java 寫成的 servlet,資料在瀏覽器與伺服器之間的往返幾乎是透明的。但 GWT 並不把自己的 RPC 機制當成唯一出口——只要能發出 HTTP 請求,任何型別的 Web 服務都可以成為它交換資料的對象。

結構單純的服務,用純文字溝通就够了;一旦資料開始有層級、有巢狀結構(RSS 摘要、地理位置、交易訊息),XML 依然是跨語言、跨平台最省心的共同語言。

本文用一個小型 GWT 表單搭配兩個 PHP 服務,把「產生 XML」與「讀取 XML」這兩件事在多種寫法下各走一遍。目標不是窮舉所有 API,而是給你一份足以立刻動手的路線圖。

範例應用:國家、地區與城市

為了讓 XML 往返有真實資料可看,範例採用一份「國家/地區/城市」的地理資料。資料模型的關係相當單純:

  • 國家(country)具唯一代碼與名稱,例如 UY 代表烏拉圭。
  • 每個國家劃分為多個地區(region),地區代碼只在所屬國家內唯一。
  • 每個地區下有多座城市(city),城市有純 ASCII 名稱、可能含外來字元的別名、人口(未知時記為 0)、經緯度。同一國家的不同地區可以出現同名城市。

建立資料庫的 SQL 如下:

CREATE DATABASE world
  DEFAULT CHARACTER SET latin1
  COLLATE latin1_general_ci;

USE world;

CREATE TABLE countries (
  countryCode char(2) NOT NULL,
  countryName varchar(50) NOT NULL,
  PRIMARY KEY (countryCode),
  KEY countryName (countryName)
);

CREATE TABLE regions (
  countryCode char(2) NOT NULL,
  regionCode char(2) NOT NULL,
  regionName varchar(50) NOT NULL,
  PRIMARY KEY (countryCode, regionCode),
  KEY regionName (regionName)
);

CREATE TABLE cities (
  countryCode char(2) NOT NULL,
  cityName varchar(50) NOT NULL,
  cityAccentedName varchar(50) NOT NULL,
  regionCode char(2) NOT NULL,
  population bigint(20) NOT NULL,
  latitude float(10,7) NOT NULL,
  longitude float(10,7) NOT NULL,
  KEY `INDEX` (countryCode, regionCode, cityName),
  KEY cityName (cityName),
  KEY cityAccentedName (cityAccentedName)
);

GWT 專案本身很小:一個表單、兩個 PHP 服務(完整原始碼見文末下載一節)。啟動後會看到圖 1 的空白視窗。

圖 1. 尚未查詢的表單

圖片看不清楚?請點擊這裡查看原圖(大圖)。

表單讓使用者輸入城市名稱的片段,按下 Get Cities 後呼叫 PHP 服務,取回所有符合條件的城市並填入網格。網格中的人口、緯度、經度三欄可直接編輯;改完再按另一顆按鈕,資料就送往第二個 PHP 服務寫回資料庫。整趟往返都靠 XML 承載。2009 年適逢達爾文誕生兩百週年、《物種起源》出版一百五十週年,用 DARWIN 搜尋剛好能撈出幾座相關城市,結果見圖 2。

圖 2. 搜尋城市名稱含「Darwin」的結果

圖片看不清楚?請點擊這裡查看原圖(大圖)。

幾項環境上的前置作業

本文使用的環境版本如下,僅供參考:

  • GWT 1.5.3
  • PHP 5.2.8
  • MySQL 5.0.67
  • Apache 2.2.10,執行於 OpenSUSE 11.1

這些元件安裝後大致開箱可用,只有 GWT 需要多一步設定,否則跨來源(cross-origin)的請求會在 Hosted 模式下被瀏覽器攔下。做法是在 GWT 目錄下的 ./mozilla-1.7.12/greprefs/all.js 檔案尾端補上下列偏好設定:

pref("capability.policy.default.XMLHttpRequest.abort", "allAccess");
pref("capability.policy.default.XMLHttpRequest.getAllResponseHeaders", "allAccess");
pref("capability.policy.default.XMLHttpRequest.getResponseHeader", "allAccess");
pref("capability.policy.default.XMLHttpRequest.open", "allAccess");
pref("capability.policy.default.XMLHttpRequest.send", "allAccess");
pref("capability.policy.default.XMLHttpRequest.setRequestHeader", "allAccess");
pref("capability.policy.default.XMLHttpRequest.onreadystatechange", "allAccess");
pref("capability.policy.default.XMLHttpRequest.readyState", "allAccess");
pref("capability.policy.default.XMLHttpRequest.responseText", "allAccess");
pref("capability.policy.default.XMLHttpRequest.responseXML", "allAccess");
pref("capability.policy.default.XMLHttpRequest.status", "allAccess");
pref("capability.policy.default.XMLHttpRequest.statusText", "allAccess");

兩點提醒。第一,每次升級 GWT 之後都得重做這項修改。第二,也是更容易讓人栽跟頭的一點:同源政策(same-origin policy)造成的失敗往往只在 Hosted 模式下出現,Compiled 模式下反而正常;改完設定之後也可能反過來——Hosted 模式能跑,Compiled 模式卻出錯。遇到「本機測試正常、部署後異常」這類怪象時,先回來檢查這份清單。

從 PHP 送出 XML

這個表單只包含幾個標籤、一個文字框、兩顆按鈕和一個顯示結果的網格。按下 Get Cities 時,應用程式呼叫 PHP 服務,取回一份 XML 文件。以下是一段簡化後的範例輸出:

<?xml version="1.0" encoding="UTF-8"?>
<cities>
  <city name="tokyo">
    <country code="JP" name="Japan"/>
    <region code="40" name="Tokyo"/>
    <coords>
      <lat>35.6850014</lat>
      <lon>139.7513885</lon>
    </coords>
    <pop>31480498</pop>
  </city>
  <city name="tokyo">
    <country code="PG" name="Papua New Guinea"/>
    <region code="01" name="Central"/>
    <coords>
      <lat>-8.3999996</lat>
      <lon>147.1499939</lon>
    </coords>
  </city>
  <city name="tokyojitori">
    <country code="KR" name="Korea, Republic of"/>
    <region code="16" name="Cholla-namdo"/>
    <coords>
      <lat>34.2380562</lat>
      <lon>125.9394455</lon>
    </coords>
  </city>
</cities>

這份輸出刻意寫得比實際需要的囉嗦,用來示範幾種 XML 特性。真正上線的服務通常會更精簡:多用屬性、少用元素,不刻意縮排,整體體積也小得多。

服務端準備了兩個版本,getcities1.php 與 getcities2.php,各自示範一種產生 XML 的思路。

做法一:直接 echo 字串

最省事的寫法是逐段輸出文字,或先拼成字串再用 echo 送出。有兩件事不能忘:把 Content-Type 設為 text/xml,讓接收端能正確辨識;輸出開頭加上宣告行,標明 XML 版本與編碼。另外,所有值都必須轉義,避免 <、>、& 這類字元破壞文件結構——PHP 端最方便的工具是 htmlspecialchars()。程式碼寫起來相當直白:

...
header("Content-type: text/xml");
...
echo '<?xml version="1.0" encoding="UTF-8"?>'."\n";
echo '<cities>'."\n";
...
while ($row = mysql_fetch_assoc($result)) {
  echo '  <city name="'.htmlspecialchars($row['cityName']).'">'."\n";
  echo '    <country code="'.$row['countryCode'].'" ';
  echo 'name="'.htmlentities($row['countryName']).'"/>'."\n";
  echo '    <region code="'.$row['regionCode'].'" ';
  echo 'name="'.htmlentities($row['regionName']).'"/>'."\n";

  echo '    <coords>'."\n";
  echo '      <lat>'.$row['latitude'].'</lat>'."\n";
  echo '      <lon>'.$row['longitude'].'</lon>'."\n";
  echo '    </coords>'."\n";

  if ($row['population'] > 0) {
    echo '    <pop>'.$row['population'].'</pop>'."\n";
  }

  echo '  </city>'."\n";
}
echo '</cities>'."\n";

縮排與換行對解析結果毫無影響,留著只是為了讓輸出比較容易閱讀。

做法二:改用 XMLWriter

另一條路是使用 XMLWriter(與之成對的 XMLReader 則用於讀取)。最大的好處是轉義交給類別處理,不必自己操心。程式碼看起來比 echo 版多了幾行,但每個步驟在做什麼清楚得多,後續維護也更輕鬆。這裡刻意使用 php://output 協定,讓輸出直接走標準輸出:

...
$writer = new XMLWriter();
$writer->openURI('php://output');
$writer->startDocument('1.0', 'UTF-8');
$writer->startElement('cities');

while ($row = mysql_fetch_assoc($result)) {
  $writer->startElement('city');
  $writer->writeAttribute('name', $row['cityName']);

  $writer->startElement('country');
  $writer->writeAttribute('code', $row['countryCode']);
  $writer->writeAttribute('name', $row['countryName']);
  $writer->endElement();

  $writer->startElement('region');
  $writer->writeAttribute('code', $row['regionCode']);
  $writer->writeAttribute('name', $row['regionName']);
  $writer->endElement();

  $writer->startElement('coords');
  $writer->writeElement('lat', $row['latitude']);
  $writer->writeElement('lon', $row['longitude']);
  $writer->endElement();

  if ($row['population'] > 0) {
    $writer->writeElement('pop', $row['population']);
  }

  $writer->endElement(); // city
}
$writer->endElement(); // cities
...

想多比較幾種寫法也沒問題,PHP 在這方面選擇很多。SimpleXML 除了後面會用到的讀取功能,本身也能建立文件;PEAR 框架中同樣有幾個專門負責產生 XML 的類別,值得一讀。

用 GWT 解析 XML

GWT 端只有一個工具:com.google.gwt.xml.client 套件裡的 XMLParser,讀與寫都靠它。呼叫 parse() 取得 Document,再用 getDocumentElement() 拿到根元素,之後就能開始走訪節點。

這裡有個務必記住的動作:呼叫 removeWhitespace() 清掉空白節點。瀏覽器的解析器常會為縮排與換行產生空文字節點,若不清除,後續遍歷就會撞上一堆意料之外的元素,把判斷邏輯搞得一團亂。另一個容易忽略的細節是 CDATA:若預期文件裡會出現 CDATA 區段,最好先用 supportsCDATASection() 確認瀏覽器支援與否;不支援時,那些區段會被當成普通文字節點處理。

protected void loadCities(final String xmlCities) {
  ...
  final Document xmlDoc = XMLParser.parse(xmlCities);
  final Element root = xmlDoc.getDocumentElement();
  XMLParser.removeWhitespace(xmlDoc);

  final NodeList cities = root.getElementsByTagName("city");
  for (int i = 0; i < cities.getLength(); i++) {
    final Element city = (Element) cities.item(i);
    // city.getAttributeNode("name").getValue()

    final Element country = (Element) city.getElementsByTagName("country").item(0);
    // country.getAttributeNode("code").getValue()
    // country.getAttributeNode("name").getValue()
    ...

    final Element population = (Element) city.getElementsByTagName("pop").item(0);
    if (population != null) {
      // population.getFirstChild().getNodeValue()
    }

    final Element coords = (Element) city.getElementsByTagName("coords").item(0);
    final Element lat = (Element) coords.getElementsByTagName("lat").item(0);
    // lat.getFirstChild().getNodeValue()
    ...
  }
  ...
}

取重複出現的元素(本例中的 city)時,用 getElementsByTagName() 取得 NodeList 再迭代;也可以先用 getFirstChild(),靠 getNextSibling() 逐個走訪同層節點。屬性的讀取則是兩步:getAttributeNode() 之後接 getValue()。除此之外,CDATA、註解與其他 XML 元件都有對應的處理方法。

從 GWT 送出 XML

使用者編輯完人口與經緯度後,GWT 應用程式要把整個城市清單送回伺服器。這裡同樣有兩種算法:一種是直接拼字串,另一種是借助 XMLParser 逐節點建構。

做法一:逐段拼接字串

較直覺的版本示範在 getCities1() 裡。用 String 或 StringBuffer 都可以,範例選了前者因為讀起來清楚;若在意效能,後者會是更好的選擇。轉義問題在這裡同樣存在,交給 Html.Htmlspecialchars() 處理即可。

protected String getCities1() {
  String result = "";

  result += "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
  result += "<cities>\n";

  for (all rows in the grid) {
    // 從網格取出 cityName, countryCode, regionCode, pop, lat, lon

    result += "  <city name=\"" + Html.Htmlspecialchars(cityName) + "\">\n";
    result += "    <country code=\"" + countryCode + "\"/>\n";
    result += "    <region code=\"" + regionCode + "\"/>\n";
    if (!pop.equals("0") && !pop.isEmpty()) {
      result += "    <pop>" + pop + "</pop>\n";
    }

    result += "    <coords>\n";
    result += "      <lat>" + lat + "</lat>\n";
    result += "      <lon>" + lon + "</lon>\n";
    result += "    </coords>\n";
    result += "  </city>\n";
  }
  result += "</cities>\n";
  return result;
}

做法二:用 XMLParser 建構文件樹

另一種寫法來自 XMLParser.createDocument(),風格與 PHP 的 SimpleXML 頗為相似:先建空的 Document,再逐步掛上元素、設定屬性,最後用標準的 toString() 把整棵樹序列化為字串。你只要在結果前面補上宣告行與編碼,就得到可以直接送出的字串。

protected String getCities2() {
  Document xml = XMLParser.createDocument();
  Element cities = xml.createElement("cities");
  xml.appendChild(cities);

  for (all rows in the grid) {
    // 從網格取出 cityName, countryCode, regionCode, pop, lat, lon

    Element city = xml.createElement("city");
    city.setAttribute("name", cityName);

    Element country = xml.createElement("country");
    country.setAttribute("code", countryCode);
    city.appendChild(country);
    ...

    if (!pop.equals("0") && !pop.isEmpty()) {
      Element popEl = xml.createElement("pop");
      Text popText = xml.createTextNode(pop);
      popEl.appendChild(popText);
      city.appendChild(popEl);
    }

    Element coords = xml.createElement("coords");
    Element lat = xml.createElement("lat");
    Text latText = xml.createTextNode(lat);
    lat.appendChild(latText);
    coords.appendChild(lat);
    ...

    city.appendChild(coords);
    cities.appendChild(city);
  }
  return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + xml.toString();
}

在 PHP 中讀取 XML

PHP 處理 XML 的歷史悠久,方案也多,但若論簡潔易讀,SimpleXML 很難被超越。核心只有一步:把 XML 字串交給 simplexml_load_string() 得到物件,之後用一般 PHP 語法遍歷即可。屬性變成陣列元素,子元素則可以用 children() 當陣列走,或直接當成物件屬性存取。

$xml_str = $_POST["xmlData"];
$xml_obj = simplexml_load_string($xml_str);
...
foreach ($xml_obj->children() as $city) {
  $name    = addslashes($city['name']);
  $country = $city->country['code'];
  $region  = $city->region['code'];
  $pop     = $city->pop;
  $lat     = $city->coords->lat;
  $lon     = $city->coords->lon;

  mysql_query("REPLACE INTO cities ".
    "(cityName, countryCode, regionCode, population, latitude, longitude) VALUES (".
    "'{$name}', '{$country}', '{$region}', '{$pop}', '{$lat}', '{$lon}')");
}

除了 SimpleXML,PHP 裡還有 DOM、XMLReader、XML-RPC 等各式工具可以勝任這件事,端看你的專案偏好。

結語

把 XML 當成 GWT 與 PHP 之間的橋樑,做法遠比想像中多,本文只觸及其中幾條路徑,但足以讓你踏出第一步。真正該記住的是觀念上的轉變:GWT 不該被自家 RPC 機制框住,它天生就能與 XML 好好相處——產生文件容易,消費文件也不難。當前端是 Java、後端是 PHP 時,XML 就是那份雙方都願意簽字的合約。

下載

內容檔名大小方式
本文的 Java 原始碼Java_source_code.zip4KBHTTP
本文的 PHP 原始碼PHP_source_code.zip4KBHTTP
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved