jsp中的自定義標籤

時間 2019-11-07

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

原文原文鏈接

（jsp 1.0規範）html

一，自定義標籤主要用於移除Jsp頁面中的java代碼；java

使用自定義標籤移除jsp頁面中的java代碼，只須要完成如下兩個步驟：web

1，編寫一個實現Tag接口的Java類(標籤處理器類)。express

2，編寫標籤庫描述符（tld）文件，在tld文件中對標籤處理器類描述成一個標籤。（.tld文件放在WEB-INF目錄下面）瀏覽器

二，TAG接口的執行流程；
服務器

JSP引擎將遇到自定義標籤時，首先建立標籤處理器類的實例對象，而後按照JSP規範定義的通訊規則依次調用它的方法。app

1，‍public void setPageContext(PageContext pc)；less

JSP引擎實例化標籤處理器後，將調用setPageContext方法將JSP頁面的pageContext對象傳遞給標籤處理器，標籤處理器之後能夠經過這個pageContext對象與JSP頁面進行通訊。jsp

2，public void setParent(Tag t)；ide

setPageContext方法執行完後，WEB容器接着調用的setParent方法將當前標籤的父標籤傳遞給當前標籤處理器,若是當前標籤沒有父標籤，則傳遞給setParent方法的參數值爲null。

3，public int doStartTag()；

調用了setPageContext方法和setParent方法以後，WEB容器執行到自定義標籤的開始標記時，就會調用標籤處

理器的doStartTag方法。

4，public int doEndTag()；

WEB容器執行完自定義標籤的標籤體後，就會接着去執行自定義標籤的結束標記，此時，WEB容器會去調用標

籤處理器的doEndTag方法。

5，public void release()；

一般WEB容器執行完自定義標籤後，標籤處理器會駐留在內存中，爲其它請求服務器，直至中止web應用

時，web容器纔會調用release方法。

代碼：

/*
 * 標籤處理器類   頁面內容不輸出
 */
public class TagDemo1 extends TagSupport {//繼承自TAG接口的子類

	@Override
	public int doStartTag() throws JspException {
		
		return Tag.SKIP_BODY;//頁面內容不輸出
	}
}


/*
 * 頁面內容輸出  標籤處理器類
 */
public class TagDemo2 extends TagSupport {

	@Override
	public int doEndTag() throws JspException {
		return Tag.EVAL_PAGE;
	
}


/*
 * 頁面內容重複輸出
 */
public class TagDemo3 extends TagSupport {

	int i = 5;
	
	@Override
	public int doStartTag() throws JspException {
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		i--;
		if(i>0){
			return EVAL_BODY_AGAIN;
		}else{
			return SKIP_BODY;
		}
		
	}
	
}


/*
 * 改變頁面內容
 */
public class TagDemo4 extends BodyTagSupport {

	@Override
	public int doStartTag() throws JspException {
		// TODO Auto-generated method stub
		return EVAL_BODY_BUFFERED;
	}
	
	@Override
	public int doEndTag() throws JspException {
		BodyContent bc = this.bodyContent;
		String content = bc.getString();
		content = content.toUpperCase();
		
		try {
			this.pageContext.getOut().write(content);
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
		
		return EVAL_PAGE;
	}
	
}

tld描述文件

//tld文件描述
<taglib 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 http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
    version="2.0">
    
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>SimpleTagLibrary</short-name>
    <uri>/yujian</uri>
    
     <tag>
           <name>demo1</name>
           <tag-class>cn.yujian.web.tag.TagDemo1</tag-class>
	   <body-content>JSP</body-content>
    </tag>
    

    <tag>
        <name>demo2</name>
	<tag-class>cn.yujian.web.tag.TagDemo2</tag-class>
	<body-content>empty</body-content>
    </tag>
    
     <tag>
        <name>demo3</name>
	<tag-class>cn.yujian.web.tag.TagDemo3</tag-class>
	<body-content>JSP</body-content>
    </tag>
    
    
    <tag>
        <name>demo4</name>
	<tag-class>cn.yujian.web.tag.TagDemo4</tag-class>
	<body-content>JSP</body-content>
    </tag>
    
</taglib>

jsp頁面：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用標籤控制頁面內容是否輸出</title>
  </head>
  
  <body>
   <flx:demo1>
   	aaaaaaaaaaa
   </flx:demo1>
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<flx:demo2/>
<html>
  <head>
    <title>用標籤能夠控制整個頁面是否執行</title>
  </head>
  
  <body>
  aaaaaaaaaaaaaaaaaaaaa 
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<flx:demo2/>
<html>
  <head>
    <title>用標籤能夠控制整個頁面是否執行</title>
  </head>
  
  <body>
  aaaaaaaaaaaaaaaaaaaaa 
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用標籤修改頁面內容</title>
  </head>
  
  <body>
	<flx:demo4> 
	  	aaaaaaaaaaaaaaaaaaaaa
	</flx:demo4>
  </body>
</html>

jsp 2.0規範簡單標籤

一，因爲傳統標籤使用三個標籤接口來完成不一樣的功能，顯得過於繁瑣，不利於標籤技術的推廣， SUN公司爲下降標籤技術的學習難度，在JSP 2.0中定義了一個更爲簡單、便於編寫和調用的SimpleTag接口來實現標籤的功能。實現SimpleTag接口的標籤一般稱爲簡單標籤。簡單標籤共定義了5個方法：

•setJspContext方法

•setParent和getParent方法

•setJspBody方法

•doTag方法

二，SimpleTag方法介紹

setJspContext方法

•用於把JSP頁面的pageContext對象傳遞給標籤處理器對象

setParent方法

•用於把父標籤處理器對象傳遞給當前標籤處理器對象

getParent方法

•用於得到當前標籤的父標籤處理器對象

setJspBody方法

•用於把表明標籤體的JspFragment對象傳遞給標籤處理器對象

doTag方法

•用於完成全部的標籤邏輯，包括輸出、迭代、修改標籤體內容等。在doTag方法中能夠拋javax.servlet.jsp.SkipPageException異常，用於通知WEB容器再也不執行JSP頁面中位於結束標記後面的內容，這等效於在傳統標籤的doEndTag方法中返回Tag.SKIP_PAGE常量的狀況。

三，SimpleTag接口方法的執行順序

l當web容器開始執行標籤時，會調用以下方法完成標籤的初始化

1，•WEB容器調用標籤處理器對象的setJspContext方法，將表明JSP頁面的pageContext對象傳遞給標籤處理器對象。

2，•WEB容器調用標籤處理器對象的setParent方法，將父標籤處理器對象傳遞給這個標籤處理器對象。注意，只有在標籤存在父標籤的狀況下，WEB容器纔會調用這個方法。

3，•若是調用標籤時設置了屬性，容器將調用每一個屬性對應的setter方法把屬性值傳遞給標籤處理器對象。若是標籤的屬性值是EL表達式或腳本表達式，則WEB容器首先計算表達式的值，而後把值傳遞給標籤處理器對象。

4，•若是簡單標籤有標籤體，容器將調用setJspBody方法把表明標籤體的JspFragment對象傳遞進來。

l執行標籤時：

1，•容器調用標籤處理器的doTag()方法，開發人員在方法體內經過操做JspFragment對象，就能夠實現是否執行、迭代、修改標籤體的目的。

四，JspFragment類

javax.servlet.jsp.tagext.JspFragment類是在JSP2.0中定義的，它的實例對象表明JSP頁面中的一段符合JSP語法規範的JSP片斷，這段JSP片斷中不能包含JSP腳本元素。

WEB容器在處理簡單標籤的標籤體時，會把標籤體內容用一個JspFragment對象表示，並調用標籤處理器對象的setJspBody方法把JspFragment對象傳遞給標籤處理器對象。JspFragment類中只定義了兩個方法，以下所示：

getJspContext方法

•用於返回表明調用頁面的JspContext對象.

public abstract void invoke(java.io.Writer out)

•用於執行JspFragment對象所表明的JSP代碼片斷 •參數out用於指定將JspFragment對象的執行結果寫入到哪一個輸出流對象中，若是傳遞給參數out的值爲null，則將執行結果寫入到JspContext.getOut()方法返回的輸出流對象中。(簡而言之，能夠理解爲寫給瀏覽器)

五，invoke方法詳解

•在標籤處理器中若是沒有調用JspFragment.invoke方法，其結果就至關於忽略標籤體內容；

•在標籤處理器中重複調用JspFragment.invoke方法，則標籤體內容將會被重複執行；

•若想在標籤處理器中修改標籤體內容，只需在調用invoke方法時指定一個可取出結果數據的輸出流對象（例如StringWriter），讓標籤體的執行結果輸出到該輸出流對象中，而後從該輸出流對象中取出數據進行修改後再輸出到目標設備，便可達到修改標籤體的目的。

代碼：（標籤處理器類）

/*
 * 輸出標籤體
 */
public class SimpleTagDemo1 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		JspFragment jf = this.getJspBody();
		jf.invoke(null);
	}
}


/*
 * 循環輸出標籤體
 */
 public class SimpleTagDemo2 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		JspFragment jf = this.getJspBody();
		for(int i=0;i<5;i++){
			jf.invoke(null);
		}
	}
}
 
 
/*
 * 修改內容
 */
 public class SimpleTagDemo3 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		
		JspFragment jf = this.getJspBody();
		StringWriter sw = new StringWriter();
		jf.invoke(sw);//將內容寫入緩衝
		String content = sw.toString(); //獲取緩衝區的內容進行修改
		content = content.toUpperCase();
		this.getJspContext().getOut().write(content);
	}
}
 
 
/*
 * 採用拋異常的方式在阻止內容執行
 */
 public class SimpleTagDemo4 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		throw new SkipPageException();
	}
}

tld描述文件：

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

<taglib 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 http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
    version="2.0">
    
    
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>SimpleTagLibrary</short-name>
    <uri>/yujian_simple</uri>
    
     
    <tag>
        <name>simpledemo1</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo1</tag-class>
	<body-content>scriptless</body-content><!--scriptless表示不能有腳本代碼-->
    </tag>
    
    
    <tag>
        <name>simpledemo2</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo2</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
     <tag>
        <name>simpledemo3</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo3</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
    <tag>
        <name>simpledemo4</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo4</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
</taglib>

jsp頁面：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用簡單標籤控制頁面內容是否輸出</title>
  </head>
  
  <body>
  	<flx:simpledemo1>
    	This is my JSP page. <br>
    </flx:simpledemo1>
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用簡單標籤控制頁面內容重複輸出</title>
  </head>
  
  <body>
  	<flx:simpledemo2>
    	This is my JSP page. <br>
    </flx:simpledemo2>
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<flx:simpledemo4/>
  <head>
    <title>用簡單標籤控制整個頁面是否執行</title>
  </head>
  
  <body>
    	This is my JSP page. <br>
  </body>
</html>

開發帶屬性的標籤

自定義標籤能夠定義一個或多個屬性，這樣，在JSP頁面中應用自定義標籤時就能夠設置這些屬性的值，經過這些屬性爲標籤處理器傳遞參數信息，從而提升標籤的靈活性和複用性。

要想讓一個自定義標籤具備屬性，一般須要完成兩個任務：

•在標籤處理器中編寫每一個屬性對應的setter方法

•在TLD文件中描術標籤的屬性

l爲自定義標籤訂義屬性時，每一個屬性都必須按照JavaBean的屬性命名方式，在標籤處理器中定義屬性名對應的setter方法，用來接收JSP頁面調用自定義標籤時傳遞進來的屬性值。例如屬性url，在標籤處理器類中就要定義相應的setUrl(Stringurl)方法。

l在標籤處理器中定義相應的set方法後，JSP引擎在解析執行開始標籤前，也就是調用doStartTag方法前，會調用set屬性方法，爲標籤設置屬性。

代碼：

public class SimpleTagDemo5 extends SimpleTagSupport {

	private int count;
	private Date birthday;
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
	public void setCount(int count) {
		this.count = count;
	}
	@Override
	public void doTag() throws JspException, IOException {
		
		System.out.println(this.birthday);
		for(int i=0;i<count;i++){
			this.getJspBody().invoke(null);
		}
	}
}

tld描述文件：

   <tag>
                <name>simpledemo5</name>
		<tag-class>cn.yujian.web.simpletag.SimpleTagDemo5</tag-class>
		<body-content>scriptless</body-content>
		
		<attribute>
			<name>count</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		
		<attribute>
			<name>birthday</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		
    </tag>

jsp文件：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>帶屬性的標籤</title>
  </head>
  
  <body>
  	<flx:simpledemo5 count="10" birthday="<%=new Date() %>">
    	This is my JSP page. <br>
    </flx:simpledemo5>
  </body>
</html>

在TLD中描述標籤屬性attribute：

description 不是必須；

用於指定屬性的描述信息。

name 是必須；

用於指定屬性的名稱。屬性名稱是大小寫敏感的，而且不能以jsp、_jsp、java和sun

開頭。

required 不是必須；

用於指定在JSP頁面中調用自定義標籤時是否必須設置這個屬性。其取值包括true和

false，默認值爲false，true表示必須設置，不然能夠設置也能夠不設置該屬性。

rtexprvalue 不是必須；

rtexprvalue是runtime expression value（運行時表達式）的英文簡寫，用於指定屬性值是一個靜態值或動態值。其取值包括true和false，默認值爲false，false表示只能爲該屬性指定靜態文本值，例如"123"；true表示能夠爲該屬性指定一個JSP動態元素，動態元素的結果做爲屬性值，例如JSP表達式<%=value %>。

type 不是必須；

用於指定屬性值的Java類型。

拓展：

html轉義標籤
public class HtmlFilterTag extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		
		StringWriter sw = new StringWriter();
		this.getJspBody().invoke(sw);
		
		String content = sw.toString();
		content = filter(content);
		this.getJspContext().getOut().write(content);
	}
	
	public  String filter(String message) {

        if (message == null)
            return (null);

        char content[] = new char[message.length()];
        message.getChars(0, message.length(), content, 0);
        StringBuffer result = new StringBuffer(content.length + 50);
        for (int i = 0; i < content.length; i++) {
            switch (content[i]) {
            case '<':
                result.append("&lt;");
                break;
            case '>':
                result.append("&gt;");
                break;
            case '&':
                result.append("&amp;");
                break;
            case '"':
                result.append("&quot;");
                break;
            default:
                result.append(content[i]);
            }
        }
        return (result.toString());

    }

}

tld描述：

  <tag>
        <name>htmlfilter</name>
	<tag-class>cn.yujian.web.example.HtmlFilterTag</tag-class>
	<body-content>scriptless</body-content>
    </tag>

jsp使用:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_example" prefix="c" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>My JSP '6.jsp' starting page</title>
  </head>
  
  <body>
    <c:htmlfilter>
    	<a href="">點點</a>
    </c:htmlfilter>
  </body>
</html>

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。