萬盛學電腦網

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

JSP 自定義標籤開發入門:從 TagSupport 到標籤庫描述文件 (TLD) 完整流程

自定義標籤價值

  • 封裝重複展示邏輯(如表格渲染、分頁條、表單組件)
  • 實現「零 Java 代碼」JSP 頁面,配合 JSTL/EL 達到純模板化
  • 提供聲明式組件接口,降低前後端耦合

核心 API 體系 (JSP 2.0+)

Tag (接口)
  ↑ 實現
TagSupport (基類) ←── 簡單標籤、無 Body 處理
  ↑ 繼承
BodyTagSupport (基類) ←── 需要操作 Body 內容、迭代標籤
  ↑ 繼承 (JSP 2.0 新增)
SimpleTagSupport (基類) ←── 更簡潔 API,推薦新項目使用
  ↑ 實現
SimpleTag (接口)

實戰案例:用戶信息表格標籤 <cc:showUserInfo>

1. JavaBean 模型

public class UserInfo implements Serializable {
    private String userName;
    private int age;
    private String email;
    // getter/setter 省略
}

2. 標籤處理類 (繼承 TagSupport)

package com.example.tag;

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

public class UserInfoTag extends TagSupport {
    private UserInfo user; // 屬性對應標籤屬性

    @Override
    public int doStartTag() throws JspException {
        try {
            JspWriter out = pageContext.getOut();
            
            if (user == null) {
                out.println("<div class='alert'>未找到用戶信息</div>");
                return SKIP_BODY;
            }
            
            // 輸出表格 HTML
            out.println("<table class='user-info-table' width='500' border='1' align='center'>");
            out.println("  <tr><th width='20%'>用戶名</th><td>" + escapeHtml(user.getUserName()) + "</td></tr>");
            out.println("  <tr><th>年齡</th><td>" + user.getAge() + "</td></tr>");
            out.println("  <tr><th>郵箱</th><td>" + escapeHtml(user.getEmail()) + "</td></tr>");
            out.println("</table>");
            
        } catch (IOException e) {
            throw new JspException("標籤輸出異常", e);
        }
        return SKIP_BODY; // 無 Body 內容處理
    }

    @Override
    public int doEndTag() throws JspException {
        return EVAL_PAGE; // 繼續執行頁面其餘部分
    }

    @Override
    public void release() {
        super.release();
        this.user = null; // 釋放引用,支援標籤池化復用
    }

    // Getter/Setter (屬性名稱必須與標籤屬性一致)
    public UserInfo getUser() { return user; }
    public void setUser(UserInfo user) { this.user = user; }

    // XSS 防護工具方法
    private String escapeHtml(String input) {
        if (input == null) return "";
        return input.replace("&", "&amp;")
                    .replace("<", "&lt;")
                    .replace(">", "&gt;")
                    .replace("\"", "&quot;")
                    .replace("'", "'");
    }
}

3. TLD 文件 /WEB-INF/tlds/user.tld

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.1" 
        xmlns="https://java.sun.com/xml/ns/javaee"
        xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="https://java.sun.com/xml/ns/javaee web-jsptaglibrary_2_1.xsd">
    
    <tlib-version>1.0</tlib-version>
    <short-name>user</short-name>
    <uri>https://example.com/tags/user</uri>
    
    <tag>
        <name>showUserInfo</name>
        <tag-class>com.example.tag.UserInfoTag</tag-class>
        <body-content>empty</body-content> <!-- 無 Body -->
        
        <attribute>
            <name>user</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue> <!-- 支持 EL 表達式 -->
            <type>com.example.model.UserInfo</type>
            <description>要展示的用戶信息對象</description>
        </attribute>
    </tag>
</taglib>

4. JSP 頁面使用

<%@ taglib prefix="cc" uri="https://example.com/tags/user" %>
<%-- 或 uri="/WEB-INF/tlds/user.tld" -->

<html><body>
<h2>用戶檔案</h2>

<%-- 準備測試數據 (實際來自 Controller) --%>
<%
    UserInfo user = new UserInfo();
    user.setUserName("Xuwei");
    user.setAge(33);
    user.setEmail("test@test.test");
    pageContext.setAttribute("userinfo", user);
%>

<%-- 調用自定義標籤 -->
<cc:showUserInfo user="${pageScope.userinfo}" />

</body></html>

進階:帶 Body 內容的標籤 (繼承 BodyTagSupport)

public class LoopTag extends BodyTagSupport {
    private int count = 1;
    
    public void setCount(int count) { this.count = count; }
    
    @Override
    public int doAfterBody() throws JspException {
        if (count-- > 0) {
            try {
                // 將 Body 內容寫入父級輸出流
                BodyContent body = getBodyContent();
                body.writeOut(getPreviousOut());
            } catch (IOException e) {
                throw new JspException(e);
            }
            return EVAL_BODY_AGAIN; // 繼續迭代
        }
        return SKIP_BODY;
    }
}
<my:loop count="3">
    <p>第 ${count} 次迭代</p>
</my:loop>

JSP 2.0+ 簡化開發:標籤文件

無需 Java 類,直接編寫 .tag 文件放入 /WEB-INF/tags/:

<!-- /WEB-INF/tags/userCard.tag -->
<%@ attribute name="user" type="com.example.model.UserInfo" required="true" %>
<%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>

<div class="user-card">
    <h4>${user.userName}</h4>
    <p>年齡: ${user.age}</p>
    <p>郵箱: ${user.email}</p>
</div>
<%@ taglib prefix="my" tagdir="/WEB-INF/tags" %>
<my:userCard user="${sessionScope.currentUser}" />

最佳實踐清單

  • 標籤類無狀態,線程安全靠 release() 重置屬性
  • 屬性類型盡量具體,支持 EL 表達式 (rtexprvalue=true)
  • 輸出用戶數據**必須** HTML 轉義
  • 複雜邏輯移至 Java 類/Service,標籤只負責渲染
  • 優先使用標籤文件 或 JSTL,減少 Java 標籤類開發
copyright © 萬盛學電腦網 all rights reserved