DIV CSS 佈局教程網

jQuery 在 html 正常、搬到 jsp 就失效?$ 與 JSTL 的衝突與解法
編輯:JavaScript綜合知識     

這個問題困擾過我一段時間:同一份 jQuery 程式碼,寫在 .html 檔裡跑得好好的,一搬進 .jsp 就完全不動。沒有語法錯誤、沒有載入失敗,就是安靜地什麼都不做。

重現問題的程式碼

當時我在做一個「下拉選單選項左右移動」的功能:

<script type="text/javascript" src="../js/jquery-1.4.2.js"></script>
<script type="text/javascript">
$(function(){
  $("input").hover(function(){
    $(this).val("")
  },
  function(){
    $(this).val(this.defaultValue)
  }
  )
})

jQuery(function(){
  // 左側選項加到右側
  jQuery("#add").click(function(){ $("#select1 option:selected").appendTo("#select2") })
  // 右側選項加回左側
  jQuery("#remove").click(function(){ $("#select2 option:selected").appendTo("#select1") })
  // 全部加到右邊
  jQuery("#add_all").click(function(){ $("#select1 option").appendTo("#select2") })
  // 全部移回左邊
  $("#remove_all").click(function(){ $("#select2 option").appendTo("#select1") })
  // 雙擊左側選單移右
  $("#select1").dblclick(function(){ $("option:selected", this).appendTo("#select2") })
  // 雙擊右側選單移左
  $("#select2").dblclick(function(){ $("option:selected", this).appendTo("#select1") })
})

function len() {
  var sel = document.getElementById("select2");
  alert(sel.length);
}
</script>

配套的 HTML 是兩個 <select multiple>,中間夾著箭頭圖示和「全部移向右邊/全部移向左邊」的按鈕。

用笨方法找線索

搬到 jsp 之後失效,我沒有直接猜原因,而是先寫個 alert 看看究竟哪裡出錯。錯誤訊息指向了 jQuery 相關的呼叫——不認識那個方法。

原因就浮出來了:JSP 頁面裡的 JSTL 標籤(如 <c:url>、${...} 表達式)大量使用 $ 符號,與 jQuery 的 $ 產生了衝突,導致 jQuery 拿不到它期待的那個 $。

這也解釋了原程式碼裡一個原本讓我困惑的現象:為什麼同一段程式碼,有些地方寫 jQuery(...) 而有些地方寫 $(...),看起來毫不一致卻在 html 檔裡能跑。那其實是原作者早就遇過類似衝突、開始混著寫留下的痕跡。

解法

把 jQuery 程式碼裡的 $ 全部改成 jQuery 就可以正常使用了。

這個做法確實有效,但逐一手改既醜又容易漏。更完整的解法有幾種:

用 noConflict 交出 $ 的控制權:

<script src="jquery.js"></script>
<script>
var $j = jQuery.noConflict();
$j(function(){
  $j("#add").click(function(){ ... });
});
</script>

noConflict() 會把 $ 還原成 jQuery 載入前的樣子(通常是 Prototype 或頁面原本定義的那個),然後回傳 jQuery 本體給你自己命名。這樣兩邊各用各的,互不干擾。

用 IIFE 把 $ 局部化,這是比較優雅的寫法:

<script>
(function($) {
  $(function(){
    $("#add").click(function(){ ... });
  });
})(jQuery);
</script>

把 jQuery 當參數傳進一個立即執行的函式,函式內部的 $ 就是 jQuery,外頭的 $ 是什麼都不影響。程式碼寫起來跟平常一樣自然,隔離卻是乾淨的。

另一個常見的 jsp 地雷

順帶一提,jQuery 搬到 jsp 失效還有個高頻原因:路徑寫錯。jsp 常被.forward 或 redirect 到不同層級的 URL,相對路徑 ../js/jquery.js 在 html 直接開啟時是對的,經過後端轉發後可能就不是同一個位置了。除錯時第一步永遠是看開發者工具的 Network 面板,確認 jQuery 到底有沒有載入成功——404 的話,前面那些衝突分析全都用不上。

還有一種是編碼問題:jsp 若沒正確宣告 UTF-8,含中文的 script 區塊可能出現亂字元而引發語法錯誤,整個 script 就失效了。

這次的經驗讓我學到一件事:跨環境搬移程式碼時,「它在這裡明明可以跑」這句話本身沒有資訊量。真正有用的是把錯誤訊息抓出來看。

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