當jsp的內置標簽和jstl標簽庫內的標簽都滿足不了需求,這時候就需要開發者自定義標簽。
自定義標簽
下面我們先來開發一個自定義標簽,然后再說它的原理吧!
自定義標簽的開發步驟
步驟一
編寫一個普通的java類,繼承TagSupport類~
package com.vmaxtam.dotest; import javax.servlet.jsp.tagext.TagSupport; public class MyTagTest extends TagSupport { }
步驟二
重寫父類的setPageContext方法,用於得到當前jsp頁面的pageContext對象。
public class MyTagTest extends TagSupport { private PageContext pageContext; @Override public void setPageContext(PageContext pageContext) { this.pageContext=pageContext; } }
步驟三
重寫父類的doStartTag方法,里面寫上你定義的標簽的java操作,這里我定義的標簽用作向瀏覽器輸出一大段信息:
@Override public int doStartTag() throws JspException { try { pageContext.getResponse().getWriter().write("這是我寫的一大段信息:ABCDEFGHIJKLMNOPQRSTUVWXYZ"); } catch (IOException e) { e.printStackTrace(); throw new RuntimeException(e); } return super.doStartTag(); }
這樣就完成一個標簽處理程序了~別着急,寫完程序我們還需要注冊它。
步驟四
在你的web應用目錄下,找到WEB-INF文件夾,在里面新建一個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><!-- 代表jsp的版本 --> <short-name>mtt</short-name><!-- 你的標簽庫的簡稱 --> <uri>http://vmaxtam.com/mytag</uri><!-- 你標簽庫的引用uri --> <tag> <name>mytah</name><!-- 你定義的標簽的名稱 --> <tag-class>com.vmaxtam.dotest.MyTagTest</tag-class><!-- 對應的標簽處理程序:包名+類名 --> <body-content>JSP</body-content><!-- 標簽體內容的格式 --> </tag> </taglib>
如果你忘記了怎么寫,可以參考jstl里的tld文件~
步驟五
你要在使用你定義的標簽的jsp頁面導入你的標簽庫!就像導入類包一樣
只需在jsp頁面寫上下面內容:
<%@taglib uri="http://vmaxtam.com/mytag" prefix="mmt" %>
步驟6
以上5步已經把准備工作都做好了~下面我們來使用標簽吧!
<html> <head> <title>My JSP 'testit.jsp' starting page</title> </head> <body> <mmt:mytag></mmt:mytag> </body> </html>
瀏覽器效果如下:
這樣,我們就完成了一次自定義標簽了,雖然我們知道步驟,但是不知道為什么這樣就行,所以,下面來說一下它的原理:
自定義標簽的原理
1)當服務器打開時,就會加載WEB-INF下的資源文件,包括web.xml 和 tld文件,把它們加載到內存
2)我們在瀏覽器輸入http://localhost:8080/TestArea/testit.jsp來訪問jsp頁面
3)服務器讀取testit.jsp里的內容,當讀到
<%@taglib uri="http://vmaxtam.com/mytag" prefix="mmt" %>
這一句的時候,就會在內存中找是否存在uri為http://vmaxtam.com/mytag的tld文件,找不到就會報錯
4)繼續讀取jsp頁面,讀到<mmt:mytag>這個標簽的時候,就會通過uri去找到tld文件,在tld文件中找到mytab是否被定義,是的話就得到它的tag-class的內容,然后去找到它對應的標簽處理程序
5)實例化標簽處理程序,利用生成的對象調用它里面的方法
這里服務器對標簽處理程序里的方法也有一定的調用順序 A)void setPageContext(PageContext pc) --傳入pageContext對象
B)void setParent(Tag t) --如果有父標簽,傳入父標簽對象,如果沒有,則傳入null
C)int doStartTag() --開始執行標簽時調用。
D)int doEndTag() --結束標簽時調用
E)void release() --釋放資源
如果你沒有重寫上面的方法,系統將會調用它的父類里的方法~
為什么會是這個順序調用,是有證據的,下面我們來看看jsp被翻譯為java源文件里的截取:
private boolean _jspx_meth_itcast_005fshowIp_005f0(PageContext _jspx_page_context) throws Throwable { PageContext pageContext = _jspx_page_context; JspWriter out = _jspx_page_context.getOut(); // itcast:showIp 1) 實例化ShowIpTag對象 gz.itcast.tag.ShowIpTag _jspx_th_itcast_005fshowIp_005f0 = (gz.itcast.tag.ShowIpTag) _005fjspx_005ftagPool_005fitcast_005fshowIp_005fnobody.get(gz.itcast.tag.ShowIpTag.class); 2)調用setPageContext方法 _jspx_th_itcast_005fshowIp_005f0.setPageContext(_jspx_page_context); 3)調用setParent方法 _jspx_th_itcast_005fshowIp_005f0.setParent(null); 4)調用doStartTag方法 int _jspx_eval_itcast_005fshowIp_005f0 = _jspx_th_itcast_005fshowIp_005f0.doStartTag(); 5)調用doEndTag方法 if (_jspx_th_itcast_005fshowIp_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE) { _005fjspx_005ftagPool_005fitcast_005fshowIp_005fnobody.reuse(_jspx_th_itcast_005fshowIp_005f0); return true; } _005fjspx_005ftagPool_005fitcast_005fshowIp_005fnobody.reuse(_jspx_th_itcast_005fshowIp_005f0); return false; }
控制標簽體內容 與 結束標簽后的內容
自定義標簽可以可控制標簽體內的文本 和 結束標簽后的文本是否輸出~
@Override//遇到開始標簽時執行的方法 public int doStartTag() throws JspException { //return Tag.SKIP_BODY; //標簽體內容不向瀏覽器輸出 return Tag.EVAL_BODY_INCLUDE;//標簽體內容向瀏覽器輸出 } @Override//遇到結束標簽后執行的方法 public int doEndTag() throws JspException { //return Tag.EVAL_PAGE;//結束標簽后的內容輸出到瀏覽器 return Tag.SKIP_PAGE;//結束標簽后的內容不輸出到瀏覽器 }
那么如何重復輸出標簽體內的文本內容呢?TagSupper還提供了一個doAftetBody方法,我們只需要這樣做:
int i = 4; @Override//每輸出一次標簽體的內容都會調用一次這個方法 public int doAfterBody() throws JspException { while(true) { if(i>0) { i--; return IterationTag.EVAL_BODY_AGAIN;//再執行一次便簽體內的內容 }else{ break; } } return Tag.SKIP_BODY;//不輸出標簽體的內容 }
以上的內容都是控制標簽體的內容輸出的問題,那么能不能改變標簽體力的內容呢?
很可惜,用TagSupport是不行,但是我們可以用它的子類BodyTagSupport,那么久寫一個類繼承BodyTagSupport類吧~
public class MyTagTest extends BodyTagSupport { private PageContext pageContext; @Override public void setPageContext(PageContext pageContext) { this.pageContext = pageContext; } @Override public int doStartTag() throws JspException { //返回BodyTag.EVAL_BODY_BUFFERED,表示輸出標簽體內容 //返回Tag.SKIP_BODY,表示不輸出內容 return BodyTag.EVAL_BODY_BUFFERED; //return Tag.SKIP_BODY; } @Override public int doEndTag() throws JspException { //得到BodyContent對象,它包裝了標簽體里的內容 BodyContent bodyContent = this.getBodyContent(); //利用getString方法得到字符串 String content = bodyContent.getString(); //改變字符串內容,將小寫改為大寫 String change = content.toUpperCase(); //輸出到瀏覽器 try { this.pageContext.getResponse().getWriter().write(change); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } return Tag.SKIP_PAGE; } }
以上~就是自定義標簽的創建步驟會原理,還有一些標簽體內容的處理方法,大家覺得容易嗎?
對,十分的不容易啊,用這種方法定義的標簽我們稱為傳統標簽,所以這是一個社會問題,是時候就會有人站出來,寫出一組代碼來解決這個問題了,這組代碼稱為:簡單標簽
簡單標簽
為什么要學習傳統標簽
學習傳統標簽是為了以后維護到一些舊系統!!
簡單標簽比傳統標簽簡單在標簽處理器類的編寫簡單了!!!
簡單便簽的開發步驟
同樣的,我們先學習簡單標簽的開發步驟,然后再說說它的原理
步驟一
編寫標簽處理器類,也就是一個普通的類,繼承SimpleTagSupport類。然后重寫它的doTag()方法:
public class MySimpleTag extends SimpleTagSupport { @Override//當遇到標簽時就會執行這個方法 public void doTag() throws JspException, IOException { System.out.println("執行了簡單標簽里的doTag()方法~"); } }
步驟二
在tld文件內注冊這個標簽吧~這個過程和傳統標簽一樣
<tag> <name>simpletag</name> <tag-class>com.vmaxtam.dotest.MySimpleTag</tag-class> <body-content>scriptless</body-content><!--這里要用這個處理--> </tag>
步驟三
在JSP文件中導入標簽庫(這個過程和傳統標簽一樣)
步驟四
使用該標簽(這個過程和傳統標簽一樣)
以上就是簡單標簽的定義過程了,和傳統標簽相比,他簡單就簡單在不用重寫很多方法。
簡單標簽的原理
一)和傳統標簽一樣,得到tag-class字符串,找到標簽處理程序類
二)實例化標簽處理程序類
三)利用對象調用方法。。。。
和傳統標簽相比,簡單標簽調用的方法不相同:
SimpleTag接口的方法執行過程:
1) void setJspContext(JspContext pc) --設置pageContext對象,傳入pageContext對象。JspContext是PageContext的父類。在標簽處理器類中通過this.getJspContext()方法得到PageContext對象。
2)void setParent(JspTag parent) --傳入父標簽對象,如果沒有父標簽,則不調用次方法。通過getParent方法得到父標簽對象
3)void setJspBody(JspFragment jspBody) --傳入標簽體內容。標簽體內容封裝到JspFragment方法中。通過getJspBody方法得到標簽體內容。如果沒簽體,不調用次方法。
4)void doTag() --開始標簽和結束標簽都執行次方法。
為什么是這樣調用方法呢,也是有證據的:
private boolean _jspx_meth_itcast_005fsimpleDemo_005f0(PageContext _jspx_page_context) throws Throwable { PageContext pageContext = _jspx_page_context; JspWriter out = _jspx_page_context.getOut(); // itcast:simpleDemo 1)實例化SimpleDemo對象 gz.itcast.b_simple.SimpleDemo _jspx_th_itcast_005fsimpleDemo_005f0 = new gz.itcast.b_simple.SimpleDemo(); org.apache.jasper.runtime.AnnotationHelper.postConstruct(_jsp_annotationprocessor, _jspx_th_itcast_005fsimpleDemo_005f0); 2)調用setJspContext方法,傳入PageContext對象 _jspx_th_itcast_005fsimpleDemo_005f0.setJspContext(_jspx_page_context); 3)調用setParent方法,如果沒有父標簽,不執行。 4)調用setJspBody方法,傳入標簽體內容 _jspx_th_itcast_005fsimpleDemo_005f0.setJspBody(new Helper( 0, _jspx_page_context, _jspx_th_itcast_005fsimpleDemo_005f0, null)); 5)調用doTag方法,執行標簽 _jspx_th_itcast_005fsimpleDemo_005f0.doTag(); org.apache.jasper.runtime.AnnotationHelper.preDestroy(_jsp_annotationprocessor, _jspx_th_itcast_005fsimpleDemo_005f0); return false; }
控制標簽體文本 與 結束標簽后內容 是否輸出
我們可以通過JspFragment對象來控制的~
標簽體內容:
要輸出: 在doTag()方法中執行jspFrament.invoke()方法
不輸出: 什么都不做!!
結束標簽后的內容:
要輸出:什么都不做!
不輸出:在doTag()方法中拋出一個SkipPageException異常~!
@Override public void doTag() throws JspException, IOException { JspFragment jspBody = this.getJspBody(); jspBody.invoke(null); throw new SkipPageException(); }
那么如何循環輸出標簽體內容呢,在簡單標簽中實現十分簡單,在doTag方法中寫上
for(int i=1;i<=5;i++){ jspBody.invoke(null);//默認寫出都瀏覽器 }
改變標簽體里的內容
在doTag方法中寫上:
//4.1 創建一個臨時的Writer輸出流(容器) StringWriter writer = new StringWriter(); //4.2 把標簽體內容拷貝到臨時的Writer流中 JspFragment jspBody = this.getJspBody(); jspBody.invoke(writer); //4.3 從臨時的Writer流中取出標簽體內容 String content = writer.toString(); //4.4 改變標簽體內容 content = content.toUpperCase(); //4.5 把改變后的內容寫出到瀏覽器中 //jspBody.invoke(null);如果這樣寫,那么還是輸出原來的內容 this.getJspContext().getOut().write(content);
標簽體內容的輸出格式
除了能設置標簽體內容是否輸出,還能夠設置它的輸出格式,那么它有什么樣的輸出格式呢?
可以有以下輸出格式:
JSP: 表示輸出的標簽體內容可以包含jsp腳本,且可以執行此腳本。此值只能用在傳統標簽中。
scriptless: 表示輸出的標簽體內容不能包含jsp腳本,如果包含則報錯。
empty:表示沒有標簽體內容。即是空標簽。如果不是空標簽,則報錯。
tagdependent: 表示輸出的標簽體內容可以包含jsp腳本。但不執行jsp腳本(直接原樣輸出)
那么我們要在tld文件內設置文本的輸出格式:
<tag> <name>tagDemo</name> <tag-class>gz.itcast.a_tag.TagDemo1</tag-class> <body-content>JSP</body-content><!--在這里設置--> </tag>
上面都是在討論標簽體內容的輸出,標簽里還可以設置屬性的,那么自定義標簽如何定義標簽的屬性呢?
自定義標簽的屬性
這個過程我們在簡單標簽內實現,以下是操作步驟
步驟一
在標簽處理器類內聲明一個成員變量,,這個成員變量就用來接受標簽屬性的值,然后再標簽處理器類內為這個成員變量生成一個setter方法:
public class MySimpleTag extends SimpleTagSupport { private Integer num; public void setNum(Integer num) { this.num = num; }
步驟二
要到tld文件注冊這個屬性,屬性葯注冊在響應標簽的<Tag>標簽內
<tag> <name>simpletag</name> <tag-class>com.vmaxtam.dotest.MySimpleTag</tag-class> <body-content>scriptless</body-content> <attribute> <name>num</name> <!-- ??? --> <required>true</required><!-- ???????????????? --> <rtexprvalue>true</rtexprvalue><!-- ???????EL??? --> </attribute> </tag>
步驟三
這樣就可以去使用屬性了~
<body> <mmt:simpletag num="1001">我是標簽里的內容</mmt:simpletag>我是標簽后的內容 </body>
上面的內容就可以創建一個基本功能的自定義標簽了~