萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> JSP 程式設計

JSP 註解陷阱:HTML 註解不會阻止 Java 代碼執行

問題現象

在 JSP 中使用 HTML 註解 `<!-- -->` 包裹 Java 代碼 (Scriptlet/EL/標籤),代碼依然會在伺服器端執行,且輸出結果會出現在瀏覽器原始碼的註解內部。

錯誤範例

<!-- 
    <% 
        // 這段代碼仍會執行!
        System.out.println("偵測到執行"); 
        someHeavyOperation(); // 效能影響
    %>
    
    <s:iterator value="listDictSex">
        <option><s:property value="dict_name"/></option>
    </s:iterator>
-->

瀏覽器檢視原始碼結果:

<!-- 
    
    選項內容已渲染輸出...
    
-->

根本原因

  • JSP 編譯階段:容器解析 `<% ... %>`、``、`${...}` 等JSP 語法元素,生成 Servlet Java 代碼
  • HTML 註解 `` 只是模板文字,原樣輸出到 Servlet 的 `out.write("")`
  • 執行階段:Servlet 執行邏輯,輸出 HTML 註解包裹的結果

正確做法:JSP 註解語法

<%-- 
    這是真正的 JSP 註解
    內容在編譯階段即被移除
    不會出現在生成的 Servlet 代碼中
    自然也不會執行、不會輸出、不佔用頻寬
--%>

<%-- 
    <% System.out.println("不會執行"); %>
    <s:iterator value="list">...</s:iterator>
--%>

對比總結

特性HTML 註解 `<!-- -->`JSP 註解 `<%-- --%>`
編譯階段處理保留為模板文字直接移除,不生成代碼
執行階段執行內部 JSP 邏輯,輸出註解包裹結果無程式碼,無執行,無輸出
瀏覽器可見性可見 (檢視原始碼)不可見
效能影響執行邏輯 + 輸出傳輸零影響
適用場景給前端開發者看的說明、暫時隱藏 UI 區塊暫時停用伺服端邏輯、除錯註解、版權/授權聲明

最佳實踐

  1. 停用伺服端邏輯:永遠用 `<%-- --%>`
  2. 前端說明/暫時隱藏 HTML 區塊:用 ``
  3. 代碼版本控管:不要用註解「保留舊代碼」,用 Git 管理歷史版本
  4. IDE 支援:Eclipse/IntelliJ 可快捷鍵切換 JSP 註解 (通常 `Ctrl+Shift+/` 或 `Ctrl+/` 視語境)

延伸:其他 JSP 註解相關語法

  • <%-- --%>:JSP 註解 (推薦)
  • <%-- --%> 中不可巢狀另一個 JSP 註解
  • Java 代碼區塊內用 Java 註解:`<% // 單行 /* 多行 */ %>`
  • 指令區塊不可直接註解,需整行註解:`<%-- @page ... --%>`
copyright © 萬盛學電腦網 all rights reserved