JAVA WEB學習筆記(五)－自訂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.<% @ taglib prefix=”someprefix”　uri=”/sometaglib” %>
  為了使到JSP容器能夠使用標籤庫中的自訂行為，必須滿足以下兩個條件：
   1.從一個指定的標籤庫中識別出代表這種自訂行為的標籤
   2.找到實現這些自訂行為的具體類

   第一個必需條件－找出一個自訂行為屬於那個標籤庫－是由標籤指令的首碼(Taglib  Directive's Prefix)屬性完成，所以在同一個頁面中使用相同首碼的元素都屬於這個標籤庫。每個標籤庫都定義了一個預設的首碼，用在標籤庫的文檔中或者頁面中插入自訂標籤。所以，你可以使用除了諸如jsp,jspx,java,servlet,sun,sunw(它們都是在JSP白皮書中指定的保留字)之類的首碼。
　
　uri屬性滿足了以上的第二個要求。為每個自訂行為找到對應的類。這個uri包含了一個字串，容器用它來定位TLD檔案。在TLD檔案中可以找到標籤庫中所有標籤處理類的名稱

2.<someprefix:sometag key=”somevalue”/>
　當web應用程式啟動時，容器從WEB-INF檔案夾的目錄結構的META-INF搜尋所有以.tld結尾的檔案。也就是說它們會定位所有的TLD檔案。對於每個TLD檔案，容器會先擷取標籤庫的URI，然後為每個TLD檔案和對應的URI建立映射關係。
在JSP頁面中，我們僅需通過使用帶有URI屬性值的標籤庫指令來和具體的標籤庫匹配
*************************************************************************************

三、自訂JSP標籤的處理過程：
*************************************************************************************
1．在JSP中引入標籤庫：<% @ taglib prefix=”taglibprefix” uri=”tagliburi” %>
2．在JSP中使用標籤庫標籤：<prefix : tagname attribute=”tagattribute”>
3．Web容器根據第二個步驟中的prefix，獲得第一個步驟中聲明的taglib的uri屬性值
4．Web容器根據uri屬性在web.xml找到對應的<taglib>元素
5．從<taglib>元素中獲得對應的<taglib-location>元素的值
6．Web容器根據<taglib-location>元素的值從WEB-INF/目錄下找到對應的.tld檔案
7．從.tld檔案中找到與tagname對應的<tag>元素
8．湊<tag>元素中獲得對應的<tag-class>元素的值
9．Web容器根據<tag-class>元素的值建立相應的tag handle class的執行個體
10. Web容器調用這個執行個體的doStartTag/doEndTag方法完成相應的處理
*************************************************************************************

四、建立和使用一個Tag Library的基本步驟：
*************************************************************************************
1.建立標籤的處理類(Tag Handler Class)
2.建立標籤庫描述檔案(Tag Library Descrptor File)
3.在web.xml檔案中配置<tag>元素
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：表示<prefix:someTag>…</prefix:someTag>之間的內容被忽略
  B.Tag.EVAL_BODY_INCLUDE：表示標籤之間的內容被正常執行

3.doEndTag：但JSP容器遇到自訂標籤的結束標誌，就會調用doEndTag()方法。doEndTag 
  ()方法也返回一個整數值，用來決定程式後續流程。
   A.Tag.SKIP_PAGE：表示立刻停止執行網頁，網頁上未處理的靜態內容和JSP程式均被
     忽。略任何已有的輸出內容立刻返回到客戶的瀏覽器上。
   B.Tag_EVAL_PAGE：表示按照正常的流程繼續執行JSP網頁
*************************************************************************************

七、使用者自訂的標籤屬性：
*************************************************************************************
如果在標籤中還包含了自訂的屬性，例如：
<prefix:Mytag attribute1="value1">
    ...
</prefix:Mytag>
那麼在標籤處理類中應該將這個屬性作為成員變數，並且分別提供設定和讀取屬性的方法。
*************************************************************************************

八、建立標籤處理類的步驟：
*************************************************************************************
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屬性：
<servlet>
<servlet-name>someclass</servlet-name>
<servlet-class>somepackage.SomeClass</servlet-clas
<load-on-startup>1</load-on-startup>
</servlet>
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.<taglib>：標籤庫元素
    B.<tag>：標籤元素
    C.<attribute>：標籤屬性元素

2.標籤庫元素<taglib>用來設定標籤庫的相關資訊，它的常用屬性有：
    A.shortname：    指定Tag Library預設的首碼名(prefix)
    B.uri：            設定Tag Library的惟一訪問表示符

3.標籤元素<tag>用來定義一個標籤，它的常見屬性有：
    A.name：        設定Tag的名字
    B.tagclass：    設定Tag的處理類
    C.bodycontent：    設定標籤的主體(body)內容
            1).empty：表示標籤中沒有body
            2).JSP：表示標籤的body中可以加入JSP程式碼
            3).tagdependent：表示標籤中的內容由標籤自己去處理

4.標籤屬性元素<attribute>用來定義標籤的屬性，它的常見屬性有：
    A.name：屬性名稱
    B.required：屬性是否必需的，預設為false
    C.rtexprvalue：屬性值是否可以為request-time運算式，也就是類似於<%=…%>的運算式
*************************************************************************************

十六、在Web應用中使用標籤：
*************************************************************************************
1.如果Web應用中用到了自訂JSP標籤，則必須在web.xml檔案中加入<taglib>元素，它用於聲明所引用的標籤所在的標籤庫
    <taglib>
        <taglib-uri>/sometaglib</taglib-uri>
        <taglib-location>/WEB-INF/someTLD.tld</taglib-location>
    </taglib>

2.<taglib-uri>：設定Tag Library的惟一標示符，在Web應用中將根據它來引用Tag Libray
3.<taglib-location>：指定和Tag Library對應的TLD檔案的位置
4.在JSP檔案中需要加入<% @ taglib% >指令來聲明對標籤庫的引用。例如：
<% @ taglib prefix = “somePrefix” uri = "/someuri" %>

5.prefix表示在JSP網頁中引用這個標籤庫的標籤時的首碼，uri用來指定Tag Library的標識符，它必須和web.xml中的<taglib-uri>屬性保持一致。
*************************************************************************************