天天看點

JavaWeb之 JSP:自定義标簽

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

浏覽器效果如下:

JavaWeb之 JSP:自定義标簽

這樣,我們就完成了一次自定義标簽了,雖然我們知道步驟,但是不知道為什麼這樣就行,是以,下面來說一下它的原理:

自定義标簽的原理

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>      

上面的内容就可以建立一個基本功能的自定義标簽了~

學習之是以會想睡覺,是因為那是夢開始的地方。