top
Loading...

JSP 自定義標籤

JSP 自定義標籤

自定義標籤是用戶定義的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.runoob;
import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;
public class HelloTag extends SimpleTagSupport {
  public void doTag() throws JspException, IOException {
    JspWriter out = getJspContext().getOut();
    out.println("Hello Custom Tag!");
  }
}

以下代碼重寫了doTag()方法，方法中使用了getJspContext()方法來獲取當前的JspContext對象，併將"Hello Custom Tag!"傳遞給JspWriter對象。

編譯以上類，併將其復製到環境變量CLASSPATH目錄中。最後創建如下標籤庫：<Tomcat安裝目錄>webapps\ROOT\WEB-INF\custom.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.runoob.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.runoob;
import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;
public class HelloTag extends SimpleTagSupport {
   StringWriter sw = new StringWriter();
   public void doTag()
      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.runoob.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.runoob;
import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;
public class HelloTag extends SimpleTagSupport {
   private String message;
   public void setMessage(String msg) {
      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.runoob.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>
.....
北斗有巢氏 有巢氏北斗