DIV CSS 佈局教程網

解決 tipswindown 與 hintbox 插件衝突:追到 jQuery.ajaxSettings 這個共用物件
編輯:JQuery特效代碼     

兩個各自運作良好的 jQuery 插件放在一起卻出問題,這類 bug 特別難查,因為問題不在任何一個插件的邏輯裡,而在它們共用的某個全域狀態上。

故障場景

頁面 a.aspx 上點按鈕彈出一個模擬層,這個層裡有一個「監督人」輸入框,需要 hintbox 提供即時查詢功能。

直接呼叫的結果卻是這樣:

可以明顯看到,打開 tipswindown 建立的彈窗時,裡面卻出現了 hintbox 的 loading 動畫圖示——兩個插件的狀態互相污染了。

第一次嘗試:改 ajaxStart 的寫法

翻開 jquery.hintbox-1.3.js,找到這一段:

$("#windown-content").ajaxStart(function(){
    $(this).html("<img src='"+templateSrc+"/images/loading.gif' class='loading' />");
});

直覺的反應是把它改成直接設定內容:

$("#windown-content").html("<img src='"+templateSrc+"/images/loading.gif' class='loading' />");

這個改動能讓症狀消失,但沒有解決真正的問題——它只是把「何時寫入 loading」從事件驅動改成直接執行,兩者的污染路徑依然存在。要找根因,得往更底層看。

真正的根因:ajaxStart 是全域事件

關鍵在於 jQuery 的 ajax 事件是全域的,且會沿 DOM 樹向上冒泡。原始碼裡的 ajaxSetup 與 ajaxSettings 正是這套機制的基礎:

ajaxSetup: function( settings ) {
    jQuery.extend( jQuery.ajaxSettings, settings );
},

ajaxSettings: {
    url: location.href,
    global: true,          // ★ 就是這個:預設所有請求都觸發全域事件
    type: "GET",
    contentType: "application/x-www-form-urlencoded",
    processData: true,
    async: true,
    xhr: function(){
        return window.ActiveXObject
            ? new ActiveXObject("Microsoft.XMLHTTP")
            : new XMLHttpRequest();
    },
    accepts: {
        xml: "application/xml, text/xml",
        html: "text/html",
        script: "text/javascript, application/javascript",
        json: "application/json, text/javascript",
        text: "text/plain",
        _default: "*/*"
    }
}

global: true 是預設值,代表每一個 ajax 請求都會廣播全域事件。於是流程變成:

  1. 使用者操作觸發 hintbox 的某個 ajax 請求。
  2. 該請求因為 global: true 而廣播 ajaxStart。
  3. tipswindown 先前綁在 #windown-content 上的 ajaxStart 監聽收到這個事件。
  4. 於是把 loading 圖示寫進了 tipswindown 的內容區。

也就是說:hintbox 發出的請求,觸發了 tipswindown 的 ajaxStart 處理器。兩個插件誰都沒寫錯,錯在它們都假設「ajaxStart 只會因為自己的請求而觸發」。

三種正確解法

方案一:讓不需要全域事件的請求關掉 global。這是最小改動且最精準的做法:

$.ajax({
    url: "...",
    global: false,      // 這個請求不廣播全域事件
    success: function(){ /* ... */ }
});

方案二:在 ajaxSend 中依 url 過濾。ajaxStart 拿不到 settings,但 ajaxSend 可以。把判斷搬到 ajaxSend,就能精準辨識請求來源:

$(document).ajaxSend(function(evt, xhr, settings){
    if (settings.url.indexOf("hintbox") > -1) { return; }   // 不是我的請求
    $("#windown-content").html(loadingHtml);
});

方案三:用計數器區分「第一個」與「後續」請求。若有多個併發請求,ajaxStart 只在全部開始前觸發一次,這時可以搭配計數確保 loading 只顯示一次、全部結束才隱藏:

var pending = 0;
$(document)
  .ajaxSend(function(evt, xhr, settings){
      if (settings.url.indexOf("hintbox") > -1) { return; }
      if (++pending === 1) { $("#windown-content").html(loadingHtml); }
  })
  .ajaxComplete(function(evt, xhr, settings){
      if (settings.url.indexOf("hintbox") > -1) { return; }
      if (--pending === 0) { $("#windown-content").empty(); }
  });

這個案例的通用教訓

jQuery 的六個全域 ajax 事件是「全域」的——只要 global 不為 false,任何請求都會觸發所有已掛上這類監聽的處理器。當同一頁面上有多個獨立元件各自監聽 ajaxStart/ajaxStop 時,就會互相干擾。

排查這類問題的思路是:症狀看起來像 A 元件被 B 元件影響,就去檢查兩者是否共享了某個全域狀態——可能是 ajaxSettings、可能是 $.data 上相同的 key、也可能是同樣的 element id。本文的案例中,兩者共用的就是那個 global: true 的預設設定。

修改後的 tipswindown 可點擊下載。

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