JSP 自訂標籤

作者：Eve Cole 更新時間：2024-12-30 16:48:02

自訂標籤是使用者定義的JSP語言元素。當JSP頁麵包含一個自訂標籤時將被轉換為servlet，標籤轉化為對被稱為tag handler的物件的操作，即當servlet執行時Web container調用那些操作。

JSP標籤擴充功能可以讓你建立新的標籤並且可以直接插入到一個JSP頁面。 JSP 2.0規格中引入Simple Tag Handlers來編寫這些自訂標記。

你可以繼承SimpleTagSupport類別並重寫的doTag()方法來開發一個最簡單的自訂標籤。

建立"Hello"標籤

接下來，我們想建立一個自訂標籤叫作<ex:Hello>，標籤格式為：

 <ex:Hello />

要建立自訂的JSP標籤，你必須先建立處理標籤的Java類別。所以，讓我們建立一個HelloTag類，如下所示：

 package com.tutorialspoint;import javax.servlet.jsp.tagext.*;import javax.servlet.jsp.*;import java.io.*;public class HelloTag extends SimpleTagSupport { public void doTag() throws JIOspException, IOspception {WExoid doTag() 是= getJspContext().getOut(); out.println("Hello Custom Tag!"); }}

以下程式碼重寫了doTag()方法，方法中使用了getJspContext()方法來取得目前的JspContext對象，並將"Hello Custom Tag!"傳遞給JspWriter物件。

編譯以上類，並將其複製到環境變數CLASSPATH目錄。最後建立如下標籤庫：<Tomcat安裝目錄>webappsROOTWEB-INFcustom.tld。

 <taglib> <tlib-version>1.0</tlib-version> <jsp-version>2.0</jsp-version> <short-name>Example TLD</short-name> <tag> <name>Hello</name > <tag-class>com.tutorialspoint.HelloTag</tag-class> <body-content>empty</body-content> </tag></taglib>

接下來，我們就可以在JSP檔案中使用Hello標籤：

 <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%><html> <head> <title>A sample custom tag</title> </head> <body> <ex:Hello /> </body></html>

以上程序輸出結果為：

 Hello Custom Tag!

訪問標籤體

你可以像標準標籤庫一樣在標籤中包含訊息內容。如我們要在我們自訂的Hello中包含內容，格式如下：

 <ex:Hello> This is message body</ex:Hello>

我們可以修改標籤處理類別文件，程式碼如下：

 package com.tutorialspoint;import javax.servlet.jsp.tagext.*;import javax.servlet.jsp.*;import java.io.*;public class HelloTag extends SimpleTagSupport { StringWriter sw = new class HelloTag extends SimpleTagSupport { StringWriter sw = new StringWriter(); ) throws JspException, IOException { getJspBody().invoke(sw); getJspContext().getOut().println(sw.toString()); }}

接下來我們要修改TLD文件，如下所示：

 <taglib> <tlib-version>1.0</tlib-version> <jsp-version>2.0</jsp-version> <short-name>Example TLD with Body</short-name> <tag> <name>Hello< /name> <tag-class>com.tutorialspoint.HelloTag</tag-class> <body-content>scriptless</body-content> </tag></taglib>

現在我們可以在JSP使用修改過的標籤，如下所示:

 <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%><html> <head> <title>A sample custom tag</title> </head> <body> <ex:Hello > This is message body </ex:Hello> </body></html>

以上程式輸出結果如下所示：

 This is message body

自訂標籤屬性

你可以在自訂標準中設定各種屬性，要接收屬性，值自訂標籤類別必須實作setter方法， JavaBean 中的setter方法如下所示：

 package com.tutorialspoint;import javax.servlet.jsp.tagext.*;import javax.servlet.jsp.*;import java.io.*;public class HelloTag extends SimpleTagSupport { private String message; public void setMessage( mString mString) this.message = msg; } StringWriter sw = new StringWriter(); public void doTag() throws JspException, IOException { if (message != null) { /* 從屬性使用訊息*/ JspWriter out = getJspContext().getOut(); out.println( message ); } else { /* 從內容體使用訊息*/ getJspBody().invoke(sw); getJspContext().getOut().println(sw.toString()); } }}

屬性的名稱是"message"，所以setter方法是的setMessage()。現在讓我們在TLD檔案中使用的<attribute>元素加入此屬性：

 <taglib> <tlib-version>1.0</tlib-version> <jsp-version>2.0</jsp-version> <short-name>Example TLD with Body</short-name> <tag> <name>Hello< /name> <tag-class>com.tutorialspoint.HelloTag</tag-class> <body-content>scriptless</body-content> <attribute> <name>message</name> </attribute> </tag></taglib>

現在我們就可以在JSP檔案中使用message屬性了，如下所示：

 <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%><html> <head> <title>A sample custom tag</title> </head> <body> <ex:Hello message="This is custom tag" /> </body></html>

以上實例資料輸出結果為：

 This is custom tag

你也可以包含以下屬性：

屬性	描述
name	定義屬性的名稱。每個標籤的是屬性名稱必須是唯一的。
required	指定屬性是否是必須的或可選的,如果設定為false為可選。
rtexprvalue	聲明在運行表達式時，標籤屬性是否有效。
type	定義該屬性的Java類別類型。預設指定為String
description	描述訊息
fragment	如果聲明了該屬性,屬性值將被視為一個JspFragment 。

以下是指定相關的屬性實例：

 ..... <attribute> <name>attribute_name</name> <required>false</required> <type>java.util.Date</type> <fragment>false</fragment> </attribute>.. ……

如果你使用了兩個屬性，修改TLD文件，如下所示：

 ..... <attribute> <name>attribute_name1</name> <required>false</required> <type>java.util.Boolean</type> <fragment>false</fragment> </attribute> <attribute > <name>attribute_name2</name> <required>true</required> <type>java.util.Date</type> </attribute>.....