DIV CSS 佈局教程網

如何正確取得 jQuery AJAX 回傳的 JSON 資料
編輯:JavaScript基礎知識     

寫了一個查詢用的方法,除錯時確認後端有回傳資料,但外層變數拿到的卻是 undefined。這是 AJAX 初學階段最常撞到的牆,原因跟 AJAX 的非同步本質有關。

有問題的寫法

function getChildNodeArrayByParentID(categoryCode) {
  $.ajax({
    type: "get",
    url: "DynamicMenuItemsHandler.ashx",
    data: { MenuItemCode: categoryCode },
    async: false,
    success: function (data) {
      return data;   // 這裡的 return 是回給回呼函式,不是回給外層
    }
  });
}

var jsonArray = getChildNodeArrayByParentID(01); // undefined

問題的核心是:success 裡的 return 是把值交回給「呼叫這個回呼函式的地方」,也就是 jQuery 內部,而不是交回給你定義的 getChildNodeArrayByParentID。而外層函式本身沒有任何 return 陳述式,所以自然回傳 undefined。

解法一:用區域變數承接(需搭配同步)

function getChildNodeArrayByParentID(categoryCode) {
  var result;
  $.ajax({
    type: "get",
    url: "DynamicMenuItemsHandler.ashx",
    data: { MenuItemCode: categoryCode },
    async: false,
    success: function (data) {
      result = data;
    }
  });
  return result;
}

var jsonArray = getChildNodeArrayByParentID(01);

關鍵有兩點:宣告一個函式層級的區域變數 result,在回呼中對它赋值而非 return;同時把 async 設為 false,讓請求變成同步,函式才會等到資料回來後才走到 return。

但必須強調:async: false 是不推薦的做法。它會凍結整個瀏覽器 UI 直到回應抵達,網路稍慢畫面就像當機;jQuery 也已將此選項標記為不宜使用。這個寫法只适合理解原理,不該用在正式環境。

解法二:傳入回呼函式(推薦)

把「取得資料」與「使用資料」分開,讓呼叫端提供一個回呼:

function getChildNodeArrayByParentID(categoryCode, callback) {
  $.ajax({
    type: "get",
    url: "DynamicMenuItemsHandler.ashx",
    data: { MenuItemCode: categoryCode },
    dataType: "json",
    success: function (data) {
      callback(data);
    }
  });
}

getChildNodeArrayByParentID('01', function (jsonArray) {
  // 在這裡使用資料
  console.log(jsonArray);
});

或者更乾脆,直接把 $.ajax 回傳的 Deferred 物件交給呼叫端:

function getChildNodeArrayByParentID(categoryCode) {
  return $.ajax({
    type: "get",
    url: "DynamicMenuItemsHandler.ashx",
    data: { MenuItemCode: categoryCode },
    dataType: "json"
  });
}

getChildNodeArrayByParentID('01').done(function (data) {
  console.log(data);
}).fail(function () {
  console.error('查詢失敗');
});

這個版本最簡潔:函式回傳的就是 Promise-like 物件,呼叫端用 done/fail 串接即可,也能用 then 做多段串接。

一個完整的分頁查詢實作

以下示範如何在回呼中把 JSON 資料綁定到表格,這是實務上最常見的用法:

function searchStu(page) {
  var xm = $("#xm").val();
  var xy = $("#xy").val();
  $.ajax({
    type: "post",
    url: "AccountList.action",
    dataType: "json",
    data: { "cus.xm": xm, "cus.xs": xy, page: page },
    success: callbackFun
  });
}

function callbackFun(msg) {
  $("#totalCount").html(msg.totalCount);
  $("#page").html(msg.page);
  $("#totalPage").html(msg.totalPage);

  var data = msg.list;
  var container = document.getElementById("datas");
  container.innerHTML = ''; // 清空舊資料
  var xy = $("#xy").find("option:selected").text();

  $.each(data, function (i, n) {
    var row = $('<tr align="center">'
      + '<td class="xmtd"></td>'
      + '<td class="xstd"></td>'
      + '<td class="dhtd"></td>'
      + '<td class="actd"></td>'
      + '<td class="mmtd"></td>'
      + '<td class="lxtd"></td>'
      + '<td class="bjtd"></td>'
      + '<td class="sctd"></td>'
      + '<td class="operator"></td></tr>');

    row.find(".xmtd").text(n.xm);
    row.find(".xstd").text(xy);
    row.find(".dhtd").text(n.dh);
    row.find(".actd").text(n.ac);
    row.find(".mmtd").text(n.mm);
    row.find(".lxtd").text(n.lx);
    row.find(".bjtd").text("編輯");
    row.find(".sctd").html("<a href='../../DelAccount.action?id=" + n.id + "'>刪除</a>");
    row.find(".operator").html("<input type='checkbox' value='" + n.xh + "'/>");
    row.appendTo("#datas");
  });
}

這裡有幾處比原始寫法更值得注意:用 class 而非 id 來定位每個儲存格,因為迴圈中產生的多列若共用同一個 id 會造成 HTML 無效且 row.find('#xmtd') 只會命中第一個;用 .text() 而非 .html() 填入後端資料,可避免資料含 HTML 時的 XSS 風險;data 改用物件而非手動拼接字串,讓 jQuery 自動處理編碼。

現代寫法

若專案已能用 async/await,語意會更貼近同步程式碼的寫法:

async function getChildNodes(categoryCode) {
  var res = await fetch('DynamicMenuItemsHandler.ashx?MenuItemCode='
                        + encodeURIComponent(categoryCode));
  if (!res.ok) { throw new Error('請求失敗'); }
  return res.json();
}

getChildNodes('01').then(function (list) {
  console.log(list);
});

重點觀念只有一句:非同步函式的結果無法用 return 直接取出,必須透過回呼、Promise 或 await 承接。理解這點,AJAX 相關的困惑大半都能化解。

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