萬盛學電腦網

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

JSP 簡易自訂標籤開發: 支援 Map/Collection/Array 統一遍歷與 轉義輸出

動機

JSTL `` 僅支援 Collection/Map/Array/Iterator,但無法直接遍歷 `Map.Entry` 取得 key/value,且無法處理原始陣列轉換。本文實作增強版 `` 統一支援 **Map、Collection、Array**,並補充一個 **HTML 轉義標籤** ``。

一、增強版 forEach 標籤處理器

package com.example.tag;

import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
import java.io.IOException;
import java.util.*;
import java.lang.reflect.Array;

public class ForEachTag2 extends SimpleTagSupport {
    private String var;       // 迭代變數名
    private Object items;     // 目標集合 (Map/Collection/Array)

    public void setVar(String var) { this.var = var; }
    public void setItems(Object items) { this.items = items; }

    @Override
    public void doTag() throws JspException, IOException {
        Collection<Object> collection = toCollection(items);
        if (collection == null) return;

        JspContext ctx = getJspContext();
        JspFragment body = getJspBody();

        for (Object obj : collection) {
            ctx.setAttribute(var, obj); // 將當前元素暴露為頁面屬性
            body.invoke(null);          // 執行標籤體
        }
    }

    /** 統一轉換為 Collection */
    private Collection<Object> toCollection(Object src) {
        if (src == null) return Collections.emptyList();
        if (src instanceof Map) {
            return new ArrayList<>(((Map<?,?>) src).entrySet()); // Map.Entry 集合
        }
        if (src instanceof Collection) {
            return (Collection<Object>) src;
        }
        if (src.getClass().isArray()) {
            List<Object> list = new ArrayList<>();
            int len = Array.getLength(src);
            for (int i = 0; i < len; i++) list.add(Array.get(src, i));
            return list;
        }
        // 單一物件視為單元素集合
        return Collections.singletonList(src);
    }
}

二、TLD 描述檔

<?xml version="1.0" encoding="UTF-8"?>
<taglib xmlns="https://java.sun.com/xml/ns/javaee" version="2.1">
    <tlib-version>1.0</tlib-version>
    <short-name>custom</short-name>
    <uri>https://example.com/tags/custom</uri>

    <tag>
        <name>forEach2</name>
        <tag-class>com.example.tag.ForEachTag2</tag-class>
        <body-content>scriptless</body-content>
        <attribute>
            <name>var</name><required>true</required><rtexprvalue>true</rtexprvalue>
        </attribute>
        <attribute>
            <name>items</name><required>true</required><rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>

    <tag>
        <name>htmlFilter</name>
        <tag-class>com.example.tag.HtmlFilterTag</tag-class>
        <body-content>scriptless</body-content>
    </tag>
</taglib>

三、HTML 轉義標籤處理器

package com.example.tag;

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

public class HtmlFilterTag extends SimpleTagSupport {
    @Override
    public void doTag() throws JspException, IOException {
        JspFragment body = getJspBody();
        StringWriter sw = new StringWriter();
        body.invoke(sw); // 捕獲標籤體輸出
        String content = sw.toString();
        String escaped = escapeHtml(content);
        getJspContext().getOut().write(escaped);
    }

    private String escapeHtml(String s) {
        if (s == null) return "";
        StringBuilder sb = new StringBuilder(s.length() + 16);
        for (int i = 0; i < s.length(); i++) {
            char c = s.charAt(i);
            switch (c) {
                case '<': sb.append("&lt;"); break;
                case '>': sb.append("&gt;"); break;
                case '&': sb.append("&amp;"); break;
                case '"': sb.append("&quot;"); break;
                case '\'': sb.append("'"); break;
                default: sb.append(c);
            }
        }
        return sb.toString();
    }
}

四、JSP 使用範例

<%@ taglib prefix="c" uri="https://example.com/tags/custom" %>
<%@ page import="java.util.*" %>
<%
    // 準備測試資料
    Map<String,String> map = new HashMap<>();
    map.put("aa", "AAA"); map.put("bb", "BBB");
    request.setAttribute("myMap", map);

    String[] arr = {"Apple", "Banana", "Cherry"};
    request.setAttribute("myArr", arr);
%>

<h3>遍歷 Map</h3>
<c:forEach2 var="entry" items="${myMap}">
    Key: ${entry.key}, Value: ${entry.value}<br/>
</c:forEach2>

<h3>遍歷 Array</h3>
<c:forEach2 var="fruit" items="${myArr}">
    ${fruit}<br/>
</c:forEach2>

<h3>HTML 轉義輸出</h3>
<c:htmlFilter>
    <a href="">這會被轉義顯示原始標籤</a>
    & 特殊字元也會轉義
</c:htmlFilter>

輸出效果

遍歷 Map
Key: aa, Value: AAA
Key: bb, Value: BBB

遍歷 Array
Apple
Banana
Cherry

HTML 轉義輸出
<a href="">這會被轉義顯示原始標籤</a>
& 特殊字元也會轉義

進階擴充方向

  • 支援 `varStatus` 提供循環索引。
  • 支援 `begin`、`end`、`step` 切片。
  • 整合 JSTL `` 介面風格,實作 `Tag` 而非 `SimpleTag` 以支援 `TagSupport` 生命週期。
  • 轉義標籤可整合 OWASP Java Encoder 庫,支援 JS/CSS/URL 等多語境編碼。
copyright © 萬盛學電腦網 all rights reserved