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("test@test.test");

    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>

 

 

目標2:自訂一個類似於Asp.Net中的Reapter控制項的標籤

：

 

在jsp頁面使用此自訂標籤：

 

<!-- 建立需要展現javabean（UserInfo）集合的執行個體（用於測試資料） -->

<%

    List<UserInfo> users = new ArrayList<UserInfo>();   

    users.add(new UserInfo("Zhangsan", 12, "Zhangsan@163.com"));

    users.add(new UserInfo("Lisi", 22, "Lisi@sina.com"));

    users.add(new UserInfo("Wangwu", 33, "Wangwu@qq.com"));

    pageContext.setAttribute("users", users);

%>

 

<!-- 給標籤綁定資料來源  -->

<table width='500px' border='1' align='center'>

    <tr>

        <td width='20%'>UserName</td>

        <td width='20%'>Age</td>

        <td>Email</td>

    </tr>

    <cc:repeater var="item" items="${pageScope.users }">

        <tr>

            <td>${item.userName }</td>

            <td>${item.age }</td>

            <td>${item.email }</td>

        </tr>

    </cc:repeater>

</table>

 

開發步驟：

 

要完成此控制項我們需要實現一個迭代介面，即IterationTag，由於TagSupport同樣實現了此介面，所以我們繼承此類

 

1 建立自訂標籤類

 

public class Repeater extends TagSupport {

    private Collection items;

    private Iterator it;

    private String var;

 

    @Override

    public int doStartTag() throws JspException {

        if(items == null || items.size() == 0) return SKIP_BODY;

        it = items.iterator();  

        if(it.hasNext()) {

            pageContext.setAttribute(var, it.next());

        }

        return EVAL_BODY_INCLUDE;

    }

   

    @Override

    public int doAfterBody() throws JspException {

        if(it.hasNext()) {

            pageContext.setAttribute(var, it.next());

            return EVAL_BODY_AGAIN;

        }

        return SKIP_BODY;

    }

   

    @Override

    public int doEndTag() throws JspException {

        return EVAL_PAGE;

    }

   

    public void setItems(Collection items) {

        this.items = items;

    }

   

    public void setVar(String var) {

        this.var = var;

    }

}

 

2在Web-Inf建立標籤庫描述檔案.tdl(Tag Library Description)

由於目標1種已經建立了此檔案，我們只需增加此標籤的配置即可

 

<tag>

    <name>repeater</name>

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

    <body-content>jsp</body-content>

    <attribute>

        <name>items</name>

        <required>false</required>

        <rtexprvalue>true</rtexprvalue>

    </attribute>

    <attribute>

        <name>var</name>

        <required>true</required>

        <rtexprvalue>true</rtexprvalue>

    </attribute>

 </tag>

 

3 配置web.xml （目標1中已完成，無需修改）

 

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

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

 

5 使用（參照上面的使用步驟）

 

標籤類說明：

我們用到了迭代介面，以下是容器處理此介面的流程

 

 

作為目標1中的補充： 在doAfterBody()如果傳回值是EVAL_BODY_AGAIN那麼將重新執行此方法

 

目標3:使用BodyTagSupport

此目標並不會使用實際例子進行顯示，主要是說明為什麼，什麼情況下需要使用到BodyTag介面或者BodyTagSupport類？

如果我們需要在<test>  ….   </test>之間的標籤體的頭部和尾部加上一些標記或者是其他處理，一般的處理方法是在doStartTag和doEndTag方法中進行， 但是如果是個迭代標籤，標籤體的每段內容在迴圈輸出時每次都需要在頭部和尾部加上一些標記，我們使用BodyTagSupport就很方便了，

 

此介面在doStartTag()方法傳回值多了一個EVAL_BODY_BUFFERED,它將對主體進行計算，並輸出到緩衝區(註：此處是緩衝區並非直接輸出到用戶端，需要我們手動（this.bodyContent.getEnclosingWriter().write(this.bodyContent.getString());）進行輸出用戶端的調用，否則主體內容不會進行顯示)

 

標籤類說明：

關於BodyTagSupport介面的說明

 

目標4:自訂的函數庫

1 建立函數庫類

 

public class MyFunctions {

    public static String formatMyName(String name) {

       return "your name is " + name;

    }

    public static int add(int a, int b) {

       return a+b;

    }

}

 

2 在TLD檔案中配置 (引用於目標1中的tld檔案)

<function>

    <name>formatMyName</name>

    <function-class>com.taglib.MyFunctions</function-class>

    <function-signature>java.lang.String formatMyName(java.lang.String)</function-signature>

 </function>

 

<function>

    <name>add</name>

    <function-class>com.taglib.MyFunctions</function-class>

    <function-signature>java.lang.String add(int, int)</function-signature>

 </function>

 

3 JSP中調用

 

${cc:formatMyName("wangfei") }

${cc:add(12, 34) }