JSP自定義標籤開發入門

JSP自定義標籤開發入門

一般情況下開發jsp自定義標籤需要引用以下兩個包

 

import javax.servlet.jsp.*;

import javax.servlet.jsp.tagext.*;

 

首先我們需要大致瞭解開發自定義標籤所涉及到的接口與類的層次結構(其中SimpleTag接口與SimpleTagSupport類是JSP2.0中新引入的)。

 

目標1:自定義一個用表格顯示用戶信息的簡單標籤

 

效果圖:

在jsp頁面使用此自定義標籤:

 

假設我們有一個UserInfo的javabean,那麼在JSP頁面使用此標籤只需調用此標籤即可

 

<!-- 創建需要展現UserInfo的實例(用於測試數據) -->

    <%

    UserInfo user = new UserInfo();

    user.setUserName("Xuwei");

    user.setAge(33);

    user.setEmail("[email protected]");

    pageContext.setAttribute("userinfo", user);  

    %>

 

    <!-- 給標籤設置user屬性綁定要展現的UserInfo對象  -->

    <cc:showUserInfo user="${pageScope.userinfo }" />

 

開發步驟:

 

簡單標籤的開發我們只要實現Tag接口即可,爲了簡單起見可以直接繼承實現了此接口的TagSupport類

 

1 創建自定義標籤類

 

public class UserInfoTag extends TagSupport {

   

    private UserInfo user;

 

    @Override

    public int doStartTag() throws JspException {

        try {

            JspWriter out = this.pageContext.getOut();

            if(user == null) {

                out.println("No UserInfo Found...");

                return SKIP_BODY;

            }

            out.println("<table width='500px' border='1' align='center'>");

            out.println("<tr>");

            out.println("<td width='20%'>Username:</td>");

            out.println("<td>" + user.getUserName() + "</td>");

            out.println("</tr>");

            out.println("<tr>");

            out.println("<td>Age:</td>");

            out.println("<td>" + user.getAge() + "</td>");

            out.println("</tr>");

            out.println("<tr>");

            out.println("<td>Email:</td>");

            out.println("<td>" + user.getEmail() + "</td>");

            out.println("</tr>");

            out.println("</table>");

        } catch(Exception e) {

            throw new JspException(e.getMessage());

        }

        return SKIP_BODY;

    }

   

    @Override

    public int doEndTag() throws JspException {

        return EVAL_PAGE;

    }

 

    @Override

    public void release() {

        super.release();

        this.user = null;

    }

   

    //getter and setters

    public UserInfo getUser() {

        return user;

    }

    public void setUser(UserInfo user) {

        this.user = user;

    }

}

 

2 在Web-Inf創建標籤庫描述文件.tdl(Tag Library Description)

 

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

<taglib version="2.0" xmlns="http://java.sun.com/xml/ns/j2ee"

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee web-jsptaglibrary_2_0.xsd">

<tlib-version>1.0</tlib-version>

<jsp-version>2.0</jsp-version>

<short-name>cc</short-name>

<uri>/mytaglib</uri>

<tag>

    <name>showUserInfo</name>

    <tag-class>com.mytags.UserInfoTag</tag-class>

    <body-content>empty</body-content>

    <attribute>

        <name>user</name>

         <required>false</required>

         <rtexprvalue>true</rtexprvalue>

    </attribute>

 </tag>

</taglib>

 

3 配置web.xml

 

<jsp-config>

    <taglib>

        <taglib-uri>/mytaglib</taglib-uri>

        <taglib-location>/WEB-INF/mytaglib.tld</taglib-location>

    </taglib>

  </jsp-config>

 

4 在需要使用此標籤的jsp頁面頭部引入

 

<%@ taglib uri="/mytaglib" prefix="cc"%>

 

5 使用(參照上面的使用步驟)

 

此致,一個簡單的JSP標籤開發完成

 

標籤類說明:

我們創建的UserInfoTag類繼承了TagSupport類,而它又實現了Tag接口,Tag接口的生命週期由其所在的容器控制,如下圖:

 

setPageContext() 將所在jsp頁面的pageContext注入進來,目的是爲了在後面的方法中可以訪問到jsp頁面對象的pageContext屬性

 

setParent()       設置此標籤的父標籤

 

setAttribute()   將標籤中的屬性注入到此class的屬性,不需要自己實現但要提供屬性的get與set方法

 

doStartTag()      在開始標籤屬性設置後調用,如果返回SKIP_BODY則忽略標籤之中的內容,如果返回EVAL_BODY_INCLUDE則將標籤體的內容進行輸出

 

doEndTag()         在結束標籤之前調用,返回SKIP_PAGE跳過整個jsp頁面後面的輸出,返回EVAL_PAGE執行頁面餘下部分

 

release()          生命週期結束時調用

 

特別說明:在tomcat4.1之後的版本中默認開啓了標籤緩衝池(websphere和weblogic並不會這麼做),所以執行完標籤後並不會執行release()方法(_jspDestroy()時才釋放),也就是說同一個jsp頁面自定義標籤不管使用多少次只會存在一個實例,但也並不是每一個標籤都會爲其創建一個緩衝池,要根據參數來判斷,例如:

<cc:UserInfoTag user=”…” />

<cc:UserInfoTag />

上面例子中由於參數不同就會創建兩個標籤緩衝池。

 

這個問題可以通過設定tomcat的配置文件加以解決:
在%tomcat%\conf\web.xml加入enablePooling參數,並設置爲false(不緩存自定義標籤)。

<init-param>
  <param-name>enablePooling</param-name>
  <param-value>false</param-value>
</init-param>
 

清空%tomcat%\conf\目錄

-------------------------------------------------------------------------------------------------------------------------------

TagSupport類已經爲我們實現並擴展了一些方法(比如在上述方法中我們可以直接使用pageContext對象,調用父標籤getParent()等),所以一般情況下我們只需重寫doStartTag(),doEndTag() 即可

 

TLD文件說明:

<!--版本號-->

<tlib-version>1.0</tlib-version>

<jsp-version>2.0</jsp-version>

<short-name>cc</short-name>

<tag>

<!—指定標籤名 -->

    <name>showUserInfo</name>

<!—指定標籤類文件的全路徑 -->

    <tag-class>com.mytags.UserInfoTag</tag-class>

<!--如果不需要標籤體則設置empty,反之設定jsp -->

    <body-content>empty</body-content>

<!—設定屬性(如果有的話) -->

    <attribute>

<!—指定標籤名 -->

       <name>user</name>

<!—是否是必須,如果非必須沒設置則爲空 -->

        <required>false</required>

<rtexprvalue>true</rtexprvalue><!—是否可在屬性中使用表達式 -->

    </attribute>

</tag>

 

 

Web.xml文件說明:

<jsp-config>

    <taglib>

<!--

標籤庫的uri路徑

即jsp頭文件中聲明<%@ taglib uri="/mytaglib" prefix="cc"%>

的uri

 -->

        <taglib-uri>/mytaglib</taglib-uri>

<!—tld文件所在的位置-->

        <taglib-location>/WEB-INF/mytaglib.tld</taglib-location>

    </taglib>

  </jsp-config>

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章