自定義標籤庫開發

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>

<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規範定義的通信規則依次調用它的方法。

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

2、public void setParent(Tag t)，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方法。

傳統標籤

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）

|----BodyTagSupprot類（getBodyContent() 獲取緩存對象bodyContent）

3、自定義標籤功能擴展

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

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

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

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

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

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

（3）tld文件中的四種標籤體類型

EMPTY JSP scriptless tagdepentend

例一：控制標籤體內容是否執行

doStartTag

EVAL_BODY_INCLUDE 執行標籤內容

SKIP_BODY 跳過標籤內容

Tld配置

<tag>

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

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

</tag>

例二：控制標籤後的jsp頁面是否執行

doEndTag

EVAL_PAGE 執行標籤後的頁面內容

SKIP_PAGE 跳過標籤後的頁面內容

Tld配置

<tag>

<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）將標籤體內容大寫輸出

（2）MyTag4 extends BodyTagSupport

（3）doStartTag

EVAL_BODY_BUFFERED

（4）doEndTag

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>

… ...

<name>times</name>

</attribute>

</tag>

6、簡單標籤

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

setJspContext方法

setParent和getParent方法

setJspBody方法

doTag方法

7、SimpleTag方法介紹

（1）setJspContext方法

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

（2）setParent方法

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

（3）getParent方法

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

（4）setJspBody方法

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

（5）doTag方法

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

（6）簡單標籤（簡單標籤的標籤體不能包含腳本內容，所以tld文件中配置body-content時不能配置爲JSP）

SimpleTag接口

|---SimpleTagSupport實現類（getJspContext() 獲取代表jsp頁面的pageContext，getJspBody() 代表標籤體內容的JspFragment對象）

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

如果doTag（）方法拋出SkipPageException異常，標籤後的jsp頁面就不再執行。

（7）自定義標籤聲明屬性：在標籤處理類中提供setXXX方法，並在tld文件中通過<attribute>標籤聲明屬性的特性即可。

8、SimpleTag接口方法的執行順序

（1）當web容器開始執行標籤時，會調用如下方法完成標籤的初始化

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

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

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

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

（2）執行標籤時：

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

9、JspFragment類

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

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

（3）getJspContext方法

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

（4）public 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代表其中的內容是用來給服務器用的，不是輸出到瀏覽器的內容

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

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

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

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

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

</tag>

</taglib>

例二：控制標籤後的jsp頁面是否執行

doTag

throw new SkipPageException()

Tld配置

<tag>

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

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

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

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

</tag>

<tag>

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

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

</tag>

<tag>

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

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

<!--

-->

</head>

<body>

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

</body>

</html>

站內首發文章

dyonline2012

發佈了56 篇原創文章 · 獲贊 5 · 訪問量 6萬+

私信關注

自定義標籤庫開發

lightdb hash index的性能和限制

JavaScript加強

JavaWEB開發國際化

JSTL標籤庫

EL表達式

JDBC事務控制管理

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結