處理標籤屬性與本體

如果自訂標籤時，本體的內容需要執行多次該如何處理？例如原本 JSTL 的 <c:forEach> 標籤之功能，必須依所設定的陣列或 Collection 物件長度，以決定本體中的內容顯示次數。以下就來使用 Simple Tag 實作 <f:forEach> 標籤以模彷 <c:forEach> 的功能。這個 <f:forEach> 標籤會是這麼使用：

<f:forEach var="name" items="${names}">
    ${name}<br>
</f:forEach>

為了簡化範例，先不考慮 items 屬性上 EL 的運算結果是陣列的情況，而只考慮 Collection 物件。 <f:forEach> 標籤可以設定 var 屬性來決定每次從 Collection 取得物件時，應使用哪個名稱在標籤本體中取得該物件，var 只接受字串方式來設定名稱。來看看如何實作標籤處理器。

package cc.openhome;

import java.io.IOException;
import java.util.Collection;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.SimpleTagSupport;

public class ForEachTag extends SimpleTagSupport {
    private String var;
    private Collection<Object> items;

    @Override 
    public void doTag() throws JspException {
        items.forEach(o -> {
            this.getJspContext().setAttribute(var, o);

            try {
                this.getJspBody().invoke(null);
            } catch (JspException | IOException e) {
                throw new RuntimeException(e);
            }

            this.getJspContext().removeAttribute(var);
        });
    }

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

    public void setItems(Collection<Object> items) {
        this.items = items;
    }
}

在屬性的設定上，由於 var 屬性會是字串方式設定，所以宣告為 String 型態。items 運算的結果可接受 Collection<Object> 物件，所以型態宣告為 Collection<Object>。標籤本體可接受的 EL 名稱，事實上是取得 PageContext 後使用其 setAttribute() 進行設定。

<f: forEach> 標籤本體內容必須執行多次，則是透過多次呼叫 invoke() 來達成，簡單地說，在 doTag() 中每呼叫一次 invoke()，則會執行一次本體內容。由於不想讓 setAttribute() 設定的屬性，在標籤本體之外還能使用，所以最後使用 removeAttribute() 移除屬性。

接著同樣地，要在TLD檔案中定義自訂標籤相關資訊：

f.tld

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.1" xmlns="http://java.sun.com/xml/ns/j2ee"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
 web-jsptaglibrary_2_1.xsd">
    <tlib-version>1.0</tlib-version>
    <short-name>f</short-name>
    <uri>https://openhome.cc/jstl/fake</uri>
    // 略...
    <tag>
        <name>forEach</name>
        <tag-class>cc.openhome.ForEachTag</tag-class>
        <body-content>scriptless</body-content>
        <attribute>
            <name>var</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <type>java.lang.String</type>
        </attribute>
        <attribute>
            <name>items</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <type>java.util.Collection</type>
        </attribute>
    </tag>
</taglib>

Simple Tag 的本體內容，也就是 <body-content> 屬性與 Tag File 相同，除了 scriptless 之外，還可以設定 empty 或 tagdependent。

empty 表示一定沒有本體內容。tagdependent 表示將本體中的內容當作純文字處理，也就是如果本體中有出現 Scriptlet、EL 或自訂標籤，也只是當作純文字輸出，不會作任何的運算或轉譯。由於 var 屬性只接受字串設定，所以不需要設定 <rtexprvalue> 標籤，不設定時預設就是 false，也就是不接受執行時期的運算值作為屬性設定值。

到目前為止都是透過 SimpleTagSupport 的 getJspBody() 取得 JspFragment，並在呼叫 invoke() 時傳入 null，先前解釋過，這表示將使用 PageContext 取得預設的 JspWriter 物件來作輸出回應，也就是預設會輸出回應至使用者的瀏覽器。

如果在呼叫時傳入一個自訂的 Writer 物件，則標籤本體內容的處理結果，就會使用所指定的 Writer 物件進行輸出，在需要將處理過後的本體內容再作進一步處理時，就會採取這樣的作法。例如，可以開發一個將本體執行結果全部轉大寫的簡單標籤：