jsp自訂標籤

標籤：des   blog   http   ar   io   os   使用   sp   java   

一、基本概念

1、標籤(Tag)

標籤是一種XML元素，通過標籤可以使JSP網頁變得簡潔並且易於維護，還可以方便地實現同一個JSP檔案支援多種語言版本。由於標籤是XML元素，所以它的名稱和屬性都是大小寫敏感的。

2、標籤庫(Tag library)

由一系列功能相似、邏輯上互相聯絡的標籤構成的集合稱為標籤庫。

3、標籤庫描述檔案(Tag Library Descriptor)

標籤庫描述檔案是一個XML檔案，這個檔案提供了標籤庫中類和JSP中對標籤引用的映射關係。它是一個設定檔，和web.xml是類似的。

4、標籤處理類(Tag Handle Class)

標籤處理類是一個Java類，這個類繼承了TagSupport或者擴充了SimpleTag介面，通過這個類可以實現自訂JSP標籤的具體功能。

二、自訂JSP標籤的格式

1、為了使到JSP容器能夠使用標籤庫中的自訂行為，必須滿足以下兩個條件：

<% @ taglib prefix=”someprefix”　uri=”/sometaglib” %>

1)從一個指定的標籤庫中識別出代表這種自訂行為的標籤；
2)找到實現這些自訂行為的具體類。

第一個必需條件－找出一個自訂行為屬於那個標籤庫－是由標籤指令的首碼(Taglib Directive‘s Prefix)屬性完成，所以在同一個頁面中使用相同首碼的元素都屬於這個標籤庫。每個標籤庫都定義了一個預設的首碼，用在標籤庫的文檔中或者頁面中插入自訂標籤。所以，你可以使用除了諸如jsp,jspx,java,servlet,sun,sunw(它們都是在JSP白皮書中指定的保留字)之類的首碼。 　

uri屬性滿足了以上的第二個要求。為每個自訂行為找到對應的類。這個uri包含了一個字串，容器用它來定位TLD檔案。在TLD檔案中可以找到標籤庫中所有標籤處理類的名稱。

2、當web應用程式啟動時，容器從WEB-INF檔案夾的目錄結構的META-INF搜尋所有以.tld結尾的檔案。也就是說它們會定位所有的TLD檔案。對於每個TLD檔案，容器會先擷取標籤庫的URI，然後為每個TLD檔案和對應的URI建立映射關係。

在JSP頁面中，我們僅需通過使用帶有URI屬性值的標籤庫指令來和具體的標籤庫匹配。

三、自訂JSP標籤的處理過程

1、在JSP中引入標籤庫

<% @ taglib prefix=”taglibprefix” uri=”tagliburi” %>

2、在JSP中使用標籤庫標籤

3、Web容器根據第二個步驟中的prefix，獲得第一個步驟中聲明的taglib的uri屬性值

4、Web容器根據uri屬性在web.xml找到對應的元素

5．從元素中獲得對應的元素的值

6．Web容器根據元素的值從WEB-INF/目錄下找到對應的.tld檔案

7．從.tld檔案中找到與tagname對應的元素

8．湊元素中獲得對應的元素的值

9．Web容器根據元素的值建立相應的tag handle class的執行個體

10. Web容器調用這個執行個體的doStartTag/doEndTag方法完成相應的處理。

四、建立和使用一個Tag Library的基本步驟

1、建立標籤的處理類(Tag Handler Class)

2、建立標籤庫描述檔案(Tag Library Descrptor File)

3、在web.xml檔案中配置元素 4.在JSP檔案中引人標籤庫

五、TagSupport類簡介

1、處理標籤的類必須擴充javax.servlet.jsp.TagSupport。

2、TagSupport類的主要屬性：

A.parent屬性：代表嵌套了當前標籤的上層標籤的處理類；

B.pageContex屬性：代表Web應用中的javax.servlet.jsp.PageContext對象；

3、JSP容器在調用doStartTag或者doEndTag方法前，會先調用setPageContext和setParent方法，設定pageContext和parent。因此在標籤處理類中可以直接存取pageContext變數；

4、在TagSupport的構造方法中不能訪問pageContext成員變數，因為此時JSP容器還沒有調用setPageContext方法對pageContext進行初始化。

六、TagSupport處理標籤的方法

1、TagSupport類提供了兩個處理標籤的方法：

public int doStartTag() throws JspException
public int doEndTag() throws JspException

2、doStartTag：但JSP容器遇到自訂標籤的起始標誌，就會調用doStartTag()方法。

doStartTag()方法返回一個整數值，用來決定程式的後續流程。

A.Tag.SKIP_BODY：表示?>…之間的內容被忽略；

B.Tag.EVAL_BODY_INCLUDE：表示標籤之間的內容被正常執行。

3、doEndTag：但JSP容器遇到自訂標籤的結束標誌，就會調用doEndTag()方法。doEndTag()方法也返回一個整數值，用來決定程式後續流程。

A.Tag.SKIP_PAGE：表示立刻停止執行網頁，網頁上未處理的靜態內容和JSP程式均被忽略任何已有的輸出內容立刻返回到客戶的瀏覽器上。

B.Tag_EVAL_PAGE：表示按照正常的流程繼續執行JSP網頁。

下面來看一個執行個體：

1、修改web.xml檔案，增加自訂標籤支援。

 

[html] view plaincopyprint?

1. <jsp-config>

2.  

3. <taglib>

4.  

5. <taglib-uri>/tld/helloworld</taglib-uri>

6.  

7. <taglib-location>/WEB-INF/tlds/helloworld.tld</taglib-location>

8.  

9. </taglib>

10.  

11. </jsp-config>

2、建立標籤庫TLD檔案 tlds\helloworld.tld 。

 

[html] view plaincopyprint?

1. <?xml version="1.0" encoding="UTF-8"?>

2.  

3. <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"

4.  

5. "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

6.  

7. <taglib>

8.  

9. <tlib-version>1.0</tlib-version><!-- 標籤庫的版本 -->

10.  

11. <jsp-version>1.2</jsp-version><!-- 這個標籤庫要求的JSP規範版本 -->

12.  

13. <short-name>mytag</short-name><!-- JSP頁面編寫工具可以用來建立助記名的可選名字 -->

14.  

15. <tag>

16.  

17. <name>helloworld</name><!-- 唯一標籤名 -->

18.  

19. <tag-class>com.yd.mytag.HelloWorldTag</tag-class><!-- 標籤HelloWorldTag類的完全限定名 -->

20.  

21. <body-content>empty</body-content><!-- 本文內容類型 -->

22.  

23. </tag>

24.  

25. </taglib>

這裡注意：web.xml和xxx.tld這兩個XML檔案的頭資訊的版本匹配很重要，否則會導致頁面報錯找不到標籤 。

3、建立標籤處理常式類 HelloWorldTag（重寫doStartTag和doEndTag方法）。

 

[html] view plaincopyprint?

1. package com.yd.mytag;

2.  

3.  

4. import java.io.IOException;

5.  

6. import javax.servlet.jsp.JspException;

7.  

8. import javax.servlet.jsp.JspTagException;

9.  

10. import javax.servlet.jsp.tagext.TagSupport;

11.  

12. /**

13.  

14. * TagSupport與BodyTagSupport的區別:

15.  

16. * 主要看標籤處理類是否要讀取標籤體的內容和改變標籤體返回的內容，如果不需要就用TagSupport，否則就用BodyTagSupport

17.  

18. * 用TagSupport實現的標籤，都可以用BodyTagSupport來實現，因為BodyTagSupport繼承了TagSupport

19. */

20.  

21. public class HelloWorldTag extends TagSupport {

22.  

23. private static final long serialVersionUID = 3174234039143531070L;

24.  

25. @Override

26.  

27. public int doStartTag() throws JspException {//這個方法不用所以直接傳回值

28.  

29. return EVAL_BODY_INCLUDE;

30.  

31. }

32.  

33. @Override

34.  

35. public int doEndTag() throws JspException {//重點在這個方法上

36.  

37. try {

38.  

39. pageContext.getOut().write("Hello World!");//標籤的傳回值

40.  

41. } catch (IOException ex) {

42.  

43. throw new JspTagException("錯誤");

44.  

45. }

46.  

47. return EVAL_PAGE;

48.  

49. }

50.  

51. }

補充：

doStartTag()方法是遇到標籤開始時會呼叫的方法，其合法的傳回值是EVAL_BODY_INCLUDE與SKIP_BODY,前者表示將顯示標籤間的文字，後者表示不顯示標籤間的文字。

doEndTag()方法是在遇到標籤結束時呼叫的方法，其合法的傳回值是EVAL_PAGE與SKIP_PAGE，前者表示處理完標籤後繼續執行以下的JSP網頁，後者是表示不處理接下來的JSP網頁。

doAfterBody(),這個方法是在顯示完標籤間文字之後呼叫的，其傳回值有EVAL_BODY_AGAIN與SKIP_BODY，前者會再顯示一次標籤間的文字，後者則繼續執列標籤處理的下一步。

EVAL_BODY_INCLUDE：把Body讀入存在的輸出資料流中，doStartTag()函數可用。

EVAL_PAGE：繼續處理頁面，doEndTag()函數可用。

SKIP_BODY：忽略對Body的處理，doStartTag()和doAfterBody()函數可用。

SKIP_PAGE：忽略對餘下頁面的處理，doEndTag()函數可用。

EVAL_BODY_BUFFERED：申請緩衝區，由setBodyContent()函數得到的BodyContent對象來處理tag的body，如果類實現了BodyTag，那麼doStartTag()可用，否則非法。

本文來自：曹勝歡部落格專欄。轉載請註明出處：http://blog.csdn.net/csh624366188

jsp自訂標籤