JSON之教學筆記

就最近寫了很多Ajax的東西,接觸到Ajax的第一件事就是HttpXML.send()之後,伺服器要回傳什麼資料,一般都是responseText或responseXML,也就是說,1. 回傳純文字;2. 回傳XML,純文字難以分析處理(要跑DOM時),XML在伺服器端要花很多力氣去「組合」出XML資料,然後用戶端再寫很多Code去分析處理,這是很沒效率的。

所以就快快把JSON學一學吧!

JSON概念


進入JSON前,請先看我這篇「第二篇:簡單介紹JavaScript內建物件」Array物件第一段「Array宣告」的地方,宣告一個Javascript Array物件,基本上是兩種語法:

// 正式宣告
var team1 = new Array('Bruce', 'Sherry', 'Happy');
// 整合宣告
var team2 = ['Bruce', 'Sherry', 'Happy'];
alert(team1[0]); // Bruce
alert(team2[2]); // Happy

一個比較正式,一個是比較簡寫,通常Javascript寫久了,會採用第二種方式來宣告Array。

再來看Javascript物件的宣告,基本上也是兩種:

// 正式宣告
var Bruce = new Object();
Bruce.name = 'King Kong';
Bruce.age = 18;
Bruce.sex = 'male';
alert(Bruce.age); // 18

// 整合宣告
var Bruce = {
  'name' : 'King Kong',
  'age' : 18,
  'sex' : 'male'
}
alert(Bruce.name); // King Kong
alert(Bruce[name]); // King Kong

一樣,久了也是會選第二種來寫,再來我們看看Javascript的「Array + Object」的宣告:

// 宣告一個familys Array,裡面包含兩個Object
var familys = [
  {'name' : 'Bruce',
   'age' : 18,
   'sex' : 'male'},
  {'name' : 'Sherry',
   'age' : 16,
   'sex' : 'famale'}
];
alert(family[0].name); // Bruce
alert(family[1].sex);  // famale

到這裡你已經會了JSON的80%以上了,JSON (JavaScript Object Notation)已經說明的很清楚了,它是一個JavaScript的子集,它利用Object與Array來表示資料,讓資料很容易的可以交換使用。

JSON寫法


我們先來看完整的JSON寫法:

{
  'familys' = [
    {'name' : 'Bruce',
     'age' : 18,
     'sex' : 'male'},
    {'name' : 'Sherry',
     'age' : 16,
     'sex' : 'famale'}
  ]
}

JSON會建構出兩種結構:(1)「"名稱" : 值」的集合;(2)Array。

JSON的細節

比對上面範例,你會發現一點也不難。

JSON Object:
  1. 以"{"開始,以"}"結尾
  2. 每個名稱後跟著一個":"
  3. 每對"名稱:值"之間用","分隔

{ // 以"{"開始
  'name' : 'Bruce',  // 每個名稱後跟著一個":"
  'age' : 18,        // 每對"名稱:值"之間用","分隔
  'sex' : 'male'
} // 以"}"結尾

JSON Array:
  1. 以"["開始,以"]"結尾
  2. 值之間使用","

{
  // familys為一維陣列,陣列裡包含兩筆物件資料
  'familys' = [  // 以"["開始
    {'name' : 'Bruce',
     'age' : 18,
     'sex' : 'male'},  // 值之間使用","
    {'name' : 'Sherry',
     'age' : 16,
     'sex' : 'famale'}
  ] // 以"]"結尾
}

JSON Value:
  • 值本身可以是String、Number、true、false、null、ObjectArray

JSON String:
  • 由雙引號包圍的任意Unicode字元集合。可以使用"反斜線(\)"來轉義。

{ 
  "details" : "這是JSON的值. \n 此格式比XML合適Ajax交換資料使用."
}

JSON Number:
  • 與一般數值相同,除8 / 16進制外。

JSON的使用

那JSON要如何使用呢?

原生的JSON格式資料,目前在IE7以上及MF 3以上,已經內建解析JSON格式的能力,但在相容性及網路上的不確定性(其他瀏覽器),建議在有需要使用JSON格式的頁面引用json2.js,依官方說法,請不要在使用json.js這個版本的Script了。

我們有一JSON格式的String:

var jsonData = "{'familys'=[{'name' : 'Bruce', 'age' : 18, 'sex' : 'male'},
                            {'name' : 'Sherry','age' : 16, 'sex' : 'famale'}]}"

方法一:使用eval()
這個方法會引發安全性問題,我就不介紹了。

方法二:使用json2.js (IE7以上及MF 3以上可以不引用)

先在網頁中引用json2.js,然後使用json2所提供的parse方法:

var jsonData = "{'familys'=[{'name' : 'Bruce', 'age' : 18, 'sex' : 'male'},
                            {'name' : 'Sherry','age' : 16, 'sex' : 'famale'}]}"

var jsonObj = JSON.parse(jsonData);  // 將JSON格式資料轉為物件

alert(jsonObj.familys[0].name); // Bruce
alert(jsonObj.familys[1].age); // 16

這樣之後,我們就能在Ajax函式將伺服器傳回的JSON格式做解析:

// ...
if(xmlHttp.readyState == 4 && xmlHttp.status == 200){
  var jsonObj = JSON.parse(xmlHttp.responseText);
// ...
}

使用了JSON來交換資料後,你會發現相關Ajax的程式碼變簡單了,例如:

// 原始Ajax函數
function Do(xmlHttp) {
  if(xmlHttp.readyState == 4 && xmlHttp.status == 200){
    var familys = xmlHttp.responseXML.getElementsByTagName('familys');
    for (var i = 0; i < familys.length; i++) {
      var name = familys.getElementsByTagName('name')[0].firstChild.nodeValue;
      var age = familys.getElementsByTagName('age')[0].firstChild.nodeValue;
      var sex = familys.getElementsByTagName('sex')[0].firstChild.nodeValue;
    }
  }
}

// 使用JSON後的Ajax函數
function Do(xmlHttp) {
  if(xmlHttp.readyState == 4 && xmlHttp.status == 200){
    var jsonObj = JSON.parse(xmlHttp.responseText);
    var name = jsonObj.familys[0].name;
    var age = jsonObj.familys[0].age;
    var sex = jsonObj.familys[0].sex;
  }
}

不只有變簡單,而且程式的撰寫更直覺。另外,你也可以把Object轉為JSON:

// 宣告一個familys Array,裡面包含兩個Object
var familys = [
  {'name' : 'Bruce',
   'age' : 18,
   'sex' : 'male'},
  {'name' : 'Sherry',
   'age' : 16,
   'sex' : 'famale'}
];

var jsonData = JSON.stringify(familys);

更快速的是使用jQuery的$getJSON,但這超出了JSON的討論了。以上是接收解析JSON,那如果我要傳送JSON給伺服器呢?也簡單:

var xhr = request();  // 建立XHR物件
xhr.onreadystatechange = handler;
xhr.open('POST',URL);
xhr.setRequestHeader('Content-Type', 'application/json');  // 這裡是重點
xhr.send(json);

記得使用'application/json'來傳送即可,但一般伺服器端是看不懂JSON,不過沒關係,在JSON官網最下方或上網找一下,已經有很多高手分享出來可以在伺服器解析JSON的元件或Source Code,讓JSON資料傳送到伺服器後,依然方便好用。

使用JSONP進行跨站請求

這個主題比較生硬,如果你不會使用到跨網站請求,可以先跳過。

一般而言,在網站中是不太充許你去存取其他網站的內容,但不是百分百,例如iframe或img就是很好的例子,但其他HTML、Javascript就都不太能做這種事,例如XMLHttpRequest,這是一種保護。但現今網頁已經很少能不去存取其他網站,例如掛個「噗浪」「fb」…,但偏偏XMLHttpRequest不充許跨網站去存取。

後來有人發展出了JSONP(JSON with Padding),JSONP利用Javascript的callback機制,繞過Browser的安全限制,關鍵在動態載入<script src="...">,利用src來載入外部JSON資料或Javascript function到網頁中。

我們先來看動態建立Script

var Script = document.createElement('script');
Script.type = 'text/javascript';
Script.src = 'http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.4.4.min.js';
document.getElementByTagName('head').[0].appendChild(Script);

這相當於在head最下面新增一段script tag:

<script type="text/javascript" src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.4.4.min.js"></script>

這差不多就是JSONP的基礎了,透過動態建立script及Javascript callback,來載入跨網站JSON資料。

最後我們來看整個JSONP的運作流程示意程式碼,注意程式的流程,Step 1在Client--> Step 2在Server--> Step 3 回到Client。

Client端:*.html

// 使用jQuery

// Step 1:送出JSONP請求,
$(function(){
  $('#send').click(function(){
    // 最後必須是 &callback=funcion 或 &jsoncallback=function 結尾
    var URL = "http://abc.com/jsonp.aspx?id=1&name=Bruce&jsoncallback=dosomething";

    $.ajax({
      type : 'GET',
      dataType : 'jsonp',  // 記得是jsonp
      url : URL,
      error : function(xhr, error){ alert('Ajax request error.');}
    })
  })
});

// Step 3:收到伺服器回應後(response.write(jsonp)),執行的callback的function

function dosomething(jsonData){
  // jsonData會取得Server傳回{...json data ...}
  alert(jsonData.name);
  alert(jsonData.age);
  alert(jsonData.sex);
}

在建立非同請求時,在網址最後加上「&callback=函數名稱」或「&jsoncallback=函數名稱」,就可以取得其他網域的資料並執行後續callback的函數。

Server端 *.aspx
' Step 2:進行相關處理

'接收到的id & name處理...

' 以下是重點,組合出function及json資料,然後回傳
Dim jsonp AS String = 
' dosomething是 function name
' {...} 是json data 
jsonp = "dosomething({ _
  ' ... json data ... _
})"

Response.Write(jsonp)

Reference:

7 則留言:

  1. 不好意思,你的 var jsonData 寫錯了,應該如下:

    var jsonData = "{'familys' : [{'name' : 'Bruce', 'age' : 18, 'sex' : 'male'},
    {'name' : 'Sherry','age' : 16, 'sex' : 'famale'}]}"

    回覆刪除
  2. 剛剛寫錯了,應該這樣才能運作: 最外面是 ' 單引號,裡面的值是 雙引號, familys 要用 : 不是 = ,這樣 JSON.parse 才會過。
    var jsonData = '{"familys" : [{"name" : "Bruce", "age" : 18, "sex" : "male"}, {"name" : "Sherry","age" : 16, "sex" : "famale"}]}';

    回覆刪除
  3. 感謝。
    讀者請參考:http://blog.kkbruce.net/2012/02/javascript-jsonstring.html#.Tzn8ZbHxpZg
    原文不修正。

    回覆刪除
  4. "http://abc.com/jsonp.aspx?id=1&name=Bruce&jsoncallback=dosomething"這網址我們想要自己產生要怎麼做?

    回覆刪除
  5. 非常好的範例與解說 比起直接用json語法教學好太多

    回覆刪除
  6. 我是上面您引用中提到投影片blog「布丁布丁吃什麼?」的作者布丁,來這兒是想謝謝您的稱讚QQ
    一起努力學習JavaScript吧

    回覆刪除

感謝您的留言,如果我的文章你喜歡或對你有幫助,按個「讚」或「+1」,我會很高興的。

无觅相关文章插件,迅速提升网站流量