DIV CSS 佈局教程網

jQuery.getJSON() 用法完整解析:載入、跨域 JSONP 與參數傳遞
編輯:JQuery特效代碼     

$.getJSON() 是專門用來抓 JSON 的捷徑方法,它就是 $.ajax() 加上 dataType: "json" 的語法糖。

基本範例

從 test.js 載入 JSON 並讀出 users 陣列第 4 項的 name:

$.getJSON("test.js", function (json) {
  alert("JSON Data: " + json.users[3].name);
});

定義與語法

透過 HTTP GET 請求載入 JSON 資料。

jQuery.getJSON(url, [data], [callback])

參數:

  • url:待載入頁面的位址
  • data:要一起送出的 key/value 參數
  • callback:載入成功時執行的回呼函式

等價形式

$.ajax({
  url: url,
  data: data,
  success: callback,
  dataType: json
});

傳入的資料會被附加到 URL 後面的查詢字串。若 data 是物件,會先轉成字串並做 URL 編碼再附加。

跨網域:JSONP

從 jQuery 1.2 起,可以用 JSONP 形式的回呼載入其他網域的 JSON。做法是讓 URL 的查詢參數帶上 callback=?:

$.getJSON("https://api.flickr.com/services/feeds/photos_public.gne?tags=cat&tagmode=any&format=json&jsoncallback=?", function (data) {
  $.each(data.items, function (i, item) {
    $("<img/>").attr("src", item.media.m).appendTo("#images");
    if (i == 3) return false; // 只取前 4 張
  });
});

jQuery 會自動把 ? 替換成一個產生的函式名稱,該函式在資料回來時被執行。要注意:頁面裡寫在這個呼叫之後的程式碼會先執行,回呼是最後才被呼叫的——這是 non-blocking 的本質,也是無數非同步 bug 的源頭。

帶參數的範例

$.getJSON("test.js", { name: "John", time: "2pm" }, function (json) {
  alert("JSON Data: " + json.users[3].name);
});

幾個實務提醒

JSONP 有安全性代價。它本質上是插入一個 <script> 標籤,代表你完全信任對方不會回傳惡意程式碼。只對可信的來源使用。現在更好的選擇是 CORS——伺服器端設定 Access-Control-Allow-Origin 之後,用 fetch() 或 $.ajax() 就能安全跨網域取資料。

建議加上錯誤處理。$.getJSON() 沒有失敗回呼參數,要處理錯誤得改用完整形式:

$.ajax({
  url: "test.js",
  dataType: "json",
  success: function (data) { /* ... */ },
  error: function (xhr, status, err) { console.error(status, err); }
});

// 或用 Promise 風格
$.getJSON("test.js").done(render).fail(handleError);

回傳格式錯誤會靜默失敗。伺服器若回傳的不是合法 JSON(例如多了一個逗號、或回的是 HTML 錯誤頁),parseJSON 會拋錯並走 error 分支,畫面上什麼都不會發生。除錯時第一步永遠是打開 DevTools 看 Network 分頁裡實際回傳的內容。

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