一、基本概念
1、標(biāo)簽(Tag)
標(biāo)簽是一種XML元素,通過標(biāo)簽可以使JSP網(wǎng)頁變得簡(jiǎn)潔并且易于維護(hù),還可以方便地實(shí)現(xiàn)同一個(gè)JSP文件支持多種語言版本。由于標(biāo)簽是XML元素,所以它的名稱和屬性都是大小寫敏感的。
2、標(biāo)簽庫(Tag library)
由一系列功能相似、邏輯上互相聯(lián)系的標(biāo)簽構(gòu)成的集合稱為標(biāo)簽庫。
3、標(biāo)簽庫描述文件(Tag Library Descriptor)
標(biāo)簽庫描述文件是一個(gè)XML文件,這個(gè)文件提供了標(biāo)簽庫中類和JSP中對(duì)標(biāo)簽引用的映射關(guān)系。它是一個(gè)配置文件,和web.xml是類似的。
4、標(biāo)簽處理類(Tag Handle Class)
標(biāo)簽處理類是一個(gè)Java類,這個(gè)類繼承了TagSupport或者擴(kuò)展了SimpleTag接口,通過這個(gè)類可以實(shí)現(xiàn)自定義JSP標(biāo)簽的具體功能。
二、自定義JSP標(biāo)簽的格式
1、為了使到JSP容器能夠使用標(biāo)簽庫中的自定義行為,必須滿足以下兩個(gè)條件:
<% @ taglib prefix=”someprefix” uri=”/sometaglib” %> |
1)從一個(gè)指定的標(biāo)簽庫中識(shí)別出代表這種自定義行為的標(biāo)簽;
2)找到實(shí)現(xiàn)這些自定義行為的具體類。
第一個(gè)必需條件-找出一個(gè)自定義行為屬于那個(gè)標(biāo)簽庫-是由標(biāo)簽指令的前綴(Taglib Directive's Prefix)屬性完成,所以在同一個(gè)頁面中使用相同前綴的元素都屬于這個(gè)標(biāo)簽庫。每個(gè)標(biāo)簽庫都定義了一個(gè)默認(rèn)的前綴,用在標(biāo)簽庫的文檔中或者頁面中插入自定義標(biāo)簽。所以,你可以使用除了諸如jsp,jspx,java,servlet,sun,sunw(它們都是在JSP白皮書中指定的保留字)之類的前綴。
uri屬性滿足了以上的第二個(gè)要求。為每個(gè)自定義行為找到對(duì)應(yīng)的類。這個(gè)uri包含了一個(gè)字符串,容器用它來定位TLD文件。在TLD文件中可以找到標(biāo)簽庫中所有標(biāo)簽處理類的名稱。
2、當(dāng)web應(yīng)用程序啟動(dòng)時(shí),容器從WEB-INF文件夾的目錄結(jié)構(gòu)的META-INF搜索所有以.tld結(jié)尾的文件。也就是說它們會(huì)定位所有的TLD文件。對(duì)于每個(gè)TLD文件,容器會(huì)先獲取標(biāo)簽庫的URI,然后為每個(gè)TLD文件和對(duì)應(yīng)的URI創(chuàng)建映射關(guān)系。
在JSP頁面中,我們僅需通過使用帶有URI屬性值的標(biāo)簽庫指令來和具體的標(biāo)簽庫匹配。
三、自定義JSP標(biāo)簽的處理過程
1、在JSP中引入標(biāo)簽庫
<% @ taglib prefix=”taglibprefix” uri=”tagliburi” %> |
2、在JSP中使用標(biāo)簽庫標(biāo)簽
3、Web容器根據(jù)第二個(gè)步驟中的prefix,獲得第一個(gè)步驟中聲明的taglib的uri屬性值
4、Web容器根據(jù)uri屬性在web.xml找到對(duì)應(yīng)的元素
5.從元素中獲得對(duì)應(yīng)的元素的值
6.Web容器根據(jù)元素的值從WEB-INF/目錄下找到對(duì)應(yīng)的.tld文件
7.從.tld文件中找到與tagname對(duì)應(yīng)的元素
8.湊元素中獲得對(duì)應(yīng)的元素的值
9.Web容器根據(jù)元素的值創(chuàng)建相應(yīng)的tag handle class的實(shí)例
10. Web容器調(diào)用這個(gè)實(shí)例的doStartTag/doEndTag方法完成相應(yīng)的處理。
四、創(chuàng)建和使用一個(gè)Tag Library的基本步驟
1、創(chuàng)建標(biāo)簽的處理類(Tag Handler Class)
2、創(chuàng)建標(biāo)簽庫描述文件(Tag Library Descrptor File)
3、在web.xml文件中配置元素 4.在JSP文件中引人標(biāo)簽庫
五、TagSupport類簡(jiǎn)介
1、處理標(biāo)簽的類必須擴(kuò)展javax.servlet.jsp.TagSupport。
2、TagSupport類的主要屬性:
A.parent屬性:代表嵌套了當(dāng)前標(biāo)簽的上層標(biāo)簽的處理類;
B.pageContex屬性:代表Web應(yīng)用中的javax.servlet.jsp.PageContext對(duì)象;
3、JSP容器在調(diào)用doStartTag或者doEndTag方法前,會(huì)先調(diào)用setPageContext和setParent方法,設(shè)置pageContext和parent。因此在標(biāo)簽處理類中可以直接訪問pageContext變量;
4、在TagSupport的構(gòu)造方法中不能訪問pageContext成員變量,因?yàn)榇藭r(shí)JSP容器還沒有調(diào)用setPageContext方法對(duì)pageContext進(jìn)行初始化。
六、TagSupport處理標(biāo)簽的方法
1、TagSupport類提供了兩個(gè)處理標(biāo)簽的方法:
public int doStartTag() throws JspException
public int doEndTag() throws JspException
2、doStartTag:但JSP容器遇到自定義標(biāo)簽的起始標(biāo)志,就會(huì)調(diào)用doStartTag()方法。
doStartTag()方法返回一個(gè)整數(shù)值,用來決定程序的后續(xù)流程。
A.Tag.SKIP_BODY:表示?>…之間的內(nèi)容被忽略;
B.Tag.EVAL_BODY_INCLUDE:表示標(biāo)簽之間的內(nèi)容被正常執(zhí)行。
3、doEndTag:但JSP容器遇到自定義標(biāo)簽的結(jié)束標(biāo)志,就會(huì)調(diào)用doEndTag()方法。doEndTag()方法也返回一個(gè)整數(shù)值,用來決定程序后續(xù)流程。
A.Tag.SKIP_PAGE:表示立刻停止執(zhí)行網(wǎng)頁,網(wǎng)頁上未處理的靜態(tài)內(nèi)容和JSP程序均被忽略任何已有的輸出內(nèi)容立刻返回到客戶的瀏覽器上。
B.Tag_EVAL_PAGE:表示按照正常的流程繼續(xù)執(zhí)行JSP網(wǎng)頁。
下面來看一個(gè)實(shí)例:
1、修改web.xml文件,增加自定義標(biāo)簽支持。
<jsp-config> <taglib> <taglib-uri>/tld/helloworld</taglib-uri> <taglib-location>/WEB-INF/tlds/helloworld.tld</taglib-location> </taglib> </jsp-config>
2、創(chuàng)建標(biāo)簽庫TLD文件 tlds\helloworld.tld 。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd"> <taglib> <tlib-version>1.0</tlib-version><!-- 標(biāo)簽庫的版本 --> <jsp-version>1.2</jsp-version><!-- 這個(gè)標(biāo)簽庫要求的JSP規(guī)范版本 --> <short-name>mytag</short-name><!-- JSP頁面編寫工具可以用來創(chuàng)建助記名的可選名字 --> <tag> <name>helloworld</name><!-- 唯一標(biāo)簽名 --> <tag-class>com.yd.mytag.HelloWorldTag</tag-class><!-- 標(biāo)簽HelloWorldTag類的完全限定名 --> <body-content>empty</body-content><!-- 正文內(nèi)容類型 --> </tag> </taglib>
這里注意:web.xml和xxx.tld這兩個(gè)XML文件的頭信息的版本匹配很重要,否則會(huì)導(dǎo)致頁面報(bào)錯(cuò)找不到標(biāo)簽 。
3、創(chuàng)建標(biāo)簽處理程序類 HelloWorldTag(重寫doStartTag和doEndTag方法)。
package com.yd.mytag; import java.io.IOException; import javax.servlet.jsp.JspException; import javax.servlet.jsp.JspTagException; import javax.servlet.jsp.tagext.TagSupport; /** * TagSupport與BodyTagSupport的區(qū)別: * 主要看標(biāo)簽處理類是否要讀取標(biāo)簽體的內(nèi)容和改變標(biāo)簽體返回的內(nèi)容,如果不需要就用TagSupport,否則就用BodyTagSupport * 用TagSupport實(shí)現(xiàn)的標(biāo)簽,都可以用BodyTagSupport來實(shí)現(xiàn),因?yàn)锽odyTagSupport繼承了TagSupport */ public class HelloWorldTag extends TagSupport { private static final long serialVersionUID = 3174234039143531070L; @Override public int doStartTag() throws JspException {//這個(gè)方法不用所以直接返回值 return EVAL_BODY_INCLUDE; } @Override public int doEndTag() throws JspException {//重點(diǎn)在這個(gè)方法上 try { pageContext.getOut().write("Hello World!");//標(biāo)簽的返回值 } catch (IOException ex) { throw new JspTagException("錯(cuò)誤"); } return EVAL_PAGE; } }
補(bǔ)充:
doStartTag()方法是遇到標(biāo)簽開始時(shí)會(huì)呼叫的方法,其合法的返回值是EVAL_BODY_INCLUDE與SKIP_BODY,前者表示將顯示標(biāo)簽間的文字,后者表示不顯示標(biāo)簽間的文字。
doEndTag()方法是在遇到標(biāo)簽結(jié)束時(shí)呼叫的方法,其合法的返回值是EVAL_PAGE與SKIP_PAGE,前者表示處理完標(biāo)簽后繼續(xù)執(zhí)行以下的JSP網(wǎng)頁,后者是表示不處理接下來的JSP網(wǎng)頁。
doAfterBody(),這個(gè)方法是在顯示完標(biāo)簽間文字之后呼叫的,其返回值有EVAL_BODY_AGAIN與SKIP_BODY,前者會(huì)再顯示一次標(biāo)簽間的文字,后者則繼續(xù)執(zhí)行標(biāo)簽處理的下一步。
EVAL_BODY_INCLUDE:把Body讀入存在的輸出流中,doStartTag()函數(shù)可用。
EVAL_PAGE:繼續(xù)處理頁面,doEndTag()函數(shù)可用。
SKIP_BODY:忽略對(duì)Body的處理,doStartTag()和doAfterBody()函數(shù)可用。
SKIP_PAGE:忽略對(duì)余下頁面的處理,doEndTag()函數(shù)可用。
EVAL_BODY_BUFFERED:申請(qǐng)緩沖區(qū),由setBodyContent()函數(shù)得到的BodyContent對(duì)象來處理tag的body,如果類實(shí)現(xiàn)了BodyTag,那么doStartTag()可用,否則非法。