提要 本文說明如何運用 Ajax 與 JSON 解析器,在客戶端與伺服器之間建立一個能傳遞複雜結構的資料傳輸層。
Ajax 已經是當代 Web 開發裡相當有力的互動技術,但它還有許多可能性未被普遍使用。本文要探討的,是怎麼用 JavaScript 物件標記法(JSON)與一支 JSON 解析器,在伺服器與客戶端 Ajax 引擎之間搭出一條既複雜又強壯的資料通道。
我們會依序處理三件事:如何建立一組物件(在其他語言裡,這通常被稱為「套件」);如何把這些物件序列化成 JSON 送到伺服器;以及如何把伺服器回傳的 JSON 反序列化回客戶端的 JavaScript 物件。
閱讀本文之前,請先具備 JavaScript 基礎,並已能打造一個基本的 Ajax 引擎、透過它送出請求並接收回應。文中使用的 JSON 解析器出自 Douglas Crockford 的網站。
為了讓引擎程式碼能在不同專案之間共用,本文使用了一個自製的 Ajax 引擎。使用方式很簡單:引入三支 JavaScript 檔,然後向名為 AjaxUpdater 的物件發出請求,剩下的交給引擎處理,包括把回應代理到請求時指定的回呼方法。
<script type="text/javascript" src="javascript/model/Ajax.js"></script>
<script type="text/javascript" src="javascript/model/HTTP.js"></script>
<script type="text/javascript" src="javascript/model/AjaxUpdater.js"></script>
<script type="text/javascript">
document.load = AjaxUpdater.Update('GET', URL, callback);
</script>
JavaScript 常被誤解,彷彿它主要拿來做瀏覽器端的視覺效果。實際上它是一種相當有力的語言,尤其與 Ajax 及伺服器端結合之後;而即使在客戶端,它能做的事也遠比多數人預期的多。物件導向的 JavaScript 就是一個例子:我們能建立物件、擴充內建物件,甚至把物件組織成易於管理的套件。
本文的範例建立三個物件:Auto、Car、Wheel。每個都很簡單,重點是示範怎麼把它們組成一層一層的結構。
首先是 Auto,宣告為一個新物件:
var Auto = new Object();
這個 Auto 物件將作為 Car 的父層。Car 因此成為 Auto 的一個屬性,只是被拆到另一個檔案裡以便管理——這個手法在其他物件導向語言裡很常見,在 JavaScript 裡卻不常被提起:
Auto.Car = new Object();
Auto.Car.color = "#fff";
Auto.Car.setColor = function(_color)
{
Auto.Car.color = _color;
}
Auto.Car.setColor("#333");
如你所見,Car 是 Auto 的子物件,這明顯是一種物件階層結構。它有一個名為 color 的屬性,以及一個用來設定它的方法。這裡我們把 color 設成灰色,覆蓋掉預設的白色——稍後序列化時,請記住這個事實。
下一個物件 Wheel 是 Car 的子物件:
Auto.Car.Wheel = new Object(); Auto.Car.Wheel.color = "#000";
Wheel 是個基本物件,但它把階層又往下推了一層。它有一個 color 屬性,預設值是黑色。
有了 JSON 解析器,把剛才那些物件序列化就變得非常容易。先下載解析器並放進文件的 javascript/utils 目錄下,然後引入:
<script type="text/javascript" src="javascript/Auto.js"></script> <script type="text/javascript" src="javascript/Car.js"></script> <script type="text/javascript" src="javascript/Wheel.js"></script> <script type="text/javascript" src="javascript/utils/jsonparser.js"></script> <script type="text/javascript" src="javascript/model/Ajax.js"></script> <script type="text/javascript" src="javascript/model/HTTP.js"></script> <script type="text/javascript" src="javascript/model/AjaxUpdater.js"></script>
接著在 HTML 裡放兩個 div 當顯示區,一個 id 是 loading(供 Ajax 引擎顯示進度),一個是 body(顯示訊息):
<div id="loading"></div> <div id="body"></div>
然後在 body 的 onload 事件中,把 body 的 innerHTML 設成序列化後的物件字串。這裡用到 jsonparser.js 提供的 toJSONString 方法:
<body onload="document.getElementById('body').innerHTML =
'<b>Local objects serialized as JSON</b><br/>Auto Object: '
+ Auto.toJSONString();">
這段程式碼取用 Auto 物件及其所有子物件,透過 toJSONString 把它們序列化成一個 JSON 字串。這份資料就可以作為與伺服器交換的格式。
還記得前面呼叫過 setColor 改變 Car 的顏色嗎?我刻意這樣做,是為了說明兩件事:序列化可以在執行期的任何時刻進行,而且結果會反映物件當下最新的狀態。
仔看 onload 那段程式你會注意到,Car 與 Wheel 都被包在方括號裡,這些方括號代表父物件 Auto。這意味著這份序列化後的 JavaScript 物件,可以在執行期被送到伺服器端保存最新資料;也可以在應用程式啟動時從伺服器端取回,用以從資料庫讀出當前狀態。最棒的地方是——所有與伺服器之間的資料交換,全程都用 JSON,過程無縫。
本文為了示範,把 JSON 回應寫成一個靜態檔案;實務上你會把這些資料存在資料庫,再由某種伺服器端語言輸出。具備這個能力之後,一條強而有力的資料交換通道就成立了。
前面已經分析過序列化,而具備基本 Ajax 經驗的你,應該不難理解資料是怎麼被送到伺服器端的。現在來看反方向。這是本文範例所提供的靜態 JSON 檔內容,也就是上一節序列化出來的那份資料:
{"Car":{"color":"#333","Wheel":{"color":"#000"}}}
請求這支 JSON 檔的寫法,就是一個普通的 Ajax 呼叫:
<a href="javascript:AjaxUpdater.Update('GET', 'json/data.json', displayResponse);">
Get remote JSON
</a>
回應抵達後,我們的回呼方法 displayResponse 被觸發,接著就能反序列化並開始使用這些物件:
<script type="text/javascript">
function displayResponse()
{
if (Ajax.checkReadyState('loading') == "OK")
{
var Auto = Ajax.request.responseText.parseJSON();
document.getElementById("body").innerHTML =
"<br/><b>Remote JSON unserialized</b>";
document.getElementById("body").innerHTML +=
"<br/>Car color: " + Auto.Car.color;
document.getElementById("body").innerHTML +=
"<br/>Wheel color: " + Auto.Car.Wheel.color;
}
}
</script>
這是最有意思的一段。拿到 responseText 之後,只要呼叫解析器的 parseJSON,就能從序列化字串重建出完整的 Auto 物件,並直接沿著 Auto.Car.color、Auto.Car.Wheel.color 這樣的路徑取值。
這個特性讓我們可以在伺服器與客戶端之間往返傳送物件,而不必像過去處理標準 XML 回應那樣,寫一大堆解析程式碼。於是我們得以打造能保留自身狀態的客戶端 JavaScript 物件——而這正是 JSON 在 Ajax 場景裡真正的價值所在:它把「資料交換」這件事的成本壓到極低,讓前端也能像後端一樣,用物件的方式思考。
實務上要補充兩點。第一,parseJSON 只該用來解析你自己伺服器輸出的資料,切勿對使用者輸入或未經信任的來源直接呼叫,否則等於把 eval 的風險引進門;現代的 JSON.parse 已內建於各家瀏覽器,優先使用它。第二,當物件結構變深、欄位變多時,明文 JSON 的字串長度會快速膨脹,這時候搭配 gzip 壓縮與只傳必要欄位的策略,收益會比任何前端技巧都明顯。