JSP自定義標籤開發

時間 2019-11-09

標籤 jsp 自定義標籤開發欄目 JSP 简体版

原文原文鏈接

JSP自定義標籤開發入門

通常狀況下開發jsp自定義標籤須要引用如下兩個包 java

import javax.servlet.jsp.*; web

import javax.servlet.jsp.tagext.*; 緩存

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

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

效果圖： jsp

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

假設咱們有一個UserInfo的javabean，那麼在JSP頁面使用此標籤只需調用此標籤便可函數

測試

<% ui

UserInfo user = new UserInfo(); this

user.setUserName("Xuwei");

user.setAge(33);

user.setEmail("test@test.test");

pageContext.setAttribute("userinfo", user);

<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>

<required>false</required>

</attribute>

</tag>

</taglib>

3 配置web.xml

<jsp-config>

<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>

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

<!—設定屬性(若是有的話) -->

<!—指定標籤名 -->

<!—是不是必須，若是非必須沒設置則爲空 -->

<required>false</required>

</attribute>

</tag>

Web.xml文件說明：

<jsp-config>

<!--

標籤庫的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頁面使用此自定義標籤：

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);

<tr>

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

<td>Email</td>

</tr>

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

<tr>

<td>${item.userName }</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>

<name>items</name>

<required>false</required>

</attribute>

</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接口的說明