2. 程式人生 > >使用tld檔案自定義jsp標籤庫

使用tld檔案自定義jsp標籤庫

阿新 • • 發佈：2018-12-15

目錄

一，標籤庫描述檔案（tld檔案）

二，標籤處理類

三，在JSP頁面中使用自定義的標籤

四，舉個例子

通過Java的TagSupport類或者BodyTagSupport類，和配套的tld檔案，可以定義自己的jsp標籤。

TagSupport類和BodyTagSupport類在jsp-api.jar中，這個jar包在tomcat的lib目錄下有，maven裡面也有。

 

一，標籤庫描述檔案（tld檔案）

tld的全名：Tag Library Descriptor。

tld檔案是一個XML檔案，是自定義標籤庫的配置檔案。

這個檔案應該放在web專案的WEB-INF目錄下，或其子目錄下，如果放在其他位置，需要在web.xml檔案中做配置。

 

下面是一個簡單的標籤庫描述檔案的例子：

myFirstTag.tld

<?xml version="1.0" encoding="UTF-8"?>
<!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>
    <short-name>testTagLib</short-name>
    <uri>/test-tags</uri>
    <display-name>"自定義標籤"</display-name>
    <tag>
        <name>TagA</name>
        <tag-class>com.mytest.TagA</tag-class>
        <body-content>jsp</body-content>
        <description>這個一個標籤</description>
        <attribute>
            <name>attributeA</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <description>屬性A</description>
        </attribute>
    </tag>
    <tag>
        <name>TagB</name>
        <tag-class>com.mytest.TagB</tag-class>
        <body-content>jsp</body-content>
        <description>這個一個標籤</description>
        <attribute>
            <name>attributeA</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <description>屬性A</description>
        </attribute>
    </tag>
</taglib>

檔案的主體是<tablib>元素，其中的元素有：

<tlib-version>，taglib版本

<jsp-version>，jsp版本

<short-name>，標籤庫名字

<uri>，標籤庫地址，在頁面使用標籤庫時會用到

<display-name>，描述

<tag>，具體的標籤列表，可以配置多個

 

其中的<tag>元素，每個元素代表一個自定義的標籤，可以有這些子元素：

<name>，標籤名字，在頁面使用標籤時會用到

<tag-class>

，標籤處理類

<body-content>，empty、scriptless、JSP、tagdependent

<description>，標籤描述，可以配置多個

<attribute>，標籤引數列表，可以配置多個

 

其中的<attribute>元素，每個元素代表一個屬性，可以有這些子元素：

<name>，屬性名字，在頁面使用標籤時會用到

<required>，是否必填，只能是true或false

<rtexprvalue>，全稱Run-time Expression Value，是否支援EL表示式，只能是true或false。如果設定為true，在頁面可以用這種寫法：attributeA="<%=name>"

<description>，屬性描述

 

二，標籤處理類

標籤處理類是在描述檔案中用<tag-class>元素標識出的java類，這個類可以選擇繼承javax.servlet.jsp.tagext.TagSupport類或javax.servlet.jsp.tagext.BodyTagSupport類，其中BodyTagSupport是TagSupport的子類。

如果選擇繼承TagSupport類，可以重寫以下方法：

public int doStartTag()

public int doEndTag()

public int doAfterBody()

如果選擇繼承BodyTagSupport類，可以額外重寫以下方法：

public void setBodyContent(BodyContent b)

public void doInitBody()

 

下面分別介紹這幾個方法：

doStartTag()

這是在java開始處理頭標籤時執行的方法，可以在這裡構造將要輸出到頁面的程式碼，或者做其他的處理。

這個方法的返回值是int，有以下選擇：

1，EVAL_BODY_INCLUDE。

這個靜態變數在javax.servlet.jsp.tagext.Tag介面中，實際值是1。

這個返回值表示正常載入標籤的body（也就是標籤的innerHTML）。

2，SKIP_BODY。

這個靜態變數在javax.servlet.jsp.tagext.Tag介面中，實際值是0。

這個返回值表示不會載入標籤的body。一般情況下doStargTag()方法返回這個值後將執行doEndTag()方法。

3，EVAL_BODY_BUFFERED。

這個靜態變數在javax.servlet.jsp.tagext.BodyTag介面中，實際值是2。

只有處理類繼承了BodyTagSupport時可以使用（詳見下面的類繼承關係圖）。

這個返回值用來在後面的程式碼中處理標籤的body。當使用這個返回值時，Java會構造一個BodyContent物件，並把標籤的body載入這個物件。

另外，BodyContent物件內部也有一個JspWriter，可以用BodyContent對物件的body進行處理。是否可以修改body是BodyTagSupport和TagSupport最大的區別。

注意：如果使用了這個返回值並重寫了相關方法，需要在程式碼中顯式寫明body部分的載入，否則body只會寫入BodyContent物件而不會載入到頁面。

 

doEndTag()

這是在java開始處理尾標籤時執行的方法，這個方法中也可以構造將要輸出到頁面的程式碼，或者其他處理。

這個方法的返回值是int，有以下選擇：

1，EVAL_PAGE。

這個靜態變數在javax.servlet.jsp.tagext.Tag介面中，實際值是6。

這個返回值表示繼續載入此標籤之後的頁面程式碼。

2，SKIP_PAGE。

這個靜態變數在javax.servlet.jsp.tagext.Tag介面中，實際值是5。

這個返回值表示不再繼續載入此標籤之後的頁面程式碼，直接將jsp現有已經處理完的頁面程式碼傳送給客戶端。

沒有想到什麼情況下用得著這個返回值。

 

doAfterBody()

這個方法在doStartTag()方法返回EVAL_BODY_INCLUDE並且載入完標籤的body後加載。

這個方法的返回值是int，有以下選擇：

1，EVAL_BODY_AGAIN。

這個靜態變數在javax.servlet.jsp.tagext.IterationTag介面中，實際值是5。

這個返回值表示再次載入標籤的body。

按照執行順序，再次載入一次body之後會再次執行這個方法，注意不要寫成死迴圈。

2，SKIP_BODY。

同doStartTag()方法的同名返回值。

java不會再載入標籤的body，向後執行。一般情況下後面將執行doEndTag()方法。

 

setBodyContent(BodyContent b)

這個方法是在呼叫doStartTag()方法，並返回EVAL_BODY_BUFFERED之後呼叫的。BodyTagSupport子類專用。

Java構造了BodyContent物件之後呼叫這個方法把BodyContent物件傳給處理類，BodyTagSupport類中這個方法裡面只有一行：

this.bodyContent = b;

如果重寫了這個方法，至少也要把這行加上，否則無法使用BodyContent物件。

該方法沒有返回值。

 

doInitBody()

該方法在呼叫setBodyContent(BodyContent b)方法後執行，可以對body進行一些初始化工作。BodyTagSupport子類專用。

BodyTagSupport類中這個方法裡面沒有程式碼。

這個方法沒有返回值。

 

上述類和介面的關係圖大概是這樣的：

 

當java處理標籤時，根據返回值的不同，方法的呼叫順序大概是這樣的：

 

三，在JSP頁面中使用自定義的標籤

1，在JSP頁面中，首先要引用標籤庫：

<%@ taglib prefix="t" uri="/test-tags"%>

prefix是標籤字首，和標籤庫中的<short-name>不一定相同。

uri引數和標籤庫中的<uri>必須相同。

2，引用了標籤庫之後，就可以使用自定義的標籤了：

<testTagLib:TagA attributeA="extra">

         number2:<input id='number2' name='number2' value='222' />

</testTagLib:TagA>

上面的例子就是有body的標籤，body就是

number2:<input id='number2' name='number2' value='222' />

這一部分，通過調整方法的返回值可以控制該部分是否顯示。

 

四，舉個例子

1，首先是tld標籤描述檔案

myFirstTag.tld

<?xml version="1.0" encoding="UTF-8"?>
<!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>
    <short-name>testTagLib</short-name>
    <uri>/test-tags</uri>
    <display-name>"自定義標籤"</display-name>
    <tag>
        <name>TagA</name>
        <tag-class>com.mytest.TagA</tag-class>
        <body-content>jsp</body-content>
        <description>這是一個標籤</description>
        <attribute>
            <name>attributeA</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <description>屬性A</description>
        </attribute>
    </tag>
    <tag>
        <name>TagB</name>
        <tag-class>com.mytest.TagB</tag-class>
        <body-content>jsp</body-content>
        <description>這是一個標籤</description>
        <attribute>
            <name>attributeA</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <description>屬性A</description>
        </attribute>
    </tag>
</taglib>

在這個描述檔案中定義了兩個標籤，TagA和TagB

 

2，標籤TagA的處理類TagA.java

TagA.java

package com.mytest;

import java.io.IOException;

import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyContent;
import javax.servlet.jsp.tagext.BodyTagSupport;
import javax.servlet.jsp.tagext.TagSupport;

public class TagA extends BodyTagSupport{
	
	private static final long serialVersionUID = 1L;
	
	protected String attributeA;

	public String getAttributeA() {
		return attributeA;
	}

	public void setAttributeA(String attributeA) {
		this.attributeA = attributeA;
	}
	
	@Override
	public int doStartTag(){
		JspWriter w=this.pageContext.getOut();
		StringBuffer sb = new StringBuffer();
		sb.append("<form id='aform' action='");
		sb.append(attributeA);
		sb.append(".do' method='post'>");
		sb.append("number1:<input id='number1' name='number1' value='111' /><br/>");
		
		try {
			w.print(sb.toString());
			w.flush();
		} catch (IOException e) {
			e.printStackTrace();
		}
		
		if("extra".equals(attributeA)){
			return EVAL_BODY_INCLUDE;
//			return EVAL_BODY_BUFFERED;
		}else{
			return SKIP_BODY;
		}
	}
	
	@Override
	public void setBodyContent(BodyContent bodyContent) {  
        System.out.println("setBodyContent...");  
        this.bodyContent = bodyContent;  
        
    } 
	
	@Override
	public void doInitBody() throws javax.servlet.jsp.JspException {
		
	};
	
	
	@Override
	public int doAfterBody() throws javax.servlet.jsp.JspException {
		String a="";
		if(this.bodyContent!=null&&a.equals("")){
			String html=this.bodyContent.getString();
			System.out.println(html);
			
			return SKIP_BODY;
		}else{
			return SKIP_BODY;
		}
	}
	
	@Override
	public int doEndTag(){
		JspWriter w=this.pageContext.getOut();
		StringBuffer sb = new StringBuffer();
		sb.append("<br/><button type='submit'>提交</button>");
		sb.append("</form>");
		
		try {
			w.print(sb.toString());
			w.flush();
		} catch (IOException e) {
			e.printStackTrace();
		}
		
		if("extra".equals(attributeA)){
			return EVAL_PAGE;
		}else{
			return SKIP_PAGE;
		}
	}
}

這個類重寫了doStartTag()，doEndTag()和doAfterBody()等方法，其中doAfterBody()方法裡面沒寫什麼東西，和父類的原方法保持一致。

這個處理類的功能是把自定義的標籤寫成了一個form表單，並添加了名為number1的文字框，當屬性attributeA等於extra時顯示number2文字框，並且正常載入標籤後面的網頁內容，否則不會顯示number2文字框，並且立即結束頁面載入，傳送給客戶端。

 

3，JSP頁面

testTagPage.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="testTagLib" uri="/test-tags"%>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TestTagPage</title>
</head>
<body>
extra
<testTagLib:TagA attributeA="extra">
	number2:<input id='number2' name='number2' value='222' />
</testTagLib:TagA>
number3:<input id='number3' name='number2' value='333' />

<hr/>

no extra
<testTagLib:TagA attributeA="noextra">
	number2:<input id='number2' name='number2' value='222' />
</testTagLib:TagA>
number3:<input id='number3' name='number2' value='333' />

</body>
</html>

這個頁面顯示出來是這樣的：

分析一下：

當java第一次載入TagA標籤時（分隔線上面部分），屬性attributeA等於extra，

doStartTag()方法返回值是EVAL_BODY_INCLUDE，表示正常載入body部分的頁面程式碼，

doEndTag()方法返回值是EVAL_PAGE，表示正常載入標籤後面的內容，所以第二個TagA標籤才得以載入。

當java第二次載入TagA標籤時（分隔線下面部分），屬性attributeA等於noextra，

doStartTag()方法返回值是SKIP_BODY，表示不會載入body部分的頁面程式碼，

doEndTag()方法返回值是SKIP_PAGE，表示不會載入標籤後面的內容，所以第二個TagA標籤後面的number3標籤和</body></html>標籤都沒有載入。

瀏覽器實際收到的頁面程式碼是這樣的：

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>TestTagPage</title>

</head>

<body>

extra

<form id='aform' action='extra.do' method='post'>number1:<input id='number1' name='number1' value='111' /><br/>

         number2:<input id='number2' name='number2' value='222' />

<br/><button type='submit'>提交</button></form>

number3:<input id='number3' name='number2' value='333' />

<hr/>

no extra

<form id='aform' action='noextra.do' method='post'>number1:<input id='number1' name='number1' value='111' /><br/><br/><button type='submit'>提交</button></form>

 

以上就是自定義JSP標籤的介紹，通過此功能可以組建自己更強大更高效的標籤庫。

相關推薦

使用tld檔案自定義jsp標籤庫

目錄 一，標籤庫描述檔案（tld檔案） 二，標籤處理類 三，在JSP頁面中使用自定義的標籤 四，舉個例子 通過Java的TagSupport類或者BodyTagSupport類，和配套的tld檔案，可以定義自己的jsp標籤。 TagSupport類和BodyTagSu

自定義jsp標籤

今天在整合專案時用到了jsp自定義標籤，研究了一下。 建立jsp自定義標籤分三步 1、建立自定義標籤類，繼承TagSupport或實現Tag介面，重寫doStartTag和doEndTag方法。他們分別會在初始化標籤和標籤呼叫結束的時候執行。 <span style=

自定義JSP防重複提交標籤

package com.hhwy.tag; import javax.servlet.jsp.JspException; import javax.servlet.jsp.JspWriter; import javax.servlet.jsp.tagext.TagSupport; imp

自定義JSP頁面標籤（有點型別EL表示式）

1.自定義標籤 1.1  標籤語言特點（格式）   <開始標籤 屬性名="屬性值">標籤體</結束標籤>    空標籤    <br/><hr/>    <開始標籤></結束標籤>    

springboot 自定義許可權標籤(tld),在freemarker引用

第一步:引入jar包 <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>

自定義JSP中的Taglib標籤之三簡單仿JSTL中帶標籤體的ForEach迴圈

上2篇文章分別了介紹了taglib的無屬性狀態和有帶屬性狀態,但是都是分別都是獨立的閉標籤,這次帶來的是帶屬性的和帶標籤體的例子,仿照jstl中的forEach迴圈構造一個簡單的迴圈標籤. Java程式碼如下: package org.lxh.taglib; imp

VS2017 Linux C++引用自定義的動態庫

++ -1 undefined mage 編譯運行 linux下 lin 套路 log 前一篇博客講了用系統庫libpthread.so的例子，只需要在項目屬性頁的[C++->命令行參數]和[鏈接器->命令行參數]中加上對應參數（比如-pthread）即可，然後

自定義JSP標簽查詢數據報錯問題

標簽 jsm www. blog sin weibo gin get 查詢 酌cdX欄厙9簿Z返掀http://shequ.docin.com/ibyrd96376 o5EQR拾8C棵自暮3殺http://www.docin.com/app/user/userinfo?u

自定義數據庫連接工具類

數據庫 工具類 這是一個代碼質量比較高的Util。這裏寫了兩種，一種是原始的，一種是使用C3P0的。數據庫使用的是MySQL5.7。使用框架開發的時候根本不需要寫這些東西。其實框架也是這樣封裝的，但提供的功能會很豐富。這裏展現的是思路，供參考。功能齊全的Dao工具類DriverManager獲取連接的

ci框架自定義數據庫查詢名稱（方法）

cti 子目錄 ons pos 傳遞 sele 傳遞參數 ren 基礎 適合剛接觸PHP和ci框架的人，本人也是小白 原因：官方給的數據庫查詢方法可能不利於記憶使用，官方給的一些方法只能進行基礎查詢，每次復合查詢都需要拼接條件，自己定義定義方法直接調用方法即可 操作步驟：

pe框架自定義jsp標簽

apple object alias 賬戶 hang ada lec post 業務邏輯 以最常見的獲取賬號列表為例子： 　　 　　引入標簽，prefix可以理解成別名，或者對象，使用時類似對象.成員。 <%@ taglib prefix="pe" uri="/WE

在react-native項目中使用iconfont自定義圖標庫

復制 light 自定義 文檔 tabbar lin ext HR sta 1. 安裝react-native-vector-icons yarn add react-native-vector-icons react-native link 如果沒有關聯成功的話，

潭州課堂25班：Ph201805201 django框架 第五課 自定義簡單標籤，包含標籤，模型類建立，梳理類建立 (課堂筆記)

自定義標籤同自定義過渡器一樣，要建立檔案，在配置檔案中以APP方法註冊，對方法進註冊，在 html 檔案中引入，..  由模板傳參     在 在配置檔案中改時區： 由檢視函式傳參       &nbs

Django 框架中的自定義模板標籤（template.Library()）

某一些標籤（例如：選單欄、css、JS、以及一些複雜計算後的資料等）需要我們自定義。 然後再在指定的html中引用並顯示。 之所以要用到標籤，主要作用就是想讓一些內容在多個模板（HTML）中都要有，比如選單欄。 我們絕對不想在每個檢視函式（views中）都寫一次這些變數內容。 即每個頁面

Rust引用自定義c/c++庫

剛入坑Rust，因為公司專案需求，需要將libjpeg-turbo移植到Rust中，在使用NDK完成交叉編譯後，我對著幾個庫檔案不知所措。國內Rust相關的文章太少，無奈只能到github和Stack Overflow上找答案。這篇文章的內容其實是Rust FFI章節的相關知識，在這裡做一下總結。

Spring Cloud-05使用配置檔案自定義Ribbon Client

文章目錄 概述 示例 新建子模組 子模組加入依賴 配置檔案增加配置 驗證 原始碼 概述 Finchley.SR2版本的官方文件： https://cloud.spring.io/spr

使用配置檔案自定義Ribbon配置

1、application.yml——Ribbon配置檔案 debug: false spring: application: name: mcc-ribbon-properties cloud: consul: discovery:

pandas 學習彙總13 - 函式應用- 將自定義或其他庫函式應用於Pandas物件( tcy)

Pandas函式應用- 將自定義或其他庫函式應用於Pandas物件（pipe,apply,applymap,map,agg） 2018/12/5   1.函式：    # 表函式應用： df.pipe(func, *args, **kwarg

Django入門教程(五)自定義模板標籤和過濾器

1、建立專案 django-admin startproject djangocustomtagandfilter cd djangocustomtagandfilter python manage.py startapp customtagfilter 2、在

如何自定義Axure元件庫

使用Axure（http://www.axurechina.cc/）的都知道，Axure在元件管理區域已經存在很多元件，但或許有些使用者覺得這些元件並不能滿足我們對原型設計的需求，若我們想要安裝Axure元件也不難，今天的文章就主要給大家講一下如何使用Axure自定義元件和載入元件庫。如果我