正如本系列上一篇所說的,JSON 之所以適合 Ajax 應用,是因為它讓 JavaScript 物件與字串值之間可以快速互相轉換。Ajax 應用的本質,就是把純文字送到伺服器端程式、再把純文字回來;相較之下,能產生文字的 API 自然比不能產生文字的 API 更受歡迎。而且 JSON 讓你直接操作本地的 JavaScript 物件,不必再為「這些物件該怎麼表示」多費心思。
XML 在文字這件事上能提供類似的好處,但把 JavaScript 物件轉成 XML 的現成 API 成熟度不如 JSON;有時候你甚至得在建立與處理 JavaScript 物件時格外小心,才能確保結果能與你選用的 XML 會話 API 合作。JSON 完全沒有這個負擔:幾乎所有可能的物件型別它都能處理,並還給你一份品質很好的 JSON 資料表示。
所以 JSON 最大的價值在於——你可以把 JavaScript 當成 JavaScript 來寫,而不是當成一種資料格式語言來遷就。你學過的所有 JavaScript 物件技巧都能直接沿用,不必為序列化傷腦筋。之後只要一行簡單的呼叫就能收尾:
String myObjectInJSON = myObject.toJSONString();
接著把結果文字送去伺服器就好。
這件事不難,但很關鍵,而且確實有幾個選擇要做。好消息是:一旦決定用 JSON,可選項不但數量有限,而且相當單純,你幾乎沒有什麼需要操心的地方。重點在於能順利把 JSON 字串送出去,而且越快越省事越好。
最直白的做法,就是把 JSON 轉成文字,再當成一個名稱/值對的值送出去。要留意的是,JSON 格式的資料往往是一個相當長的物件,長度可能超出你的預期,如下例:
清單 1. JSON 格式的簡單 JavaScript 物件
var people = { "programmers": [ { "firstName": "Brett", "lastName": "McLaughlin",
"email": "brett@newInstance.com" }, { "firstName": "Jason", "lastName": "Hunter",
"email": "jason@servlets.com" }, { "firstName": "Elliotte", "lastName": "Harold",
"email": "elharo@macfaq.com" } ], "authors": [ { "firstName": "Isaac",
"lastName": "Asimov", "genre": "science fiction" }, { "firstName": "Tad",
"lastName": "Williams", "genre": "fantasy" }, { "firstName": "Frank",
"lastName": "Peretti", "genre": "christian fiction" } ], "musicians": [
{ "firstName": "Eric", "lastName": "Clapton", "instrument": "guitar" },
{ "firstName": "Sergei", "lastName": "Rachmaninoff", "instrument": "piano" } ] }
要把它以名稱/值對送到伺服器端,寫法大致如下:
var url = "organizePeople.php?people=" + people.toJSONString();
request.open("GET", url, true);
request.onreadystatechange = updatePage;
request.send(null);
看起來沒問題,但有一個坑:JSON 資料裡會出現空格與各種特殊字元,瀏覽器往往會試圖繼續解析它們。為了避免這些字元在傳輸途中或伺服器端造成混亂,記得補上 JavaScript 的 escape():
var url = "organizePeople.php?people=" + escape(people.toJSONString());
request.open("GET", url, true);
request.onreadystatechange = updatePage;
request.send(null);
這個函式會把空格、斜線以及其他任何可能干擾瀏覽器的內容,轉換成網路上安全的寫法(例如空格變成 %20,瀏覽器不會把它當空格處理,而是原封不動地送到伺服器),伺服器端通常會自動把它還原成原本的字元。
這種做法有兩個明顯缺點:
簡單說,這是 GET 本身的兩個限制,而不是 JSON 特有的問題。當你想傳的不只是姓名,還包含表單中的各項選擇時,這兩點就值得留意。若內容涉及機密或篇幅很長,請改用 POST。
改用 POST 之後,程式碼幾乎不需要大改:
var url = "organizePeople.php?timeStamp=" + new Date().getTime();
request.open("POST", url, true);
request.onreadystatechange = updatePage;
request.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
request.send(people.toJSONString());
這裡大部分內容你應該在〈掌握 Ajax,第 3 部分:Ajax 中的進階請求與回應〉裡見過:請求改用 POST 開啟,並設定 Content-Type 標頭,讓伺服器預先知道會收到哪一類資料。此處設為 application/x-www-form-urlencoded,等於告訴伺服器「現在送來的是文字」,就像它從一般的 HTML 表單收到的那樣。
另一個實用小技巧是在 URL 後面加上時間戳。這樣可以確保請求不會在第一次送出後就被快取,而是每次呼叫都重新建立並重新發送——因為時間戳不同,URL 也就略有差異。這個手法常用來確保打到腳本的 POST 每次都真的產生新請求,Web 伺服器不會拿舊的回應來充數。
不論用 GET 還是 POST,關鍵都在於:JSON 只是文字。既不需要特殊編碼,而任何伺服器端腳本都處理得了文字,所以把 JSON 接進伺服器輕而易舉。假如它是某種二進位格式或奇怪的文字編碼,事情就不會這麼簡單了;幸好它就是普通的文字資料(從 POST 本文與 Content-Type 標頭也能看出來,跟表單提交收到的東西沒兩樣),傳輸環節完全不必操心。
當你寫完客戶端的 JavaScript、讓使用者能與網頁表單互動、並把要處理的資訊收集好送出去之後,主角就換成伺服器了(如果呼叫的是非同步的伺服器端程式,這才是我們真正所謂的「Ajax 應用」)。此時你在客戶端做的選擇——例如使用 JavaScript 物件再轉成 JSON 字串——必須和伺服器端的選擇對得上,比如要用哪個 API 來解碼這份 JSON。
不論伺服器端用什麼語言,處理 JSON 基本上就兩個步驟:
找解析器或工具箱最好的起點就是 JSON 官方網站(連結請見參考資料)。在那裡你不只能了解格式本身的各種細節,還能透過連結找到橫跨 ASP、Erlang、Pike、Ruby 等語言的工具與解析器。你只要針對自己寫腳本用的語言下載對應版本即可;為了讓伺服器端程式能用上這個工具箱,視情況加以挑選、擴充或安裝就行(如果你用的是 C#、PHP 或 Lisp,發揮空間更大)。
舉例來說,用 PHP 的話,最簡單的方式是升到 PHP 5.2——這個最新版本預設就包含 JSON 擴充套件,實際上也是 PHP 環境下處理 JSON 最好的做法。若你寫的是 Java servlet,json.org 上的 org.json 套件就是明顯的選擇:從 JSON 網站下載 json.zip,把裡面的原始檔加入專案的建置目錄,編譯完成後一切就緒。其他語言也照同樣的步驟走;至於選哪個語言,取決於你對它的熟悉程度,用自己順手的就對了。
資源到手之後,剩下的就是找到該呼叫哪個方法。假設 PHP 這邊用的是 JSON-PHP:
// 以下只是較大 PHP 伺服器端腳本中的一段片段
require_once('JSON.php');
$json = new Services_JSON();
// 接收 POST 資料並解碼
$value = $json->decode($GLOBALS['HTTP_RAW_POST_DATA']);
// 接下來就能把 $value 當原生 PHP 資料來用
透過這個模板,你收到的所有資料——不論是陣列、多層結構、單值,或 JSON 資料結構中的任何東西——都會被轉成原生 PHP 格式,放進 $value 變數裡。
如果你在 servlet 中用的是 org.json 套件,程式碼會長這樣:
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
StringBuffer jb = new StringBuffer();
String line = null;
try {
BufferedReader reader = request.getReader();
while ((line = reader.readLine()) != null)
jb.append(line);
} catch (Exception e) { /* 這裡處理錯誤 */ }
try {
JSONObject jsonObject = new JSONObject(jb.toString());
} catch (ParseException e) {
throw new IOException("Error parsing JSON request string");
}
// 接著用類似下面的方法取出資料:
// int someInt = jsonObject.getInt("intParamName");
// String someString = jsonObject.getString("stringParamName");
// JSONObject nestedObj = jsonObject.getJSONObject("nestedObjName");
// JSONArray arr = jsonObject.getJSONArray("arrayParamName");
// 等等……
}
更完整的用法請參考 org.json 套件的文件(連結見參考資料)。
到這裡,你應該已經能從技術層面掌握伺服器端該怎麼處理 JSON 了。這一篇與系列第 10 篇一起,不只提供了實作上的幫助,也說明了 JSON 是一種多麼靈活而強勁的資料格式。即使你不會在每個專案裡都用它,優秀的 Ajax 與 JavaScript 開發者工具箱中,總該留一個位置給 JSON 以備不時之需。