JSP 自定義標(biāo)簽

2022-06-20 14:34 更新

自定義標(biāo)簽是用戶定義的JSP語(yǔ)言元素。當(dāng)JSP頁(yè)面包含一個(gè)自定義標(biāo)簽時(shí)將被轉(zhuǎn)化為servlet,標(biāo)簽轉(zhuǎn)化為對(duì)被 稱為tag handler的對(duì)象的操作,即當(dāng)servlet執(zhí)行時(shí)Web container調(diào)用那些操作。

JSP標(biāo)簽擴(kuò)展可以讓你創(chuàng)建新的標(biāo)簽并且可以直接插入到一個(gè)JSP頁(yè)面。 JSP 2.0規(guī)范中引入Simple Tag Handlers來(lái)編寫這些自定義標(biāo)記。

你可以繼承SimpleTagSupport類并重寫的doTag()方法來(lái)開(kāi)發(fā)一個(gè)最簡(jiǎn)單的自定義標(biāo)簽。


創(chuàng)建"Hello"標(biāo)簽

接下來(lái),我們想創(chuàng)建一個(gè)自定義標(biāo)簽叫作<ex:Hello>,標(biāo)簽格式為:

<ex:Hello />

要?jiǎng)?chuàng)建自定義的JSP標(biāo)簽,你首先必須創(chuàng)建處理標(biāo)簽的Java類。所以,讓我們創(chuàng)建一個(gè)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 JspException, IOException {
    JspWriter out = getJspContext().getOut();
    out.println("Hello Custom Tag!");
  }
}

以下代碼重寫了doTag()方法,方法中使用了getJspContext()方法來(lái)獲取當(dāng)前的JspContext對(duì)象,并將"Hello Custom Tag!"傳遞給JspWriter對(duì)象。

編譯以上類,并將其復(fù)制到環(huán)境變量CLASSPATH目錄中。最后創(chuàng)建如下標(biāo)簽庫(kù):<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.tutorialspoint.HelloTag</tag-class>
    <body-content>empty</body-content>
  </tag>
</taglib>

接下來(lái),我們就可以在JSP文件中使用Hello標(biāo)簽:

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

以上程序輸出結(jié)果為:

Hello Custom Tag!

訪問(wèn)標(biāo)簽體

你可以像標(biāo)準(zhǔn)標(biāo)簽庫(kù)一樣在標(biāo)簽中包含消息內(nèi)容。如我們要在我們自定義的Hello中包含內(nèi)容,格式如下:

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

我們可以修改標(biāo)簽處理類文件,代碼如下:

package com.tutorialspoint;

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

}

接下來(lái)我們需要修改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>

現(xiàn)在我們可以在JSP使用修改后的標(biāo)簽,如下所示:

<%@ 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>

以上程序輸出結(jié)果如下所示:

This is message body

自定義標(biāo)簽屬性

你可以在自定義標(biāo)準(zhǔn)中設(shè)置各種屬性,要接收屬性,值自定義標(biāo)簽類必須實(shí)現(xiàn)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(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 {
          /* 從內(nèi)容體中使用消息 */
          getJspBody().invoke(sw);
          getJspContext().getOut().println(sw.toString());
       }
   }

}

屬性的名稱是"message",所以setter方法??是的setMessage()?,F(xiàn)在讓我們?cè)赥LD文件中使用的<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>

現(xiàn)在我們就可以在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>

以上實(shí)例數(shù)據(jù)輸出結(jié)果為:

This is custom tag

你還可以包含以下屬性:

屬性 描述
name定義屬性的名稱。每個(gè)標(biāo)簽的是屬性名稱必須是唯一的。
required指定屬性是否是必須的或者可選的,如果設(shè)置為false為可選。
rtexprvalue聲明在運(yùn)行表達(dá)式時(shí),標(biāo)簽屬性是否有效。
type定義該屬性的Java類類型 。默認(rèn)指定為 String
description描述信息
fragment如果聲明了該屬性,屬性值將被視為一個(gè) JspFragment。

以下是指定相關(guān)的屬性實(shí)例:

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

如果你使用了兩個(gè)屬性,修改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>
.....


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)