熱點推薦:
您现在的位置: 電腦知識網 >> 編程 >> Java編程 >> Java開源技術 >> 正文

Struts:自定義taglib的開發

2013-11-23 20:09:18  來源: Java開源技術 

  自定義標簽必須實現下面三個接口中的一個TagIterationTagBodyTag

  Tag

  如果要實現這個接口可以通過擴展TagSupport這個類來寫自己需要的方法而不需要把Tag接口中的所有方法實現

  Tag接口的方法doStartTag()doEndTag()getParent()setParent()release()setPageContext()

  在Tag類代碼中不能像jsp一樣直接使用out隱含對象他有一個對象可以使用pageContext通過它的getOut()方法可以得到out對象在標簽內部訪問任何的隱含對象都是通過調用pageContext的set方法

  IterationTag

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

  BodyTag

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

  擴展自定義標簽

  添加屬性

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

  添加變量

  可以在tld文件中給自定義標簽加入一個<variable>元素它的子元素包括<namegiven>表示保存變量的名字<variableclass>表示變量的java類型<declared>用boolean表示這個變量是否為新的<scope>表示變量的使用范圍(AT_BEGIN表示從起始標簽起AT_END表示從終止標簽後NESTED表示起始標簽和終止標簽之間)定義了變量之後需要在java文件中把這個變量用pageContextsetAttribute(object)這裡key值應該就是變量對外的名字

  使用TagExtraInfo(TEI)類

  這個對象中有兩類對象可以使用TagData(保存標簽屬性的信息)VariableInfo(描述代碼變量)

  一段TagExtraInfo類代碼實例

     public VariableInfo[] getVariableInfo(TagData data) {
    String variableName = datagetAttributeString(name);
    VariableInfo vi =
      new VariableInfo(variableNameString [] true VariableInfoAT_END);
    VariableInfo[] tagVariables = new VariableInfo[];
    tagVariables[] = vi;
    return tagVariables;
  }

  可以通過TagData類的getAttributeString方法得到某個屬性的值還有另外一個方法getAttribute也是得到某個屬性的值不過返回的是一個對象而getVariableInfo方法必須返回一個VariableInfo數組除此之外還需要在tld中的元素定義<tagclass>後加入一個<teiclass>元素說明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_BUFFEREDBodyTag接口的字段在doStartTag()返回

  EVAL_BODY_INCLUDESKIP_BODY一般由doStartTag()返回而EVAL_PAPGESKIP_PAGE由doEndTag()返回

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

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

  通過TEI類定義腳本變量可以讓使用者自己定義在頁面中使用對象的名稱

  除了使用TEI類方法之外還可以簡單的在TLD中定義一個<variable>對象來使用自定義對象用法如下

   <variable>
 <namefromattribute>name</namefromattribute>
 <variableclass>String []</variableclass>
 <declare>true</declare>
 <scope>AT_END</scope>
</variable>

  對於variable的子元素<namefromattribute>指的是創建的變量名稱從屬性name中來取得當然也可以通過<namegiven>元素來限制變量的名稱注意這兩個元素是互斥的

  一個擴展BodyTagSupport的自定義標記的生命周期如下

  創建標記
    調用Setter方法
    調用doStartTag()方法
    調用setBodyContent()方法
    調用InitBody()方法
    處理標記的Body
    doAfterBody()根據返回值如果為EVAL_BODY_AGAIN繼續執行如果不是執行
    調用doEndTag()方法
    判斷標記是否需要重用如果要執行否則執行release()方法

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

  自定義標記的驗證方法JSP TEI類可以在編譯時刻檢驗自己的標記這個類中有一個isValid()方法如果TLD中為這個標記定義了這個TEI類那麼網頁在編譯的時候將會調用這個方法並且會傳入一個包含屬性具體內容的參數TagData(在JSP中同樣有效)

  JSP JSP中引入一個新的標記檢驗方法定義了一個新類TagLibraryValidator並且可以由此派生出檢驗標志的類大多數情況下僅使用這個類的validate()方法它有三個參數prefix(在taglib指令中定義的前綴)uri(TLD文件中的URI)page(JSP頁的PageData XML版本)validate()方法返回值為null時表示驗證成功否則返回的String類型將是一個錯誤信息

  當validator在TLD文件中定義時它應該放在<tag>元素定義的外面因為它是用來處理驗證標記庫中的所有標記的

  <validator><validatorclass></validatorclass></validator>

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

  JSP中的TryCatchFinally接口這個接口主要是用於當自定義標記出現異常時釋放自定義標記中的資源使用的它定義了兩個方法public void doCatch(Throwable t)(當doStartTagdoInitBodydoAfterBodydoEndTag方法出現異常時會調用這個方法)

  piblic void doFinally()(當doEndTag被調用後無論是否出現異常都會調用這個方法就像程序中的finally塊可以用來釋放資源)

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

  編寫自定義標記的原則

  使用腳本變量(允許設計者為腳本變量起名將腳本變量的數量減到最小使用一個組合腳本對象和存取函數即使用JavaBean)

  當設計相互協作的標記時應該盡量避免創建一套新的語言應當盡量使用腳本變量編寫代碼而不是內容不要在自定義標記中產生HTML這樣會失去通用性


From:http://tw.wingwit.com/Article/program/Java/ky/201311/28027.html
    推薦文章
    Copyright © 2005-2013 電腦知識網 Computer Knowledge   All rights reserved.