DIV CSS 佈局教程網

把 JSON 當參數傳:讓函式設定值不再塞滿可選參數
編輯:關於JavaScript     

為什麼要用 JSON 當參數

當一個函式有很多可選設定時,若用傳統參數列表,呼叫端會變成一長串 null 與 undefined,可讀性極差。改傳一個設定物件(JSON)就能一次帶入多個值,還能只覆寫需要變動的部分。

完整範例

function getAjaxData(urlstr, callback_func, options){
  var myurl = AJAX_HEADER + urlstr + AJAX_TAIL;
  var isAsync = true;            // 預設非同步
  var nTimeout = AJAX_TIMEOUT;   // 預設逾時
  var errorCallback = null;

  // 用 options 覆寫預設值
  if (options) {
    if (options.sync) {
      isAsync = (options.sync === true) ? false : true;
    }
    if (options.timeout) {
      nTimeout = parseInt(options.timeout);
      if (isNaN(nTimeout)) nTimeout = AJAX_TIMEOUT;
    }
    errorCallback = options.errorCB;
  }

  $.ajax({
    async: isAsync,
    type: "GET",
    timeout: nTimeout,
    url: myurl,
    error: function(XMLHttpRequest, textStatus){
      if ($.isFunction(errorCallback)) {
        errorCallback(XMLHttpRequest, textStatus);
      }
      log.error("getAjaxData(" + myurl + ") error, status = " + XMLHttpRequest.status);
    },
    success: function(data){
      var xml;
      if (typeof data == "string" || typeof data == "number") {
        if (!window.ActiveXObject) {
          xml = new DOMParser().parseFromString(data, "text/xml");
        } else {
          xml = new ActiveXObject("Microsoft.XMLDOM");
          xml.async = false;
          xml.loadXML(data);
        }
      } else {
        xml = data;
      }
      if (typeof callback_func == "function") {
        callback_func($(xml));
      }
    }
  });
}

// 呼叫時只傳需要覆寫的設定
getAjaxData("api/monitoring/status", function($xml){
  var wlan_ret = xml2object($xml);
  if (wlan_ret.type == "response") {
    monitoring_status = wlan_ret.response;
    setCurrrentUserHTML();
  }
}, { sync: true });

這個模式在 jQuery 自己的 API 中也隨處可見,例如 $.ajax({ url: ..., timeout: 3000 })——沒傳的鍵就用預設值,這正是它的方便之處。

更精簡的例子

function testJSON(JSON){
  alert(JSON.name);
  alert(JSON.age);
  alert(JSON.id);
}

testJSON({ name: "huangbiao", age: 23, id: 1 });

實作上的建議

  • 用 $.extend() 合併預設值:與其一堆 if,不如 options = $.extend({}, defaults, options);,一行搞定且不易漏。
  • 參數別命名為 JSON:會遮蔽全域的 JSON 物件,導致 JSON.parse() 無法使用。改用 settings、opts 之類的名字。
  • 同步請求不建議使用:async: false 會凍結整個 UI 直到回應返回,現代瀏覽器已明確不鼓勵,甚至會警告。若真的需要順序保證,改用 Promise / async-await 串接。
  • XML 解析可省略:如今後端多回傳 JSON,直接設 dataType: 'json' 讓 jQuery 自動解析,不必自己寫 DOMParser 分支。

順帶一提,若需要除錯時檢視或格式化 JSON,網路上有不少線上工具可用(如 JSON 格式化、XML 與 JSON 互轉等),在沒有 IDE 的環境下相當方便。

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