JSP 自定義標籤 由淺入深 詳細講解

 

一、基本概念:

  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容器能夠使用標籤庫中的自定義行爲,必須滿足以下兩個條件:

  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.創建包含JSP網頁靜態文本的文件(即是要替換自定義JSP標籤的文本)

  2.在Web應用啓動時裝載靜態文本

  3.創建標籤處理類

  九、如何創建包含JSP網頁靜態文本的文件:

  1.使用java.util.Properties類來存放要替換網頁中自定義JSP標籤的靜態文本

  2.Properties類代表了一系列屬性的集合,其實例既可以被保存到流中,也可以從流中加載。這些文本以key/value的形式存放在WEB-INF目錄下,例如key=value,在屬性列表中這些key/value都是String類型的

  十、Properties類的常用API:

  1.setProperty(String key, String value):調用Hashtable類的put方法添加屬性

  2.getProperty(String key):獲取屬性列表中key對應的屬性值

  3.load(InputStream in):從輸入流對象InputStream中讀取屬性列表(Properties list)

  4.store(OutputStream out,String coMMent):使用適當的格式將屬性列表的屬性對寫入輸出流對象中,默認使用ISO-88590-1編碼格式,以行的方式處理輸入。屬性的key/value之間以”=、:”配對,以回車、換行分隔key/value配對。

 

 

十一、ServletContext類的常用API:

  1.getContext(String uripath):返回服務器中uripath所代表的ServletContext對象

  2.getInitParameter(String name):返回ServletConfig對象中name參數的值

  3.getMineType(String file):返回file參數代表的文件的MIME類型

  4.getRequestDispatcher(String path):返回path代表的RequestDispacher對象

  5.getResourceAsStream(String path):以輸入流的形式返回path對應的資源,在輸入留中對象可以爲任意形式的數據,path參數必須以“/”開始且相對於Context Root

  十二、如何使用ServletContxt讀取並保存屬性文件:

  1.創建java.util.Properties類對象

  2.獲取ServletContext對象

  3.將屬性文件以輸入流的形式讀入到某個輸入流對象中

  4.將輸入流對象加載到Properties對象中

  5.將Properties對象保存到ServletContext對象中

  十三、如何在Web應用啓動時裝載靜態文本:

  1.創建繼承了HttpServlet類的子類,在web.xml中配置這Servlet時設置load-on-startup屬性:

  someclass

  somepackage.SomeClass1

  2.在這個Servlet的init()方法中創建java.util.Properties類

  3.獲取當前Web應用的ServletContext對象

  4.將WEB-INF目錄下的屬性文件讀入到輸入流InputStream中:

  InputStream in = context.getResourceAsString("WEB-INF/someproperties.properties");

  5.將輸入流加載到屬性對象中

  ps.load(in);

  6.將屬性對象保存到上

  context.setAttribute("attributeName",ps);

  十四、如何創建標籤處理類:

  1.引入必需的資源:

  import javax.servlet.jsp.*;

  import javax.servlet.http.*;

  import java.util.*;

  import java.io.*;

  2.繼承TagSupport類並覆蓋doStartTag()/doEndTag()方法

  3.從ServletContext對象中獲取java.util.Properties對象

  4.從Properties對象中獲取key對應的屬性值

  5.對獲取的屬性進行相應的處理並輸出結果

  十五、創建標籤庫描述文件(Tag Library Descriptor):

  1.標籤庫描述文件,簡稱TLD,採用XML文件格式,定義了用戶的標籤庫。TLD文件中的元素可以分成3類:

  A.:標籤庫元素

  B.:標籤元素

  C.:標籤屬性元素

  2.標籤庫元素用來設定標籤庫的相關信息,它的常用屬性有:

  A.shortname: 指定Tag Library默認的前綴名(prefix)

  B.uri: 設定Tag Library的惟一訪問表示符

  3.標籤元素用來定義一個標籤,它的常見屬性有:

  A.name: 設定Tag的名字

  B.tagclass: 設定Tag的處理類

  C.bodycontent: 設定標籤的主體(body)內容

  1).empty:表示標籤中沒有body

  2).JSP:表示標籤的body中可以加入JSP程序代碼

  3).tagdependent:表示標籤中的內容由標籤自己去處理

  4.標籤屬性元素用來定義標籤的屬性,它的常見屬性有:

  A.name:屬性名稱

  B.required:屬性是否必需的,默認爲false

  C.rtexprvalue:屬性值是否可以爲request-time表達式,也就是類似於< %=…% >的表達式

  十六、在Web應用中使用標籤:

  1.如果Web應用中用到了自定義JSP標籤,則必須在web.xml文件中加入元素,它用於聲明所引用的標籤所在的標籤庫

  /sometaglib

  /WEB-INF/someTLD.tld

  2.:設定Tag Library的惟一標示符,在Web應用中將根據它來引用Tag Libray

  3.:指定和Tag Library對應的TLD文件的位置

  4.在JSP文件中需要加入<% @ taglib% >指令來聲明對標籤庫的引用。例如:

  <% @ taglib prefix = “somePrefix” uri = "/someuri" %>

  5.prefix表示在JSP網頁中引用這個標籤庫的標籤時的前綴,uri用來指定Tag Library的標識符,它必須和web.xml中的屬性保持一致。end.gif

下面是兩個自定義標籤的例子:

 

 

Test.jsp

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>My JSP 'Test.jsp' starting page</title>
  </head>
 
  <body>
    This is my JSP page. <br>
    Date : <%= new java.util.Date().toString() %> <br>
    File : <input value="<%= request.getServletPath() %>" />
  </body>
</html>

爲了將這個這個Test.jsp改成自定義標籤方法,我們分別使用簡單標籤和內容標籤兩種不同的方式實現。

1. 簡單標籤

由於我們需要輸出兩個內容(日期和文件名),因此我們爲標籤創建一個參數。具體代碼:

DemoTag.java
package com.mycompany;

import java.util.Date;

import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class DemoTag extends TagSupport {
  
  public int doStartTag() throws JspException {    
    try {
      HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
      JspWriter out = pageContext.getOut();      
      
      if (parameter.compareToIgnoreCase("filename") == 0)
        out.print(request.getServletPath());
      else
        out.print(new Date());
      
    } catch (java.io.IOException e) {
      throw new JspTagException(e.getMessage());
    }
    
    return SKIP_BODY;
  }
  
  private String parameter = "date";
  
  public void setParameter(String parameter) {
    this.parameter = parameter;
  }
  
  public String getParameter() {
    return parameter;
  }
}

接下來,我們創建標籤文件 MyTagLib.tld。標籤文件其實只是一個XML格式的說明文件,內容也很簡單。

MyTagLib.tld
<?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>

<tag>
  <name>demo</name>
  <tag-class>com.mycompany.DemoTag</tag-class>
  <body-content>empty</body-content>
  <attribute>
    <name>parameter</name>
    <required>false</required>
    <rtexprvalue>true</rtexprvalue>
  </attribute>
</tag>

</taglib>

在這個標籤文件中,我們將我們創建的標籤取名 demo,並聲明瞭類型和參數(parameter)。將該文件保存在 /WEB-INF 下面。
當然,我們還需要將我們自定義的標籤添加到 web.xml 中,否則還是無法使用。

web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

  <jsp-config>
    <taglib>
      <taglib-uri>/WEB-INF/MyTagLib</taglib-uri>
      <taglib-location>/WEB-INF/MyTagLib.tld</taglib-location>
    </taglib>
  </jsp-config>

</web-app>

你可能在別處看到過類似的聲明,只是沒有外面的 jsp-config,但是我們使用的是DTD 2.4,如果不加,Eclipse 會提示出錯。

到此爲止,我們的自定義標籤算是創建完畢。接下來,我們可以開始改寫那個JSP文件來分離代碼了。

Test.jsp
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
  <head>
    <title>My JSP 'Test.jsp' starting page</title>
  </head>
 
  <body>
    This is my JSP page. <br>
    Date : <mytag:demo parameter="date" /><br>
    File : <mytag:demo parameter="filename" />
  </body>
</html>

上面這些想必你已經很熟悉,我就不做多說了。

2. 內容標籤

創建過程和上面大抵相同,只是程序文件和配置內容有些差異。

DemoTag2.java
package com.mycompany;

import java.io.IOException;
import java.util.Date;

import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class DemoTag2 extends BodyTagSupport {
  
  public int doStartTag() throws JspTagException {    
    return EVAL_BODY_BUFFERED;
  }
  
  public int doEndTag() throws JspTagException {
    String body = this.getBodyContent().getString();
    HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
    
    body = body.replace("$date", new Date().toString());
    body = body.replace("$filename", request.getServletPath());
    
    try {
      pageContext.getOut().print(body);
    }
    catch (IOException e) {
      throw new JspTagException(e.getMessage());
    }
    
    return SKIP_BODY;
  }
}

我們將新的標籤 DemoTag2 加入到上面的標籤文件中。

MyTagLib.tld
<?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>

<tag>
  <name>demo</name>
  <tag-class>com.mycompany.DemoTag</tag-class>
  <body-content>empty</body-content>
  <attribute>
    <name>parameter</name>
    <required>false</required>
    <rtexprvalue>true</rtexprvalue>
  </attribute>
</tag>

<tag>
  <name>demo2</name>
  <tag-class>com.mycompany.DemoTag2</tag-class>
  <body-content>jsp</body-content>
</tag>

</taglib>

web.xml 文件無需修改。

看看同時使用兩種標籤的Test.jsp效果。

Test.jsp
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
  <head>
    <title>My JSP 'Test.jsp' starting page</title>
  </head>
 
  <body>
    This is my JSP page. <br>
    Date : <mytag:demo parameter="date" /><br>
    File : <mytag:demo parameter="filename" />

    <hr>

    <mytag:demo2>
    Date: $date<br>
    File: $filename
    </mytag:demo2>
  </body>
</html>

至此,兩種標籤方式都完成。
本文並沒有就相關技術細節做出說明,建議您看看Sun有關JSP自定義標籤的官方文檔。

無論是用自定義標籤,還是使用JavaBean,都沒有太大的區別,各人或者團隊可以根據自己的習慣使用。如果需要在獨立類庫中封裝一些供頁面使用的單元,自定義標籤應該更適合些。不過現在的IDE環境(MyEclipse)在編寫自定義標籤的時候可能有些不太舒服的情況,界面開發人員使用JavaBean方式可能更方便些,免得莫名其妙的提示干擾您的工作。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章