DIV CSS 佈局教程網

JSON 與 JSONP 的差別,以及 jQuery 中 ajax jsonp 的用法
編輯:JQuery特效代碼     

JSON 和 JSONP 不是同一件事

JSON(JavaScript Object Notation)是一種輕量級的資料交換格式,用於在瀏覽器與伺服器之間傳遞資訊。

JSONP(JSON With Padding)則是把 JSON 打包進函式呼叫中的形式,也就是「被包裹過的 JSON」。

一句話總結:JSON 是資料格式,JSONP 是資料呼叫方式。

// JSON
{ "name": "sb" }

// JSONP
callback({ "name": "sb" })

基於安全考量,瀏覽器的腳本(Ajax)不能存取非本域的內容。但靜態資源不受同源政策限制——任何網域的腳本、樣式、圖片都能載入。JSONP 正是利用這一點來實現跨域取資料。

例一:把靜態 JSON 當參數呼叫函式

// 定義 showPrice 函式
function showPrice(data) {
  alert("Symbol: " + data.symbol + ", Price: " + data.price);
}
// 在網頁中包含 showPrice 函式與參數
<script type="text/javascript">
function showPrice(data) {
  alert("Symbol: " + data.symbol + ", Price: " + data.price);
}
</script>
<script type="text/javascript">showPrice({symbol: 'IBM', price: 91.42});</script>

例二:動態插入 script 標籤

把函式呼叫寫在一個放在伺服器上的 js 檔裡,用 script 標籤載入,而且這個標籤可以動態建立:

<script type="text/javascript">
// 要與 JSON 資料一起被呼叫的函式
function showPrice(data) {
  alert("Symbol: " + data.symbol + ", Price: " + data.price);
}

var url = "remote.js";    // 外部腳本的 URL
var script = document.createElement('script');   // 動態插入腳本
script.setAttribute('src', url);
document.getElementsByTagName('head')[0].appendChild(script);   // 載入 script
</script>

remote.js 的內容與直接寫在標籤裡的一樣:

showPrice({symbol: 'IBM', price: 91.42});

例三:加上 callback 參數

問題來了:難道每次取到資料都要呼叫 showPrice 嗎?這就需要前後端做好約定,而對於開放給大眾開發的介面來說,這種硬性約定有諸多不便。JSONP 的解法是:由前端傳一個 callback 函式名稱參數,後端接收後產生對該函式的呼叫、把 JSON 當參數帶入,回傳到客戶端插入頁面執行。

<script type="text/javascript">
function showPrice(data) {
  alert("Symbol: " + data.symbol + ", Price: " + data.price);
}
var url = "remote.js?callback=showPrice";   // 外部腳本的 URL
var script = document.createElement('script');
script.setAttribute('src', url);
document.getElementsByTagName('head')[0].appendChild(script);
</script>

後端以 PHP 實作的 JSONP 服務片段:

$jsonData = getDataAsJson($_GET['symbol']);
echo $_GET['callback'] . '(' . $jsonData . ');';
// 輸出:showPrice({"symbol" : "IBM", "price" : "91.42"});

這正好完美呼應了 JSONP 的定義——打包在函式呼叫中的 JSON 資料。順帶一提,正式環境中務必對 callback 參數做白名單驗證,否則會留下 XSS 風險。

在 jQuery 中使用 JSONP

Ajax 與 JSONP 在 jQuery 裡的呼叫方式看起來極為相似,但本質完全不同:Ajax 是透過 XMLHttpRequest 取得非頁面內容,JSONP 則是動態添加 script 標籤來呼叫伺服器腳本。雖然 jQuery 把 JSONP 當作 Ajax 的一種形式封裝,但 JSONP 並不是 Ajax 的一種特例。

$.ajax({
  url: "https://query.yahooapis.com/v1/public/yql",
  jsonpCallback: "showPrice",
  jsonp: "callback",
  dataType: "jsonp",          // 告訴 jQuery 我們期待 JSONP
  data: {
    q: "select title,abstract,url from search.news where query=\"cat\"",
    format: "json"
  },
  success: function( data ) {
    console.log( data );      // 伺服器回應
  }
});

參數說明

dataType(String):預期伺服器回傳的資料型別。若不指定,jQuery 會依 HTTP 回應的 MIME 型別自行判斷。可用值:

  • "xml":回傳 XML 文件,可用 jQuery 處理。
  • "html":回傳純文字 HTML;其中包含的 script 標籤會在插入 DOM 時執行。
  • "script":回傳純文字 JavaScript 程式碼,不會自動快取結果(除非設定 cache 參數)。注意:遠端請求(非同一網域)時,所有 POST 都會轉為 GET,因為實際是使用 DOM 的 script 標籤載入。
  • "json":回傳 JSON 資料。
  • "jsonp":JSONP 格式。使用時如 "myurl?callback=?",jQuery 會自動把 ? 替換成正確的函式名稱以執行回呼。
  • "text":回傳純文字字串。

jsonp:覆寫 JSONP 請求出現回呼函式名稱的參數名。例如設定 {jsonp:'onJsonPLoad'},就會以 onJsonPLoad 取代 URL 中「callback=?」的 callback 部分。

jsonpCallback:為 JSONP 指定一個回呼函式名稱,用來取代 jQuery 自動產生的隨機函式名。這麼做的好處是便於管理請求、方便提供回呼與錯誤處理,也能讓瀏覽器快取 GET 請求。不過實務上通常不必手動指定——jQuery 處理 JSONP 時會自動產生回呼函式並把資料交給 success 處理,類似這樣:

function success_jsonpCallback(data) { success(data); }

以上就是 JSONP 的完整脈絡:格式是 JSON,手段是 script 標籤,關鍵在 callback 參數的約定。理解這三點,跨域取資料就不再神祕。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved