自定義JSP標簽庫開發

jopen 12年前發布 | 49K 次閱讀 JSP Java開發

1、自定義標簽簡介

1自定義標簽主要用于移除Jsp頁面中的java代碼

2使用自定義標簽移除jsp頁面中的java代碼,只需要完成以下兩個步驟:

編寫一個實現Tag接口的Java(標簽處理器類)

編寫標簽庫描述符(tld)文件,在tld文件中對標簽處理器類描述成一個標簽

參考tomcat中的examples 項目中jsp 部分

(3)快速入門:使用標簽輸出客戶機IP

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>

<%@ taglib uri="http://www.itheima.com/MyTag" prefix="myTag" %>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

  <head>

  </head>

  <body>

  <hr><h1>java代碼輸出客戶機ip</h1>

   <%

   String ip = request.getRemoteAddr();

out.write(ip);

    %>

    <hr><h1>自定義標簽輸出客戶機ip</h1>

    <myTag:ip/>

  </body>

</html>

<?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 http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd">

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

 <short-name>myTag</short-name>

 <uri>http://www.itheima.com/MyTag</uri>

 <tag>

  <name>ip</name>

  <tag-class>com.itheima.tag.IpTag</tag-class>

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

 </tag>

package com.itheima.tag;

import java.io.IOException;

import javax.servlet.jsp.JspException;

import javax.servlet.jsp.PageContext;

import javax.servlet.jsp.tagext.Tag;

public class IpTag implements Tag {

public IpTag(){

System.out.println("IpTag處理類對象被創建");

}

private PageContext pc = null;

public int doEndTag() throws JspException {

try {

System.out.println("doEndTag方法被調用");

String ip = pc.getRequest().getRemoteAddr();

pc.getOut().write(ip);

} catch (IOException e) {

// TODO Auto-generated catch block

e.printStackTrace();

}

return 0;

}

public int doStartTag() throws JspException {

System.out.println("dostarttag  方法被調用");

return 0;

}

public Tag getParent() {

// TODO Auto-generated method stub

return null;

}

public void release() {

System.out.println("release方法執行,釋放資源");

}

public void setPageContext(PageContext pc) {

System.out.println("setPageContext方法被調用");

this.pc = pc;

}

public void setParent(Tag t) {

System.out.println("setParent方法被調用");

// TODO Auto-generated method stub

}

}

4分析自定義標簽的執行流程

2、Tag接口的執行流程

JSP引擎將遇到自定義標簽時,首先創建標簽處理器類的實例對象,然后按照JSP規范定義的通信規則依次調用它的方法。

1public void setPageContext(PageContext pc), JSP引擎實例化標簽處理器后,將調用setPageContext方法將JSP頁面的pageContext對象傳遞給標簽處理器,標簽處理器以后可以通過這個pageContext對象與JSP頁面進行通信。

2public void setParent(Tag t)setPageContext方法執行完后,WEB容器接著調用的setParent方法將當前標簽的父標簽傳遞給當前標簽處理器,如果當前標簽沒有父標簽,則傳遞給setParent方法的參數值為null

3public int doStartTag(),調用了setPageContext方法和setParent方法之后,WEB容器執行到自定義標簽的開始標記時,就會調用標簽處理器的doStartTag方法。

4public int doEndTag()WEB容器執行完自定義標簽的標簽體后,就會接著去執行自定義標簽的結束標記,此時,WEB容器會去調用標簽處理器的doEndTag方法。

5public void release(),通常WEB容器執行完自定義標簽后,標簽處理器會駐留在內存中,為其它請求服務器,直至停止web應用時,web容器才會調用release方法。

傳統標簽

Tag接口-----定義了一個標簽處理類應具有的最基本的方法和屬性(EVAL_BODY_INCLUDE dostart方法返回表示執行標簽體,SKIP_BODY dostart方法用,跳過標簽體。EVAL_PAGE 

用在doendtag里通知后續頁面繼續執行,SKIP_PAGE doendtag里通知后續頁面不再執行)

|

|----IterationTag接口 (提供了doAfterBody() 在標簽體執行過后立即執行,并提供EVAL_BODY_AGAIN doafterbody方法返回表示要重新執行標簽體)

|

|----TagSupport(提供了對pageContext的引用)

|

|--BodyTag接口(EVAL_BODY_BUFFERED doStartTag方法中返回通知標簽處理器去緩存標簽體bodyContent

|

|----BodyTagSupprotgetBodyContent() 獲取緩存對象bodyContent

3、自定義標簽功能擴展

1開發人員在編寫Jsp頁面時,經常還需要在頁面中引入一些邏輯,例如:

控制jsp頁面某一部分內容是否執行。<c:if>

控制整個jsp頁面是否執行。

控制jsp頁面內容重復執行。<c:forEach>

修改jsp頁面內容輸出。<c:out> HTML轉義

2自定義標簽除了可以移除jsp頁面java代碼外,它也可以實現以上功能。

3tld文件中的四種標簽體類型

EMPTY  JSP  scriptless  tagdepentend

例一:控制標簽體內容是否執行

doStartTag

EVAL_BODY_INCLUDE  執行標簽內容

SKIP_BODY  跳過標簽內容

Tld配置

 <tag>

  <name>demo1</name>

  <tag-class>mytag.MyTag1</tag-class>

  <body-content>JSP</body-content>

 </tag>

例二:控制標簽后的jsp頁面是否執行

doEndTag

EVAL_PAGE  執行標簽后的頁面內容

SKIP_PAGE  跳過標簽后的頁面內容

Tld配置

 <tag>

  <name>demo2</name>

  <tag-class>mytag.MyTag2</tag-class>

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

 </tag>

例三:控制jsp頁面內容重復執行

doStartTag

EVAL_BODY_INCLUDE  執行標簽內容

doAfterBody

EVAL_BODY_AGAIN  重復執行標簽內容

SKIP_BODY  跳過標簽內容

doAfterBody代碼

times--;

if (times > 0) {

    return EVAL_BODY_AGAIN;

} else {

    return SKIP_BODY;

}

例四:修改標簽體內容輸出

1將標簽體內容大寫輸出

2MyTag4 extends BodyTagSupport

3doStartTag

EVAL_BODY_BUFFERED

4doEndTag

String content = getBodyContent().getString();

pageContext.getOut().write();

4、開發帶屬性的標簽

(1)自定義標簽可以定義一個或多個屬性,這樣,在JSP頁面中應用自定義標簽時就可以設置這些屬性的值,通過這些屬性為標簽處理器傳遞參數信息,從而提高標簽的靈活性和復用性。

2要想讓一個自定義標簽具有屬性,通常需要完成兩個任務:

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

TLD文件中描術標簽的屬性

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

4在標簽處理器中定義相應的set方法后,JSP引擎在解析執行開始標簽前,也就是調用doStartTag方法前,會調用set屬性方法,為標簽設置屬性。

5、在TLD中描述標簽屬性 attribute

例五:控制jsp頁面內容重復執行

(1)通過成員變量 和 setter方法設置屬性  times

(2)Tld配置

<tag>

… ...

<attribute>

 <name>times</name>

 <required>true</required>

 <rtexprvalue>true</rtexprvalue>

 </attribute>

</tag> 

6簡單標簽

由于傳統標簽使用三個標簽接口來完成不同的功能,顯得過于繁瑣,不利于標簽技術的推廣, SUN公司為降低標簽技術的學習難度,在JSP 2.0中定義了一個更為簡單、便于編寫和調用的SimpleTag接口來實現標簽的功能。實現SimpleTag接口的標簽通常稱為簡單標簽。簡單標簽共定義了5個方法:

setJspContext方法

setParentgetParent方法

setJspBody方法

doTag方法

7、SimpleTag方法介紹

1setJspContext方法

用于把JSP頁面的pageContext對象傳遞給標簽處理器對象 

2setParent方法

用于把父標簽處理器對象傳遞給當前標簽處理器對象 

3getParent方法

用于獲得當前標簽的父標簽處理器對象 

4setJspBody方法

用于把代表標簽體的JspFragment對象傳遞給標簽處理器對象 

5doTag方法

用于完成所有的標簽邏輯,包括輸出、迭代、修改標簽體內容等。在doTag方法中可以拋出javax.servlet.jsp.SkipPageException異常,用于通知WEB容器不再執行JSP頁面中位于結束標記后面的內容,這等效于在傳統標簽的doEndTag方法中返回Tag.SKIP_PAGE常量的情況。 

6簡單標簽(簡單標簽的標簽體不能包含腳本內容,所以tld文件中配置body-content時不能配置為JSP

SimpleTag接口

|

|---SimpleTagSupport實現類(getJspContext() 獲取代表jsp頁面的pageContextgetJspBody() 代表標簽體內容的JspFragment對象)

JspFragmentinvoke(Writer out) 此方法一經調用會將標簽體輸出到對應的流中。如果你直接給一個null默認輸出到pageContext.getOut()

如果doTag()方法拋出SkipPageException異常,標簽后的jsp頁面就不再執行。

7自定義標簽聲明屬性:在標簽處理類中提供setXXX方法,并在tld文件中通過<attribute>標簽聲明屬性的特性即可。

8SimpleTag接口方法的執行順序

1web容器開始執行標簽時,會調用如下方法完成標簽的初始化

WEB容器調用標簽處理器對象的setJspContext方法,將代表JSP頁面的pageContext對象傳遞給標簽處理器對象。

WEB容器調用標簽處理器對象的setParent方法,將父標簽處理器對象傳遞給這個標簽處理器對象。注意,只有在標簽存在父標簽的情況下,WEB容器才會調用這個方法。

如果調用標簽時設置了屬性,容器將調用每個屬性對應的setter方法把屬性值傳遞給標簽處理器對象。如果標簽的屬性值是EL表達式或腳本表達式,則WEB容器首先計算表達式的值,然后把值傳遞給標簽處理器對象。

如果簡單標簽有標簽體,容器將調用setJspBody方法把代表標簽體的JspFragment對象傳遞進來。

2執行標簽時:

容器調用標簽處理器的doTag()方法,開發人員在方法體內通過操作JspFragment對象,就可以實現是否執行、迭代、修改標簽體的目的。

9、JspFragment類 

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

2WEB容器在處理簡單標簽的標簽體時,會把標簽體內容用一個JspFragment對象表示,并調用標簽處理器對象的setJspBody方法把JspFragment對象傳遞給標簽處理器對象。JspFragment類中只定義了兩個方法,如下所示:

3getJspContext方法

用于返回代表調用頁面的JspContext對象. ---- pageContext

4public abstract void invoke(java.io.Writer out)  -- 輸出標簽體內容

用于執行JspFragment對象所代表的JSP代碼片段

參數out用于指定將JspFragment對象的執行結果寫入到哪個輸出流對象中,如果傳遞給參數out的值為null,則將執行結果寫入到JspContext.getOut()方法返回的輸出流對象中。(簡而言之,可以理解為寫給瀏覽器)

10、invoke方法詳解  

JspFragment.invoke方法是JspFragment最重要的方法,利用這個方法可以控制是否執行和輸出標簽體的內容、是否迭代執行標簽體的內容或對標簽體的執行結果進行修改后再輸出。例如:

在標簽處理器中如果沒有調用JspFragment.invoke方法,其結果就相當于忽略標簽體內容;

在標簽處理器中重復調用JspFragment.invoke方法,則標簽體內容將會被重復執行;

若想在標簽處理器中修改標簽體內容,只需在調用invoke方法時指定一個可取出結果數據的輸出流對象(例如StringWriter),讓標簽體的執行結果輸出到該輸出流對象中,然后從該輸出流對象中取出數據進行修改后再輸出到目標設備,即可達到修改標簽體的目的。

tld文件配置自定義標簽

<tag>

<name>demo10</name>-----定義標簽的名字

<tag-class>cn.itheima.simple.Demo10</tag-class>----標簽處理類

<body-content>scriptless</body-content>----標簽體內容JSP表示任意jsp內容,empty代表只能為空、scriptless帶表不能包含腳本內容、tagdependent代表其中的內容是用來給服務器用的,不是輸出到瀏覽器的內容

<attribute>

<name>times</name>---屬性的名字(名字必須有)

<required>true</required>---是否是一個必須的屬性

<rtexprvalue>true</rtexprvalue>---是否支持el表達式

<type>int</type>---屬性的類型

</attribute>

</tag>

package com.itheima.simple;

import java.io.IOException;

import java.io.StringWriter;

import javax.servlet.jsp.JspException;

import javax.servlet.jsp.SkipPageException;

import javax.servlet.jsp.tagext.JspFragment;

import javax.servlet.jsp.tagext.SimpleTagSupport;

public class Demo2 extends SimpleTagSupport {

@Override

public void doTag() throws JspException, IOException {

//控制標簽體是否執行--什么都不做,默認情況下標簽體不執行 --執行標簽體

//JspFragment fragment =  getJspBody();

//fragment.invoke(null);

//控制標簽之后的剩余頁面是否執行 -- 什么都不做,默認情況下標簽之后的剩余頁面將會執行 -- 標簽之后的內容不執行

//throw new SkipPageException();

//重復執行標簽體

//JspFragment fragment =  getJspBody();

//for(int i=0;i<5;i++)

//fragment.invoke(null);

//修改標簽體進行輸出

StringWriter writer = new StringWriter();

getJspBody().invoke(writer);

String str = writer.toString();

str = str.toUpperCase();

getJspContext().getOut().write(str);

}

}

例一:控制標簽體內容是否執行

doTag

JspFragment jspFragment = getJspBody();

jspFragment.invoke(getJspContext().getOut());

jspFragment.invoke(null);

Tld配置

 <tag>

  <name>demo1</name>

  <tag-class>simple.MyTag1</tag-class>

  <body-content>scriptless</body-content>

 </tag>

package com.itheima.simple;

import java.io.IOException;

import javax.servlet.jsp.JspException;

import javax.servlet.jsp.tagext.JspFragment;

import javax.servlet.jsp.tagext.SimpleTagSupport;

public class Test1 extends SimpleTagSupport 

{

   @Override

   public void doTag() throws JspException, IOException {

// TODO Auto-generated method stub

JspFragment jspBody = getJspBody();

jspBody.invoke(null);

}

}

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<%@taglib uri="http://www.inheima.com/DyTag" prefix="dt" %>

<%

String path = request.getContextPath();

String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";

%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

  <head>

    <base href="<%=basePath%>">

    

    <title>My JSP 'Test2.jsp' starting page</title>

    

  </head>

  

  <body>

  <dt:t1>1111111</dt:t1>

  </body>

</html>

<?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 http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd">

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

 <short-name>dt</short-name>

 <uri>http://www.inheima.com/DyTag</uri>

 <tag>

 <name>t1</name>

 <tag-class>com.itheima.simple.Test1</tag-class>

 <body-content>scriptless</body-content>

 </tag>

</taglib>

例二:控制標簽后的jsp頁面是否執行

doTag

throw new SkipPageException()

Tld配置

 <tag>

  <name>demo2</name>

  <tag-class>simple.MyTag2</tag-class>

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

 </tag>

例三:控制jsp頁面內容重復執行

doTag

JspFragment fragment = getJspBody();

for (int i = 0; i < times; i++) {

    fragment.invoke(null);

}

Tld配置

 <tag>

  <name>demo3</name>

  <tag-class>simple.MyTag3</tag-class>

  <body-content>scriptless</body-content>

 </tag>

例四:修改jsp頁面內容輸出

將標簽體內容大寫輸出

doTag

JspFragment fragment = getJspBody();

StringWriter writer = new StringWriter();

fragment.invoke(writer);

getJspContext().getOut().println(

writer.getBuffer().toString().toUpperCase());

<?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 http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd">

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

 <short-name>dt</short-name>

 <uri>http://www.inheima.com/DyTag</uri>

 <tag>

 <name>t1</name>

 <tag-class>com.itheima.simple.Test1</tag-class>

 <body-content>scriptless</body-content>

 </tag>

 <tag>

 <name>t2</name>

 <tag-class>com.itheima.simple.Test2</tag-class>

 <body-content>scriptless</body-content>

 </tag>

 <tag>

 <name>t3</name>

 <tag-class>com.itheima.simple.Test3</tag-class>

 <body-content>scriptless</body-content>

 </tag>

</taglib>

package com.itheima.simple;

import java.io.IOException;

import java.io.StringWriter;

import javax.servlet.jsp.JspContext;

import javax.servlet.jsp.JspException;

import javax.servlet.jsp.tagext.JspFragment;

import javax.servlet.jsp.tagext.SimpleTagSupport;

public class Test3 extends SimpleTagSupport 

{

  @Override

public void doTag() throws JspException, IOException 

{

   JspFragment jb = getJspBody();

   StringWriter writer=new StringWriter();

   jb.invoke(writer);

   String str = writer.getBuffer().toString().toUpperCase();

   getJspContext().getOut().print(str);

}

}

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<%@ taglib uri="http://www.inheima.com/DyTag" prefix="dt" %>

<%

String path = request.getContextPath();

String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";

%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

  <head>

    <base href="<%=basePath%>">

    

    <title>My JSP 'Test4.jsp' starting page</title>

    

<meta http-equiv="pragma" content="no-cache">

<meta http-equiv="cache-control" content="no-cache">

<meta http-equiv="expires" content="0">    

<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">

<meta http-equiv="description" content="This is my page">

<!--

<link rel="stylesheet" type="text/csshref="styles.css">

-->

  </head>

  

  <body>

    <dt:t3>ssssssssss</dt:t3> 

  </body>

</html>

 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!