級(jí)別： 初級(jí)
廖 雪峰, 撰稿人
2008 年 8 月 22 日
JSON 即 JavaScript Object Natation，它是一種輕量級(jí)的數(shù)據(jù)交換格式，非常適合于服務(wù)器與 JavaScript 的交互。本文將快速講解 JSON 格式，并通過(guò)代碼示例演示如何分別在客戶端和服務(wù)器端進(jìn)行 JSON 格式數(shù)據(jù)的處理。
盡管有許多宣傳關(guān)于 XML 如何擁有跨平臺(tái)，跨語(yǔ)言的優(yōu)勢(shì)，然而，除非應(yīng)用于 Web Services，否則，在普通的 Web 應(yīng)用中，開(kāi)發(fā)者經(jīng)常為 XML 的解析傷透了腦筋，無(wú)論是服務(wù)器端生成或處理 XML，還是客戶端用 JavaScript 解析 XML，都常常導(dǎo)致復(fù)雜的代碼，極低的開(kāi)發(fā)效率。實(shí)際上，對(duì)于大多數(shù) Web 應(yīng)用來(lái)說(shuō)，他們根本不需要復(fù)雜的 XML 來(lái)傳輸數(shù)據(jù)，XML 的擴(kuò)展性很少具有優(yōu)勢(shì)，許多 AJAX 應(yīng)用甚至直接返回 HTML 片段來(lái)構(gòu)建動(dòng)態(tài) Web 頁(yè)面。和返回 XML 并解析它相比，返回 HTML 片段大大降低了系統(tǒng)的復(fù)雜性，但同時(shí)缺少了一定的靈活性。
現(xiàn)在， JSON 為 Web 應(yīng)用開(kāi)發(fā)者提供了另一種數(shù)據(jù)交換格式。讓我們來(lái)看看 JSON 到底是什么，同 XML 或 HTML 片段相比，JSON 提供了更好的簡(jiǎn)單性和靈活性。
|
|
|
Ajax 資源中心
請(qǐng)?jiān)L問(wèn) Ajax 資源中心，這是有關(guān) Ajax 編程模型信息的一站式中心，包括很多文檔、教程、論壇、blog、wiki 和新聞。任何 Ajax 的新信息都能在這里找到。
|
|
JSON 數(shù)據(jù)格式解析
和 XML 一樣，JSON 也是基于純文本的數(shù)據(jù)格式。由于 JSON 天生是為 JavaScript 準(zhǔn)備的，因此，JSON 的數(shù)據(jù)格式非常簡(jiǎn)單，您可以用 JSON 傳輸一個(gè)簡(jiǎn)單的 String，Number，Boolean，也可以傳輸一個(gè)數(shù)組，或者一個(gè)復(fù)雜的 Object 對(duì)象。
String，Number 和 Boolean 用 JSON 表示非常簡(jiǎn)單。例如，用 JSON 表示一個(gè)簡(jiǎn)單的 String “ abc ”，其格式為：
除了字符 "，\，/ 和一些控制符（\b，\f，\n，\r，\t）需要編碼外，其他 Unicode 字符可以直接輸出。下圖是一個(gè) String 的完整表示結(jié)構(gòu)：
圖 1. String 的完整表示結(jié)構(gòu)
一個(gè) Number 可以根據(jù)整型或浮點(diǎn)數(shù)表示如下：
圖 2. Number 的表示結(jié)構(gòu)
這與絕大多數(shù)編程語(yǔ)言的表示方法一致，例如：
|
12345（整數(shù)）
-3.9e10（浮點(diǎn)數(shù)）
|
Boolean 類(lèi)型表示為 true 或 false 。此外，JavaScript 中的 null 被表示為 null，注意，true、false 和 null 都沒(méi)有雙引號(hào)，否則將被視為一個(gè) String 。
JSON 還可以表示一個(gè)數(shù)組對(duì)象，使用 [] 包含所有元素，每個(gè)元素用逗號(hào)分隔，元素可以是任意的 Value，例如，以下數(shù)組包含了一個(gè) String，Number，Boolean 和一個(gè) null：
Object 對(duì)象在 JSON 中是用 {} 包含一系列無(wú)序的 Key-Value 鍵值對(duì)表示的，實(shí)際上此處的 Object 相當(dāng)于 Java 中的 Map<String, Object>，而不是 Java 的 Class 。注意 Key 只能用 String 表示。
例如，一個(gè) Address 對(duì)象包含如下 Key-Value：
|
city:Beijing
street:Chaoyang Road
postcode:100025（整數(shù)）
|
用 JSON 表示如下：
|
{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}
|
其中 Value 也可以是另一個(gè) Object 或者數(shù)組，因此，復(fù)雜的 Object 可以嵌套表示，例如，一個(gè) Person 對(duì)象包含 name 和 address 對(duì)象，可以表示如下：
|
{"name":"Michael","address":
{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}
}
|
JavaScript 處理 JSON 數(shù)據(jù)
上面介紹了如何用 JSON 表示數(shù)據(jù)，接下來(lái)，我們還要解決如何在服務(wù)器端生成 JSON 格式的數(shù)據(jù)以便發(fā)送到客戶端，以及客戶端如何使用 JavaScript 處理 JSON 格式的數(shù)據(jù)。
我們先討論如何在 Web 頁(yè)面中用 JavaScript 處理 JSON 數(shù)據(jù)。我們通過(guò)一個(gè)簡(jiǎn)單的 JavaScript 方法就能看到客戶端如何將 JSON 數(shù)據(jù)表示給用戶：
|
function handleJson() {
var j={"name":"Michael","address":
{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}
};
document.write(j.name);
document.write(j.address.city);
}
|
假定服務(wù)器返回的 JSON 數(shù)據(jù)是上文的：
|
{"name":"Michael","address":
{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}
}
|
只需將其賦值給一個(gè) JavaScript 變量，就可以立刻使用該變量并更新頁(yè)面中的信息了，相比 XML 需要從 DOM 中讀取各種節(jié)點(diǎn)而言，JSON 的使用非常容易。我們需要做的僅僅是發(fā)送一個(gè) Ajax 請(qǐng)求，然后將服務(wù)器返回的 JSON 數(shù)據(jù)賦值給一個(gè)變量即可。有許多 Ajax 框架早已包含了處理 JSON 數(shù)據(jù)的能力，例如 Prototype（一個(gè)流行的 JavaScript 庫(kù)：http://prototypejs.org）提供了 evalJSON() 方法，能直接將服務(wù)器返回的 JSON 文本變成一個(gè) JavaScript 變量：
|
new Ajax.Request("http://url", {
method: "get",
onSuccess: function(transport) {
var json = transport.responseText.evalJSON();
// TODO: document.write(json.xxx);
}
});
|
服務(wù)器端輸出 JSON 格式數(shù)據(jù)
下面我們討論如何在服務(wù)器端輸出 JSON 格式的數(shù)據(jù)。以 Java 為例，我們將演示將一個(gè) Java 對(duì)象編碼為 JSON 格式的文本。
將 String 對(duì)象編碼為 JSON 格式時(shí)，只需處理好特殊字符即可。另外，必須用 (") 而非 (') 表示字符串：
|
static String string2Json(String s) {
StringBuilder sb = new StringBuilder(s.length()+20);
sb.append('\"');
for (int i=0; i<s.length(); i++) {
char c = s.charAt(i);
switch (c) {
case '\"':
sb.append("\\\"");
break;
case '\\':
sb.append("\\\\");
break;
case '/':
sb.append("\\/");
break;
case '\b':
sb.append("\\b");
break;
case '\f':
sb.append("\\f");
break;
case '\n':
sb.append("\\n");
break;
case '\r':
sb.append("\\r");
break;
case '\t':
sb.append("\\t");
break;
default:
sb.append(c);
}
}
sb.append('\"');
return sb.toString();
}
|
將 Number 表示為 JSON 就容易得多，利用 Java 的多態(tài)，我們可以處理 Integer，Long，Float 等多種 Number 格式：
|
static String number2Json(Number number) { //---- 繼承關(guān)系
return number.toString();
}
|
Boolean 類(lèi)型也可以直接通過(guò) toString() 方法得到 JSON 的表示：
|
static String boolean2Json(Boolean bool) {
return bool.toString();
}
|
要將數(shù)組編碼為 JSON 格式，可以通過(guò)循環(huán)將每一個(gè)元素編碼出來(lái)：
|
static String array2Json(Object[] array) {
if (array.length==0)
return "[]";
StringBuilder sb = new StringBuilder(array.length << 4);
sb.append('[');
for (Object o : array) {
sb.append(toJson(o));
sb.append(',');
}
// 將最后添加的 ',' 變?yōu)?span lang=EN-US> ']':
sb.setCharAt(sb.length()-1, ']');
return sb.toString();
}
|
最后，我們需要將 Map<String, Object> 編碼為 JSON 格式，因?yàn)?span lang=EN-US> JavaScript 的 Object 實(shí)際上對(duì)應(yīng)的是 Java 的 Map<String, Object> 。該方法如下：
|
static String map2Json(Map<String, Object> map) {
if (map.isEmpty())
return "{}";
StringBuilder sb = new StringBuilder(map.size() << 4);
sb.append('{');
Set<String> keys = map.keySet();
for (String key : keys) {
Object value = map.get(key);
sb.append('\"');
sb.append(key);
sb.append('\"');
sb.append(':');
sb.append(toJson(value));
sb.append(',');
}
// 將最后的 ',' 變?yōu)?span lang=EN-US> '}':
sb.setCharAt(sb.length()-1, '}');
return sb.toString();
}
|
為了統(tǒng)一處理任意的 Java 對(duì)象，我們編寫(xiě)一個(gè)入口方法 toJson(Object)，能夠?qū)⑷我獾?span lang=EN-US> Java 對(duì)象編碼為 JSON 格式：
|
public static String toJson(Object o) {
if (o==null)
return "null";
if (o instanceof String)
return string2Json((String)o);
if (o instanceof Boolean)
return boolean2Json((Boolean)o);
if (o instanceof Number)
return number2Json((Number)o);
if (o instanceof Map)
return map2Json((Map<String, Object>)o);
if (o instanceof Object[])
return array2Json((Object[])o);
throw new RuntimeException("Unsupported type: " + o.getClass().getName());
}
|
我們并未對(duì) Java 對(duì)象作嚴(yán)格的檢查。不被支持的對(duì)象（例如 List）將直接拋出 RuntimeException 。此外，為了保證輸出的 JSON 是有效的，Map<String, Object> 對(duì)象的 Key 也不能包含特殊字符。細(xì)心的讀者可能還會(huì)發(fā)現(xiàn)循環(huán)引用的對(duì)象會(huì)引發(fā)無(wú)限遞歸，例如，精心構(gòu)造一個(gè)循環(huán)引用的 Map，就可以檢測(cè)到 StackOverflowException：
|
@Test(expected=StackOverflowError.class)
public void testRecurrsiveMap2Json() {
Map<String, Object> map = new HashMap<String, Object>();
map.put("key", map);
JsonUtil.map2Json(map);
}
|
好在服務(wù)器處理的 JSON 數(shù)據(jù)最終都應(yīng)該轉(zhuǎn)化為簡(jiǎn)單的 JavaScript 對(duì)象，因此，遞歸引用的可能性很小。
最后，通過(guò) Servlet 或 MVC 框架輸出 JSON 時(shí)，需要設(shè)置正確的 MIME 類(lèi)型（application/json）和字符編碼。假定服務(wù)器使用 UTF-8 編碼，則可以使用以下代碼輸出編碼后的 JSON 文本：
|
response.setContentType("application/json;charset=UTF-8");
response.setCharacterEncoding("UTF-8");
PrintWriter pw = response.getWriter();
pw.write(JsonUtil.toJson(obj));
pw.flush();
|
小結(jié)
JSON 已經(jīng)是 JavaScript 標(biāo)準(zhǔn)的一部分。目前，主流的瀏覽器對(duì) JSON 支持都非常完善。應(yīng)用 JSON，我們可以從 XML 的解析中擺脫出來(lái)，對(duì)那些應(yīng)用 Ajax 的 Web 2.0 網(wǎng)站來(lái)說(shuō)，JSON 確實(shí)是目前最靈活的輕量級(jí)方案。
下載
|
描述
|
名字
|
大小
|
下載方法
|
|
本文完整的源代碼
|
jeedev-util.zip
|
90 KB
|
HTTP
|