«
JSON 入门指南

时间：2010-6-11    作者：Deri    分类： 分享 

    <p>　　<a href="http://file.ddvip.com/2008_08/1219415465_ddvip_3103.zip">本文示例源代码或素材下载</a></p>

   <p>　　尽管有许多宣传关于 XML 如何拥有跨平台，跨语言的优势，然而，除非应用于 Web Services，否则，在普通的 Web 应用中，开发者经常为 XML 的解析伤透了脑筋，无论是服务器端生成或处理 XML，还是客户端用 JavaScript 解析 XML，都常常导致复杂的代码，极低的开发效率。实际上，对于大多数 Web 应用来说，他们根本不需要复杂的 XML 来传输数据，XML 的扩展性很少具有优势，许多 AJAX 应用甚至直接返回 HTML 片段来构建动态 Web 页面。和返回 XML 并解析它相比，返回 HTML 片段大大降低了系统的复杂性，但同时缺少了一定的灵活性。 </p><p>　　现在， JSON 为 Web 应用开发者提供了另一种数据交换格式。让我们来看看 JSON 到底是什么，同 XML 或 HTML 片段相比，JSON 提供了更好的简单性和灵活性。</p><p>　　JSON 数据格式解析 </p><p>　　和 XML 一样，JSON 也是基于纯文本的数据格式。由于 JSON 天生是为 JavaScript 准备的，因此，JSON 的数据格式非常简单，您可以用 JSON 传输一个简单的 String，Number，Boolean，也可以传输一个数组，或者一个复杂的 Object 对象。 </p><p>　　String，Number 和 Boolean 用 JSON 表示非常简单。例如，用 JSON 表示一个简单的 String “ abc ”，其格式为：</p><p><code>"abc"</code></p><p>　　除了字符 "，，/ 和一些控制符（b，f，n，r，t）需要编码外，其他 Unicode 字符可以直接输出。下图是一个 String 的完整表示结构：</p><p>　　图 1. String 的完整表示结构</p><p><img src="/content/uploadfile/201006/2010061116161821.jpg" onclick="get_larger(this)" alt="JSON 入门指南" /></p><p>　　一个 Number 可以根据整型或浮点数表示如下：</p><p>　　图 2. Number 的表示结构</p>

<p> </p>

   <p><img src="/content/uploadfile/201006/2010061116161893.jpg" onclick="get_larger(this)" alt="JSON 入门指南" /></p><p>　　这与绝大多数编程语言的表示方法一致，例如：</p><p><code>12345（整数）<br />-3.9e10（浮点数）</code></p><p>　　Boolean 类型表示为 true 或 false 。此外，JavaScript 中的 null 被表示为 null，注意，true、false 和 null 都没有双引号，否则将被视为一个 String 。 </p><p>　　JSON 还可以表示一个数组对象，使用 [] 包含所有元素，每个元素用逗号分隔，元素可以是任意的 Value，例如，以下数组包含了一个 String，Number，Boolean 和一个 null：</p><p><code>["abc",12345,false,null]</code></p><p>　　Object 对象在 JSON 中是用 {} 包含一系列无序的 Key-Value 键值对表示的，实际上此处的 Object 相当于 Java 中的 Map<String, Object>，而不是 Java 的 Class 。注意 Key 只能用 String 表示。 </p><p>　　例如，一个 Address 对象包含如下 Key-Value：</p><p><code>city:Beijing<br />street:Chaoyang Road<br />postcode:100025（整数）</code></p><p>　　用 JSON 表示如下：</p><p><code>{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}</code></p><p>　　其中 Value 也可以是另一个 Object 或者数组，因此，复杂的 Object 可以嵌套表示，例如，一个 Person 对象包含 name 和 address 对象，可以表示如下：</p><p><code>{"name":"Michael","address":<br />　　{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}<br />}</code></p>

 <p> </p>

   <p>　　JavaScript 处理 JSON 数据 </p><p>　　上面介绍了如何用 JSON 表示数据，接下来，我们还要解决如何在服务器端生成 JSON 格式的数据以便发送到客户端，以及客户端如何使用 JavaScript 处理 JSON 格式的数据。 </p><p>　　我们先讨论如何在 Web 页面中用 JavaScript 处理 JSON 数据。我们通过一个简单的 JavaScript 方法就能看到客户端如何将 JSON 数据表示给用户：</p><p><code>function handleJson() {<br />　var j={"name":"Michael","address":<br />　　　{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}<br />　};<br />　document.write(j.name);<br />　document.write(j.address.city);<br />}</code></p><p>　　假定服务器返回的 JSON 数据是上文的：</p><p><code>{"name":"Michael","address":<br />　　{"city":"Beijing","street":" Chaoyang Road ","postcode":100025}<br />}</code></p><p>　　只需将其赋值给一个 JavaScript 变量，就可以立刻使用该变量并更新页面中的信息了，相比 XML 需要从 DOM 中读取各种节点而言，JSON 的使用非常容易。我们需要做的仅仅是发送一个 Ajax 请求，然后将服务器返回的 JSON 数据赋值给一个变量即可。有许多 Ajax 框架早已包含了处理 JSON 数据的能力，例如 Prototype（一个流行的 JavaScript 库：http://prototypejs.org）提供了 evalJSON() 方法，能直接将服务器返回的 JSON 文本变成一个 JavaScript 变量：</p><p><code>new Ajax.Request("http://url", {<br />　method: "get",<br />　onSuccess: function(transport) {<br />　　var json = transport.responseText.evalJSON();<br />　　// TODO: document.write(json.xxx);<br />　}<br />});</code></p>

 <p> </p>

   <p>　　服务器端输出 JSON 格式数据 </p><p>　　下面我们讨论如何在服务器端输出 JSON 格式的数据。以 Java 为例，我们将演示将一个 Java 对象编码为 JSON 格式的文本。 </p><p>　　将 String 对象编码为 JSON 格式时，只需处理好特殊字符即可。另外，必须用 (") 而非 (') 表示字符串：</p><p><code>static String string2Json(String s) {<br />　　StringBuilder sb = new StringBuilder(s.length()+20);<br />　　sb.append('"');<br />　　for (int i=0; i<s.length(); i++) {<br />　　　　char c = s.charAt(i);<br />　　　　switch (c) {<br />　　　　case '"':<br />　　　　　　sb.append(""");<br />　　　　　　break;<br />　　　　case '':<br />　　　　　　sb.append("");<br />　　　　　　break;<br />　　　　case '/':<br />　　　　　　sb.append("/");<br />　　　　　　break;<br />　　　　case 'b':<br />　　　　　　sb.append("");<br />　　　　　　break;<br />　　　　case 'f':<br />　　　　　　sb.append("f");<br />　　　　　　break;<br />　　　　case 'n':<br />　　　　　　sb.append("<br />");<br />　　　　　　break;<br />　　　　case 'r':<br />　　　　　　sb.append("<br />");<br />　　　　　　break;<br />　　　　case 't':<br />　　　　　　sb.append("　　");<br />　　　　　　break;<br />　　　　default:<br />　　　　　　sb.append(c);<br />　　　　}<br />　　}<br />　　sb.append('"');<br />　　return sb.toString();<br />}</code></p>

 <p> </p>

   <p>　　将 Number 表示为 JSON 就容易得多，利用 Java 的多态，我们可以处理 Integer，Long，Float 等多种 Number 格式：</p><p><code>static String number2Json(Number number) {<br />　　return number.toString();<br />}</code></p><p>　　Boolean 类型也可以直接通过 toString() 方法得到 JSON 的表示：</p><p><code>static String boolean2Json(Boolean bool) {<br />　　return bool.toString();<br />}</code></p><p>　　要将数组编码为 JSON 格式，可以通过循环将每一个元素编码出来：</p><p><code>static String array2Json(Object[] array) {<br />　　if (array.length==0)<br />　　　　return "[]";<br />　　StringBuilder sb = new StringBuilder(array.length << 4);<br />　　sb.append('[');<br />　　for (Object o : array) {<br />　　　　sb.append(toJson(o));<br />　　　　sb.append(',');<br />　　}<br />　　// 将最后添加的 ',' 变为 ']':<br />　　sb.setCharAt(sb.length()-1, ']');<br />　　return sb.toString();<br />}</code></p><p>　　最后，我们需要将 Map<String, Object> 编码为 JSON 格式，因为 JavaScript 的 Object 实际上对应的是 Java 的 Map<String, Object> 。该方法如下：</p><p><code>static String map2Json(Map<String, Object> map) {<br />　　if (map.isEmpty())<br />　　　　return "{}";<br />　　StringBuilder sb = new StringBuilder(map.size() << 4);<br />　　sb.append('{');<br />　　Set<String> keys = map.keySet();<br />　　for (String key : keys) {<br />　　　　Object value = map.get(key);<br />　　　　sb.append('"');<br />　　　　sb.append(key);<br />　　　　sb.append('"');<br />　　　　sb.append(':');<br />　　　　sb.append(toJson(value));<br />　　　　sb.append(',');<br />　　}<br />　　// 将最后的 ',' 变为 '}':<br />　　sb.setCharAt(sb.length()-1, '}');<br />　　return sb.toString();<br />}</code></p>

 <p> </p>

   <p>　　为了统一处理任意的 Java 对象，我们编写一个入口方法 toJson(Object)，能够将任意的 Java 对象编码为 JSON 格式：</p><p><code>public static String toJson(Object o) {<br />　　if (o==null)<br />　　　　return "null";<br />　　if (o instanceof String)<br />　　　　return string2Json((String)o);<br />　　if (o instanceof Boolean)<br />　　　　return boolean2Json((Boolean)o);<br />　　if (o instanceof Number)<br />　　　　return number2Json((Number)o);<br />　　if (o instanceof Map)<br />　　　　return map2Json((Map<String, Object>)o);<br />　　if (o instanceof Object[])<br />　　　　return array2Json((Object[])o);<br />　　throw new RuntimeException("Unsupported type: " + o.getClass().getName());<br />}</code></p><p>　　我们并未对 Java 对象作严格的检查。不被支持的对象（例如 List）将直接抛出 RuntimeException 。此外，为了保证输出的 JSON 是有效的，Map<String, Object> 对象的 Key 也不能包含特殊字符。细心的读者可能还会发现循环引用的对象会引发无限递归，例如，精心构造一个循环引用的 Map，就可以检测到 StackOverflowException：</p><p><code>@Test(expected=StackOverflowError.class)<br />public void testRecurrsiveMap2Json() {<br />　　Map<String, Object> map = new HashMap<String, Object>();<br />　　map.put("key", map);<br />　　JsonUtil.map2Json(map);<br />}</code></p><p>　　好在服务器处理的 JSON 数据最终都应该转化为简单的 JavaScript 对象，因此，递归引用的可能性很小。 </p></p><p>　　最后，通过 Servlet 或 MVC 框架输出 JSON 时，需要设置正确的 MIME 类型（application/json）和字符编码。假定服务器使用 UTF-8 编码，则可以使用以下代码输出编码后的 JSON 文本：</p><p><code>response.setContentType("application/json;charset=UTF-8");<br />response.setCharacterEncoding("UTF-8");<br />PrintWriter pw = response.getWriter();<br />pw.write(JsonUtil.toJson(obj));<br />pw.flush();</code></p><p>　　小结 </p><p>　　JSON 已经是 JavaScript 标准的一部分。目前，主流的浏览器对 JSON 支持都非常完善。应用 JSON，我们可以从 XML 的解析中摆脱出来，对那些应用 Ajax 的 Web 2.0 网站来说，JSON 确实是目前最灵活的轻量级方案。</p></p>