JSP自定義標籤庫

今天閒來無事,於是想起自己之前一直使用的標籤,無論是jstl,struts標籤還是springmvc標籤,使用起來都覺得很方便,於是自己想嘗試定義自己的標籤。

下面把今天自己的成果給大家分享下。要自定義標籤並使用標籤,需要以下幾步:

1、定義自己的標籤解析類,一般都是繼承TagSupport類(servlet-api.jar),Override該類的doStartTag()或者doEndTag()方法;

2、定義.tld文件;

3、在web.xml中聲明要使用的標籤(也可以不聲明);

4、在jsp中使用自定義的標籤。

下面通過一個例子來給大家詳細的講解:

1、定義自己的第一個標籤解析類:

package com.jrj.tag.example;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;
@SuppressWarnings("serial")
public class FirstTag extends TagSupport{
@Override
public int doEndTag() throws JspException {
try {
pageContext.getOut().write("hello world");
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return EVAL_PAGE;
}
}


2、在web-inf下新建一個tagFile文件夾,然後在文件中新建一個example.tld,內容如下:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
  "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<short-name>em</short-name>
<uri>http://com.jrj.tag/em</uri>
<display-name>Example</display-name>
  <description>em 1.0 library</description>
<tag>
<name>out</name>
<tag-class>com.jrj.tag.example.FirstTag</tag-class>
<body-content>JSP</body-content>
<description>writer out the cotentes</description>
</tag>
</taglib>


3、如果你想在web.xml文件中添加標籤的聲明,在web.xml中添加如下一段代碼:

<jsp-config>
    <taglib>
    <taglib-uri>/em</taglib-uri>
    <taglib-location>/WEB-INF/tagFile/example.tld</taglib-location>
    </taglib>
</jsp-config>

note:在今天講解的這些事例中,我沒有在web.xml中添加以上代碼,如果添加了那麼在後面jsp的引用標籤時會有所不同,希望大家注意!

4、在jsp中使用標籤,在使用之前需要先引用標籤:

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>
<%@ taglib uri="http://com.jrj.tag/em" prefix="em" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
</head>
<body>
<em:out></em:out>
</body>
</html>

下面我給大家擴展兩個其他的例子,一個是關於條件表達式,一個是關於迭代以及標籤的嵌套:

1、關於條件表達式,按照上面給大家講解的步驟:

1)、

package com.jrj.tag.example;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;
@SuppressWarnings("serial")
public class IfTag extends TagSupport{
private boolean condition;
@Override
public int doStartTag() throws JspException {
return condition?EVAL_BODY_INCLUDE:SKIP_BODY;
}
public boolean isCondition() {
return condition;
}
public void setCondition(boolean condition) {
this.condition = condition;
}
}


2)、在example.tld中添加如下內容:

<tag>
<name>if</name>
<tag-class>com.jrj.tag.example.IfTag</tag-class>
<body-content>JSP</body-content>
<description>If Condition</description>
<attribute>
<name>condition</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<type>boolean</type>
<description>condition</description>
</attribute>
</tag>


3)、jsp中使用,jsp修改完後變成如下:

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>
<%@ taglib uri="http://com.jrj.tag/em" prefix="em" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
</head>
<body>
<em:out></em:out>
<em:if condition="${1==1}">
if is validate
</em:if>
</body>
</html>


2、關於迭代及標籤的嵌套

1)、標籤解析類

package com.jrj.tag.example;
import java.util.Collection;
import java.util.Iterator;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
@SuppressWarnings("serial")
public class ForEachTag extends BodyTagSupport {
@SuppressWarnings("rawtypes")
private Collection items;
private String var;
@SuppressWarnings("rawtypes")
private Iterator it;
@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;
}
@SuppressWarnings("rawtypes")
public Collection getItems() {
return items;
}
@SuppressWarnings("rawtypes")
public void setItems(Collection items) {
this.items = items;
}
public String getVar() {
return var;
}
public void setVar(String var) {
this.var = var;
}
}

2)、在example.tld中添加如下內容:

<tag>
<name>foreach</name>
<tag-class>com.jrj.tag.example.ForEachTag</tag-class>
<body-content>JSP</body-content>
<description>ForEach The Collection</description>
<attribute>
<name>var</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<name>items</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>


3)、jsp中使用,jsp內容如下:

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>
<%@ taglib uri="http://com.jrj.tag/em" prefix="em" %>
<%@ page import="java.util.*" %>
<%
String path = request.getContextPath();
ArrayList<String> values = new ArrayList<String>();
values.add("zhouming");
values.add("xiaoshou");
values.add("minggou");
pageContext.setAttribute("values", values);
%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
</head>
<body>
<em:out></em:out>
<em:if condition="${1==1}">
if is validate
</em:if>
<em:foreach items="${pageScope.values}" var="val">
<em:out></em:out>
${val}
</em:foreach>
</body>
</html>


下面大家可能會對兩個方面有疑問:一是java類中每個方法的返回值的含義,二是tld文件中一些元素代表的意思。

1、在我們創建自定義的標籤時,在複寫父類的方法是,需要注意返回值的含義,不同的返回值代表不同的處理,下面是不同返回值所代表的含義:

EVAL_BODY_INCLUDE:把Body讀入存在的輸出流中,doStartTag()函數可用

EVAL_PAGE:繼續處理頁面,doEndTag()函數可用

SKIP_BODY:忽略對Body的處理,doStartTag()和doAfterBody()函數可用

SKIP_PAGE:忽略對餘下頁面的處理,doEndTag()函數可用

EVAL_BODY_TAG:已經廢止,由EVAL_BODY_BUFFERED取代

EVAL_BODY_BUFFERED:申請緩衝區,

由setBodyContent()函數得到的BodyContent對象來處理tag的body,

如果類實現了BodyTag,那麼doStartTag()可用,否則非法

2、如果我們需要對body裏面的內容進行循環處理,我們自定義的標籤解析類需要實現BodyTag接口或者繼承BodyTagSupport類

3、在我們自定義的tld文件中,需要注意attribute元素下的rtexprvalue(Run-time Expression value)元素的值,如果該值爲true,表示該屬性的值可以通過直接指定或者

通過表達式來指定,如果該值爲false,則表示該屬性的值必須直接指定。

以上就是自定義標籤的基本步驟,我今天在做的過程中借鑑了jstl的實現過程以及上網找了一些資料。我覺得這種方式效率很高,如果大家還有什麼更加高效的方法,

可以分享出來,大家一起進步!我們下期再見!


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