Java 自定義標籤

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

 

上面的內容就可以創建一個基本功能的自定義標籤了~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章