自定义标签总结（一）

最新推荐文章于 2020-04-23 02:40:50 发布

最新推荐文章于 2020-04-23 02:40:50 发布 · 189 阅读

文章标签：

#JSP #JavaEE #Servlet #Web #XML

Java Web 专栏收录该内容

6 篇文章

订阅专栏

标签在web 开发中经常用到像jsf、jstl、struts等等框架都有自己的标签庫，当然我们也可以根据实际需要开发自己的标签。在上一个项目中我用到了自定义标签，在这里总结一下，也好巩固一下知识。

标签其实是一种xml元素，所以它的名称和属性对大小写敏感。我们对标签进行处理，其实就是对标签处理类的对象进行操作，（jsp------>jsp引擎------------->Servlet--------------------->对象）

标签的分类 ————》带有主体和属性（都是可选的）

不带属性和主题的标签：<myTag:tagName/>
带属性不带主题的标签：<myTag:tagName name="userName" value="wangyalei"/>
带有主体和属性的标签：<myTag:tagName name="userName" value="wangalei">javaeye</myTag:tagName>
SimpleTag:一种簡単类型类型标签

标签的处理过程

当jsp中使用标签时，有容器对其进行实例化，然后依次进行一下操作

通过setPageContext()方法来设置标签的页面上下文
使用setParent()方法设置标签的上一级标签，如果没有上一级，设置为null
设置标签的属性
通过doStartTag()方法，如果返回EVAL_BODY_INCLUDE,就计算标签的Body,如果返回SKIP_BODY，就不用计算标签的Body
调用doEndTag()方法，如果返回EVAL_PAGE时，容器将在标签的结束时候计算jsp的其他的部分，如果返回SKIP_PAGE容器将在标签结束时停止计算jsp页面的其他部分
调用release()方法释放资源

下面是个定义标签的小例子

/******************************************************************************
 * wangyalei
 * V00.00.00 2011/1/6    
 ******************************************************************************/
package cn.javaeye.tag;

import java.text.SimpleDateFormat;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;

public class DataTimetag extends TagSupport {

	private static final long serialVersionUID = 1L;

	String format = "yyyy-MM-dd hh:mm:ss";

	/*
	 * (non-Javadoc)
	 * 
	 * @see javax.servlet.jsp.tagext.TagSupport#doStartTag()
	 */
	@Override
	public int doStartTag() throws JspException {
		System.out.println("startTag........................");
		return super.doStartTag();
	}

	public void setFormat(String str) {
		if (str.equalsIgnoreCase("date")) {
			format = "yyyy-MM-dd";
		} else if (str.equalsIgnoreCase("time")) {
			format = "hh:mm:ss";
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see javax.servlet.jsp.tagext.TagSupport#doEndTag()
	 */
	@Override
	public int doEndTag() throws JspException {
		System.out.println("endTag..........................");
		SimpleDateFormat sdf = new SimpleDateFormat(format);
		String time = sdf.format(new java.util.Date());
		try {
			pageContext.getOut().print(
					"<span style=\"color:red;\">" + time + "</span>");
		} catch (Exception e) {
			throw new JspException(e.toString());
		}
		return EVAL_PAGE;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see javax.servlet.jsp.tagext.TagSupport#release()
	 */
	@Override
	public void release() {
	   System.out.println("release...........................");
		super.release();
	}
}

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.0" xmlns="http://java.sun.com/xml/ns/javaee"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee web-jsptaglibrary_2_0.xsd">
 <tlib-version>1.0</tlib-version>
 <short-name>examples</short-name>
 <uri>/demotag</uri>
 <description>
 		a simple tag library for the examples
 </description>   
	<tag>
		 <name>dateTime</name>
		  <tag-class>cn.javaeye.tag.DataTimetag</tag-class>
		  <attribute>
		  		<name>format</name>
		  </attribute>
	</tag>
</taglib>

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
	xmlns="http://java.sun.com/xml/ns/javaee" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  
   <jsp-config>
		<taglib>
			<taglib-uri>/mytag</taglib-uri>
			<taglib-location>/WEB-INF/mytag.tld</taglib-location>	
	   </taglib>
	</jsp-config>	
	
	<welcome-file-list>
        <welcome-file>dateTime.jsp</welcome-file>
    </welcome-file-list>
</web-app>

<%@ page language="java" import="java.util.*" pageEncoding="GB18030"%>
<%@ taglib prefix="t" uri="/mytag" %><!-- 声明标签库 -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    
    <title>显示日期时间</title>
	<meta http-equiv="pragma" content="no-cache">
	<meta http-equiv="cache-control" content="no-cache">
	<meta http-equiv="expires" content="0">    
	<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
	<meta http-equiv="description" content="This is my page">
	<!--
	<link rel="stylesheet" type="text/css" href="styles.css">
	-->
  </head>
  
  <body>
    <h2>自定义标签显示日期时间</h2><br/>
    <hr>
    <br/>
    <dl>
    	<dd>format属性datetime <t:dateTime format="datetime"/></dd>
    	<dd>format属性date <t:dateTime format="date"/></dd>
    	<dd>format属性time <t:dateTime format="time"/></dd>
    </dl>
  </body>
</html>

其实一个自定义标签就是有一般的javaBean,标签库描述、标签处理器、web.xml文件配置、标签庫声明等元素构成。javaBean、web.xml不多说了。

标签库的描述就是用一般的tld文件进行对标签进行描述，其中记录了标签的属性，信息和位置，服务器通过该文件来确定如何调用一个标签；

一个自定义标签的tld文件的内容我们可以参考java开源项目的tld文件这里我copy的是jstl自定标中c标签的头部

tld文件必须<taglib>来做它的根元素，<taglib>的子元素

元素名称	描述
tlib-version	Tag庫的版本
jsp-version	Tag庫需要的jsp的版本
short-name	tag的一个别名（可选）
uri	确定一个唯一的tag庫
description	对tag庫的描述（可选）
tag	定义标签的主要节点元素

Tag元素

元素名称	描述
name	Tag标签对象的tag处理类
tag-class	javax.servlet.jsp.tagext.TagExtraInfo的子类，用于表达式脚本的变量（可选）
body-content	Tag标签body类型
description	tag标签的描述
variable	提供脚本变量的信息（可选）
attribute	tag标签的属性名