jsp自定义标签

一、标签的定义：分三个部分（1、tld文件，2、处理类，3、web.xml文件中引入）

二、在我们实际开发中界面和程序代码是分开的，美工做界面但是美工不懂得java语言，如果我们把java代码卸载jsp中的话，会影响美工的工作。但是如果我们使用自定义标签，到时候在jsp中我们只需要加入一段引用标签的代码。这样减少了美工的工作量，同时也方便后期的维护。

三、本文以一个自定的时间格式化标签来说明自定义标签的使用。

1、tld文件的编写：myTags.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>  <!-- 标签库要求的JSP规范版本 -->  
    <short-name>myTags</short-name>   <!-- JSP页面编写工具可以用来创建助记名的可选名字 -->  
    <tag>
    	<!-- 
	             为标签处理器类配一个标签名，在Jsp页面中使用标签时是通过标签名来找到要调用的标签处理器类的
	             通过translate就能找到对应的com.nickboyer.backstage.tag.Translate类
        -->
        <name>translate</name>
        <!-- 标签对应的处理器类-->
        <tag-class>com.nickboyer.backstage.tag.Translate</tag-class>
        <body-content>JSP</body-content>
        <attribute>
        	<!-- 参数名称，用来被格式化的日期 -->
            <name>date</name>
            <!-- 说明codeSet属性是必需的 -->
            <required>true</required>
            <!-- 说明codeSet属性可以是一个运行时表达式（不用非得是一个常量String） -->
            <rtexprvalue>true</rtexprvalue>
        </attribute>
        <attribute>
        	<!-- 格式化样式-eg:yyyyMMdd -->
            <name>format</name>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
</taglib>

这里说明下<rtexprvalue>true</rtexprvalue>标签的作用：

rtexprvalue在attribute标签下，取值有true，false，当取值为true时表示该参数可以为动态计算得到的结果，但是如果取值false，则参数值必须为直接指定。

2、处理类的编写：

TagSupport与BodyTagSupport的区别主要是标签处理类是否需要与标签体交互，如果不需要交互的就用TagSupport，否则如果不需要交互就用BodyTagSupport。

交互就是标签处理类是否要读取标签体的内容和改变标签体返回的内容。

用TagSupport实现的标签，都可以用BodyTagSupport来实现，因为BodyTagSupport继承了TagSupport。

package com.nickboyer.backstage.tag;
import java.io.IOException;
import java.util.Date;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
import com.ibm.icu.text.SimpleDateFormat;

/**
 * doStartTag()方法是遇到标签开始时会呼叫的方法，其合法的返回值是EVAL_BODY_INCLUDE与SKIP_BODY,
 * 前者表示将显示标签间的文字，后者表示不显示标签间的文字
 * doEndTag()方法是在遇到标签结束时呼叫的方法，其合法的返回值是EVAL_PAGE与SKIP_PAGE
 * ，前者表示处理完标签后继续执行以下的JSP网页，后者是表示不处理接下来的JSP网页
 * doAfterBody(),这个方法是在显示完标签间文字之后呼叫的
 * ，其返回值有EVAL_BODY_AGAIN与SKIP_BODY，前者会再显示一次标签间的文字，后者则继续执行标签处理的下一步
 * EVAL_BODY_INCLUDE：把Body读入存在的输出流中，doStartTag()函数可用
 * EVAL_PAGE：继续处理页面，doEndTag()函数可用
 * SKIP_BODY：忽略对Body的处理，doStartTag()和doAfterBody()函数可用
 * SKIP_PAGE：忽略对余下页面的处理，doEndTag()函数可用
 * EVAL_BODY_BUFFERED：申请缓冲区，由setBodyContent
 * ()函数得到的BodyContent对象来处理tag的body，如果类实现了BodyTag，那么doStartTag()可用，否则非法
 * EVAL_BODY_AGAIN：请求继续处理body，返回自doAfterBody()，这个返回值在你制作循环tag的时候是很有用的
 * 预定的处理顺序是：doStartTag()返回SKIP_BODY,doAfterBodyTag()返回SKIP_BODY,doEndTag()
 * 返回EVAL_PAGE 如果继承了TagSupport之后，如果没有改写任何的方法，标签处理的执行顺序是：doStartTag() ->不显示文字
 * ->doEndTag()->执行接下来的网页 如果您改写了doStartTag(),则必须指定返回值,
 * 如果指定了EVAL_BODY_INCLUDE
 * ,则执行顺序是：doStartTag()->显示文字->doAfterBodyTag()->doEndTag()->执行下面的网页
 */
public class Translate extends BodyTagSupport {
	private static final long serialVersionUID = 1L;
	@Override
	public int doEndTag() throws JspException {
		try {
			SimpleDateFormat sdf = new SimpleDateFormat(format);
			pageContext.getOut().write(sdf.format(date));
		} catch (IOException e) {
			e.printStackTrace();
		}
		return EVAL_PAGE;
	}
	@Override
	public int doStartTag() throws JspException {
		return EVAL_BODY_INCLUDE;
	}
	private Date date;
	private String format;
	public Date getDate() {
		return date;
	}
	public void setDate(Date date) {
		this.date = date;
	}
	public String getFormat() {
		return format;
	}
	public void setFormat(String format) {
		this.format = format;
	}
}

3、web.xml中引入自定义的标签：

<jsp-config>
	<taglib>
		<!-- 页面引入时输入的uri -->
		<taglib-uri>/WEB-INF/myTags.tld</taglib-uri>
		<taglib-location>/WEB-INF/myTags.tld</taglib-location>
	</taglib>
</jsp-config>

4、jsp页面使用：

<%@ taglib prefix="myTags" uri="/WEB-INF/myTags.tld" %>

5、测试：

<myTags:translate date="<%=new Date() %>" format="yyyy年MM月dd日"></myTags:translate>

页面显示效果2016年12月19日