萬盛學電腦網

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

JSP 自定義標籤開發完整流程:從 TagHandler 到 TLD 部署

自定義標籤開發四步驟

  1. 編寫標籤處理類
  2. 編寫 TLD 標籤描述檔
  3. 配置 web.xml(可選,JSP 2.0+ 自動掃描)
  4. JSP 頁面引入使用

步驟 1:標籤處理類

繼承 BodyTagSupport(有主體內容)或 SimpleTagSupport(JSP 2.0+ 推薦)。

BodyTagSupport 版本(傳統)

package com.example.tag;

import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
import java.io.IOException;

public class MessageWriterTagHandler extends BodyTagSupport {
  private String fontColor = "black"; // 預設黑色

  public String getFontColor() { return fontColor; }
  public void setFontColor(String fontColor) { this.fontColor = fontColor; }

  @Override
  public int doAfterBody() throws JspException {
    BodyContent bodyContent = getBodyContent();
    JspWriter out = bodyContent.getEnclosingWriter();
    try {
      String body = bodyContent.getString();
      out.print("<font color=\"" + fontColor + "\">" + body + "</font>");
    } catch (IOException e) {
      throw new JspException(e);
    }
    return SKIP_BODY; // 主體已處理,不再重複評估
  }
}

SimpleTagSupport 版本(現代、更簡潔)

public class MessageWriterTag extends SimpleTagSupport {
  private String fontColor = "black";

  public void setFontColor(String fontColor) { this.fontColor = fontColor; }

  @Override
  public void doTag() throws JspException, IOException {
    JspFragment body = getJspBody();
    if (body != null) {
      StringWriter sw = new StringWriter();
      body.invoke(sw); // 將主體內容寫入 StringWriter
      String content = sw.toString();
      getJspContext().getOut().print("<font color=\"" + fontColor + "\">" + content + "</font>");
    }
  }
}

步驟 2:TLD 標籤描述檔

路徑:WEB-INF/tlds/mytags.tld

<?xml version="1.0" encoding="UTF-8"?>
<taglib xmlns="https://xmlns.jcp.org/xml/ns/javaee"
        xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="https://xmlns.jcp.org/xml/ns/javaee web-jsptaglibrary_2_1.xsd"
        version="2.1">
  <tlib-version>1.0</tlib-version>
  <short-name>my</short-name>
  <uri>https://example.com/mytags</uri>
  
  <tag>
    <name>colored</name>
    <tag-class>com.example.tag.MessageWriterTag</tag-class>
    <body-content>scriptless</body-content>
    <attribute>
      <name>fontColor</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>  <!-- 支援 EL 運算式 -->
      <type>java.lang.String</type>
    </attribute>
  </tag>
</taglib>

步驟 3:JSP 頁面使用

<%@ taglib prefix="my" uri="https://example.com/mytags" %>
<html><body>
  <my:colored fontColor="red">這段文字會變紅色</my:colored>
  <br>
  <my:colored fontColor="${user.preferredColor}">支援 EL 運算式的顏色</my:colored>
</body></html>

標籤屬性詳解

TLD 屬性說明
requiredtrue/false,是否必填
rtexprvaluetrue/false,是否接受運行時運算式(EL、Scriptlet)
type屬性 Java 型別,預設 String
fragmenttrue 表示屬性為 JspFragment(片段屬性),配合 <jsp:attribute> 使用

body-content 取值

  • empty:無主體 <my:tag/>
  • scriptless:主體可含 EL、JSTL、標準動作,**不可含 Scriptlet** (JSP 2.0+ 推薦)
  • tagdependent主體視為純文字,由標籤自行解析(如 SQL 標籤)
  • JSP:主體可含任意 JSP 代碼(舊版相容,不推薦)

部署與驗證

  1. 編譯 Tag Handler 類別至 WEB-INF/classes/ 或打包 JAR 放入 WEB-INF/lib/。
  2. TLD 放入 WEB-INF/tlds/ 或 JAR META-INF/。
  3. 啟動容器,訪問 JSP 頁面驗證輸出。

進階主題

  • 巢狀標籤:TagSupport.getParent() 取得父標籤實例,協作處理邏輯。
  • 標籤檔:.tag 檔案(JSP 語法寫標籤),無需 Java 類別,放入 WEB-INF/tags/ 即可自動部署。
  • EL 函式:<function> 定義靜態方法供 EL 調用,比標籤更輕量。
  • 驗證器:實作 TagLibraryValidator 編譯期驗證標籤用法正確性。

最佳實踐

  1. 優先使用 SimpleTagSupport,API 更簡潔、不易出錯。
  2. body-content 設為 scriptless,禁止 Scriptlet 進入標籤主體。
  3. 屬性型別盡量具體(Integer, Boolean, Enum),容器自動轉型。
  4. 標籤前綴簡短有意義(c, fmt, fn, my, sec)。
  5. 大量標籤打包成獨立 JAR,Maven 發布,多專案共用。
copyright © 萬盛學電腦網 all rights reserved