jsp自定义标签实例

jsp自定义标签实例

JSP自定义标签。在自定义标签的起始和结束标签之间的部分为标签体(Body)。
   标签处理程序类：定义标签的行为，并在JSP引擎遇到自定义标签时调用执行。
   标签库描述符（TLD）文件：描述标签库的XML文档，向JSP引擎提供有关自定义标签的标签处理程序的信息。tag标签相关属性：实现简单标签处理程序 标签处理程序是一个在运行时调用的Java类,它包含在 JSP文件中使用的自定义标签的实现代码.标签处理程序必须实现或扩展javax.servlet.jsp.tagext包中的类和接口.javax.servlet.jsp.tagext含有允许标签处理程序类与JSP容器通信的接口和类。

最近在项目中要用到这种技术，所以自己就写一个经典的HelloWorld实例：
其实对自定义标签已经早有接触了（Struts中使用了很多自定义标签，如html、bean等）
使用这种技术的优点：取代了JSP中的Java程序，并且可以重复使用，方便不熟悉Java编程的网页设计人员

实现步骤：
首先启动eclipse，新建一个web项目（废话...）

1、修改web.xml文件，增加自定义标签支持

<?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>/tld/helloworld</taglib-uri>
        <taglib-location>/WEB-INF/tlds/helloworld.tld</taglib-location>
    </taglib>
  </jsp-config>
</web-app>

<?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>/tld/helloworld</taglib-uri>
    	<taglib-location>/WEB-INF/tlds/helloworld.tld</taglib-location>
	</taglib>
  </jsp-config> 
</web-app>

2、创建标签库TLD文件 tlds\helloworld.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>mytag</short-name><!-- JSP页面编写工具可以用来创建助记名的可选名字 -->
   <tag>
      <name>helloworld</name><!-- 唯一标签名 -->
      <tag-class>com.yd.mytag.HelloWorldTag</tag-class><!-- 标签HelloWorldTag类的完全限定名 -->
      <body-content>empty</body-content><!-- 正文内容类型 -->
   </tag>
</taglib>

<?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>mytag</short-name><!-- JSP页面编写工具可以用来创建助记名的可选名字 -->
   <tag>
      <name>helloworld</name><!-- 唯一标签名 -->
      <tag-class>com.yd.mytag.HelloWorldTag</tag-class><!-- 标签HelloWorldTag类的完全限定名 -->
      <body-content>empty</body-content><!-- 正文内容类型 -->
   </tag>
</taglib>

这里注意：web.xml和xxx.tld这两个XML文件的头信息的版本匹配很重要，否则会导致页面报错找不到标签


3、创建标签处理程序类 HelloWorldTag（重写doStartTag和doEndTag方法）

package com.yd.mytag;

import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.tagext.TagSupport;
/**
 * TagSupport与BodyTagSupport的区别:
 * 主要看标签处理类是否要读取标签体的内容和改变标签体返回的内容，如果不需要就用TagSupport，否则就用BodyTagSupport
 * 用TagSupport实现的标签，都可以用BodyTagSupport来实现，因为BodyTagSupport继承了TagSupport
 */
public class HelloWorldTag extends TagSupport {
    private static final long serialVersionUID = 3174234039143531070L;
    @Override
    public int doStartTag() throws JspException {//这个方法不用所以直接返回值
        return EVAL_BODY_INCLUDE;
    }
    @Override
    public int doEndTag() throws JspException {//重点在这个方法上
        try {
            pageContext.getOut().write("Hello World!");//标签的返回值
        } catch (IOException ex) {
            throw new JspTagException("错误");
        }
        return EVAL_PAGE;
    }
}

package com.yd.mytag;

import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.tagext.TagSupport;
/**
 * TagSupport与BodyTagSupport的区别:
 * 主要看标签处理类是否要读取标签体的内容和改变标签体返回的内容，如果不需要就用TagSupport，否则就用BodyTagSupport
 * 用TagSupport实现的标签，都可以用BodyTagSupport来实现，因为BodyTagSupport继承了TagSupport 
 */
public class HelloWorldTag extends TagSupport {
	private static final long serialVersionUID = 3174234039143531070L;
	@Override
	public int doStartTag() throws JspException {//这个方法不用所以直接返回值
		return EVAL_BODY_INCLUDE;
	}
	@Override
	public int doEndTag() throws JspException {//重点在这个方法上
		try {
			pageContext.getOut().write("Hello World!");//标签的返回值  
		} catch (IOException ex) {
			throw new JspTagException("错误");
		}
		return EVAL_PAGE;
	}
}

补充：
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()->执行下面的网页


4、最终测试页面 hello.jsp

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
<%@ taglib uri="/tld/helloworld" prefix="mytag"%><!-- 在页面中加以声明 -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>MyJSP</title>
  </head>
  <body>
    <h1>自定义标签:</h1><br>
    <mytag:helloworld></mytag:helloworld>
  </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
<%@ taglib uri="/tld/helloworld" prefix="mytag"%><!-- 在页面中加以声明 -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>MyJSP</title>	
  </head>  
  <body>
    <h1>自定义标签:</h1><br>
	<mytag:helloworld></mytag:helloworld>
  </body>
</html>

实例完成，HelloWorld再现江湖!!!