現在的位置: 首頁 > 綜合 > 正文

自定義struts標籤

2013年08月14日 ⁄ 綜合 ⁄ 共 4335字 ⁄ 字型大小 評論關閉

自定義標籤必須實現下面三個介面中的一個:Tag、IterationTag、BodyTag
1.Tag
  如果要實現這個介面,可以通過擴展TagSupport這個類,來寫自己需要的方法,而不需要把Tag介面中的所有方法實現。
  Tag介面的方法:
 doStartTag()、doEndTag()、getParent()、setParent()、release()、setPageContext()
  在Tag類代碼中不能像jsp一樣,直接使用out隱含對象,他有一個對象可以使用pageContext,通過它的getOut()方法可以得到out對象。在標籤內部,訪問任何的隱含對象,都是通過調用pageContext的set方法。

2.IterationTag
  IterationTag介面與Tag介面類似,用於當一個自定義標籤需要重複計算它的代碼體的情況下。它擴展Tag介面並實現了一個新的方法doAfterBody()來實現循環,這個方法只有從doStartTag()返回EVAL_BODY_INCLUDE時才被調用。在執行doAfterBody()方法時,如果返回的是EVAL_BODY_AGAIN,那麼將再次執行doAfterBody()方法,直到doAfterBody()返回的是SKIP_BODY或者EVAL_BODY_INCLUDE。

3.BodyTag
  BodyTag介面擴展了IterationTag並提供了對代碼體內容進行操作的功能。就是在計算代碼體的時候可以對已經形成的代碼體進行修改。BodyContent對象就是用來保存對自定義標籤體計算的結果。它有一個新方法doInitBody(),這個方法只有在doStartTag()方法返回EVAL_BODY_BUFFERED時才調用,此時它將創建一個BodyContent對象保存結果。

擴展自定義標籤:
添加屬性
 首先要在tld文件中加入一個屬性元素,然後在java文件中需要定義這個屬性以及它的的setter方法。屬性<attribute>元素有四個子元素分別是<name>、<required>、<rtexprvalue>、<description>,這裡<rtexprvalue>表示的是屬性是否接受scriptlet表達式的計算結果,默認情況下為false,即只能接受靜態值。

添加變數
 可以在tld文件中給自定義標籤加入一個<variable>元素,它的子元素包括<name-given>表示保存變數的名字,<variable-class>表示變數的java類型,<declared>用boolean表示這個變數是否為新的,<scope>表示變數的使用範圍(AT_BEGIN表示從起始標籤起,AT_END表示從終止標籤後,NESTED表示起始標籤和終止標籤之間)。定義了變數之後,需要在java文件中把這個變數用pageContext.setAttribute("",object);這裡key值應該就是變數對外的名字。

使用TagExtraInfo(TEI)類
 這個對象中有兩類對象可以使用,TagData(保存標籤屬性的信息)、VariableInfo(描述代碼變數)
 一段TagExtraInfo類代碼實例:
  public VariableInfo[] getVariableInfo(TagData data) {
    String variableName = data.getAttributeString("name");
    VariableInfo vi =
      new VariableInfo(variableName,"String []", true, VariableInfo.AT_END);
    VariableInfo[] tagVariables = new VariableInfo[1];
    tagVariables[0] = vi;
    return tagVariables;
  }
 可以通過TagData類的getAttributeString方法得到某個屬性的值,還有另外一個方法getAttribute也是得到某個屬性的值不過返回的是一個對象。而getVariableInfo方法必須返回一個VariableInfo數組。除此之外,還需要在tld中的元素定義<tag-class>後加入一個<tei-class>元素,說明TEI類的全稱。

pageContext對象中含有的方法包括:getOut();getPage();getRequest();getResponse();getServletConfig();getServletContext();getSession();

Tag介面中的返回常數意義:
EVAL_BODY_INCLUDE:告訴伺服器正文的內容,並把這些內容送入輸出流
SKIP_BODY:告訴伺服器不要處理正文內容
EVAL_PAGE:讓伺服器繼續執行頁面
SKIP_PAGE:讓伺服器不要處理剩餘的頁面
EVAL_BODY_AGAIN:讓伺服器繼續處理正文內容,只有doAfterBody方法可以返回
EVAL_BODY_BUFFERED:BodyTag介面的欄位,在doStartTag()返回
EVAL_BODY_INCLUDE、SKIP_BODY一般由doStartTag()返回,而EVAL_PAPGE、SKIP_PAGE由doEndTag()返回。

在調用doStartTag()方法之前其實標記還調用了其他兩個方法:setPageContext()和setParent();所以在後面的方法中可以使用pageContext和parent對象,如果需要的話。

讓自定義標籤在頁面中創建對象時必須使用一個標準的JSP對象TagExtraInfo類,它可以創建腳本變數還可以在編譯的時候對標籤進行檢驗,TEI類僅可以生成由setAttribute方法存儲在PageContext對象中的變數,而並不是單獨生成變數。

通過TEI類定義腳本變數可以讓使用者自己定義在頁面中使用對象的名稱。
除了使用TEI類方法之外,還可以簡單的在TLD中定義一個<variable>對象來使用自定義對象,用法如下:
<variable>
 <name-from-attribute>name</name-from-attribute>
 <variable-class>String []</variable-class>
 <declare>true</declare>
 <scope>AT_END</scope>
</variable>
對於variable的子元素,<name-from-attribute>指的是創建的變數名稱從屬性name中來取得,當然也可以通過<name-given>元素來限制變數的名稱。注意這兩個元素是互斥的。

一個擴展BodyTagSupport的自定義標記的生命周期如下:
1.創建標記
2.調用Setter方法
3.調用doStartTag()方法
4.調用setBodyContent()方法
5.調用InitBody()方法
6.處理標記的Body
7.doAfterBody();根據返回值,如果為EVAL_BODY_AGAIN,繼續執行6,如果不是,執行8
8.調用doEndTag()方法
9.判斷標記是否需要重用,如果要,執行4;否則執行release()方法。

TagSupport類的方法findAncestorWithClass()方法可以用來查找指定的父類,它有兩個參數一個為本身的類名,還有一個就是要查找的父類的名稱,如果沒有返回null;例如ParentTag parent = (ParentTag) this.findAncestorWithClass(this,ParentTag.class);

自定義標記的驗證方法:
JSP1.1
 TEI類可以在編譯時刻檢驗自己的標記,這個類中有一個isValid()方法,如果TLD中為這個標記定義了這個TEI類,那麼網頁在編譯的時候將會調用這個方法,並且會傳入一個包含屬性具體內容的參數TagData。(在JSP1.2中同樣有效)
JSP1.2
 JSP1.2中引入一個新的標記檢驗方法,定義了一個新類TagLibraryValidator,並且可以由此派生出檢驗標誌的類,大多數情況下僅使用這個類的validate()方法,它有三個參數:prefix(在taglib指令中定義的前綴);uri(TLD文件中的URI);page(JSP頁的PageData XML版本),validate()方法返回值為null時表示驗證成功,否則返回的String類型將是一個錯誤信息。
當validator在TLD文件中定義時,它應該放在<tag>元素定義的外面,因為它是用來處理驗證標記庫中的所有標記的。
<validator><validator-class></validator-class></validator>。

比較JSP1.2和JSP1.1中的方法:
TagLibraryValidator比TEI類更全面,可以用來檢測整個網頁,而不僅僅是標記本身,可以用來處理標記間的合作,並且這種方法可以用來通知程序員錯誤出在哪裡,但是同時它的方法也比TEI類的方法複雜多了,因為它需要遍歷整個XML版本的JSP(完成getAttributeValue方法)。

JSP1.2中的TryCatchFinally介面:
這個介面主要是用於當自定義標記出現異常時釋放自定義標記中的資源使用的,它定義了兩個方法:
public void doCatch(Throwable t);(當doStartTag,doInitBody,doAfterBody,doEndTag方法出現異常時會調用這個方法)
piblic void doFinally();(當doEndTag被調用後,無論是否出現異常都會調用這個方法,就像程序中的finally塊,可以用來釋放資源)

在JSP1.2中,可以通過在tld文件中加入一個元素<uri></uri>來指定自己的在taglib指令中使用的名稱,然後把這個tld文件與Manifest.mf一起放在META-INF目錄中,那麼在頁面中就可以非常方便地導入這些tld。

編寫自定義標記的原則:
1.使用腳本變數(允許設計者為腳本變數起名、將腳本變數的數量減到最小、使用一個組合腳本對象和存取函數即使用JavaBean)
2.當設計相互協作的標記時應該盡量避免創建一套新的語言,應當盡量使用腳本變數
3.編寫代碼而不是內容,不要在自定義標記中產生HTML,這樣會失去通用性

抱歉!評論已關閉.