JSP自定義標簽

自定義標簽是用戶自定義的JSP語言元素。當包含一個自定義標簽的JSP頁麵轉換成servlet，標簽轉化為操作稱為標記處理程序的對象上。 Web容器然後執行JSP頁麵的servlet調用時的這些操作。

JSP標簽擴展可以創建直接插入到JSP頁麵，隻是新的標簽，在前麵章節了解了內置的標簽。 JSP 2.0規範中引入的簡單標記處理程序編寫這些自定義標記。

要編寫自定義標簽可以繼承SimpleTagSupport類並重寫的doTag()方法，在那裡你可以用代碼來生成的標簽內容。

創建"Hello" 標簽:

考慮你要定義一個名為<ex:Hello>一個自定義標簽，想用它在以下主體：

<ex:Hello />

要創建自定義的JSP標簽，必須首先創建一個標記處理程序的Java類。所以，讓我們創建HelloTag類，如下所示：

package com.yiibai;

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()方法獲取當前JspContext對象並使用getJspContext()方法，並用它來發送“Hello Custom Tag!”到當前的JspWriter對象。

讓我們來編譯上麵的類，並複製它在環境變量CLASSPATH中可用的目錄。最後創建如下的標簽庫文件：<Tomcat-Installation-Directory>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.yiibai.HelloTag</tag-class>
    <body-content>empty</body-content>
  </tag>
</taglib>

現在是時候使用上麵定義的自定義標記Hello 在我們的JSP程序如下：

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

試著調用上麵的JSP，這應該產生以下結果：

Hello Custom Tag!

訪問標簽體：

您可以包含在標簽體，已經看到了標準的標簽信息。考慮要定義一個名為<ex:Hello>一個自定義標簽，想用它在以下方式的主體：

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

讓我們做如下更改在我們上麵的標簽代碼來處理標簽體：

package com.yiibai;

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());
    }

}

在這種情況下，從調用而產生的輸出首先被捕獲到一個StringWriter中被寫入到與標記相關聯的之前的JspWriter。現在，因此我們需要改變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.yiibai.HelloTag</tag-class>
    <body-content>scriptless</body-content>
  </tag>
</taglib>

現在，讓我們把上麵用適當的主體如下標簽：

<%@ 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.yiibai;

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) {
          /* Use message from attribute */
          JspWriter out = getJspContext().getOut();
          out.println( message );
       }
       else {
          /* use message from the body */
          getJspBody().invoke(sw);
          getJspContext().getOut().println(sw.toString());
       }
   }

}

屬性的名稱是“message”，所以setter方法是的setMessage()。現在使用<attribute>元素，如下所示在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.yiibai.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	The name element defines the name of an attribute. Each attribute name must be unique for a particular tag.
required	This specifies if this attribute is required or optional. It would be false for optional.
rtexprvalue	Declares if a runtime expression value for a tag attribute is valid
type	Defines the Java class-type of this attribute. By default it is assumed as String
description	Informational description can be provided.
fragment	Declares if this attribute value should be treated as a 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>
.....