【JSP】赵雅智_自定义JSP标签

来源：互联网发布：win8.1无法购买网络编辑：程序博客网时间：2024/05/01 16:06

自定义JSP标签概述

自定义JSP标签就是程序员定义的一种JSP标签，这种标签把那些信息显示逻辑封装在一个单独的Java类中，通过一个XML文件来描述它的使用。当页面中需要使用类似的显示逻辑时，就可以在页面中插入这个标签，从而完成相应的功能。
使用自定义标签，可以分离程序逻辑和表示逻辑，将Java代码从HTML中剥离，便于美工维护页面；自定义标签也提供了可重用的功能组件，能够提高工程的开发效率。
自定义标签主要用于移除Jsp页面中的java代码。

自定义标签的执行过程

当一个含有自定义标签的JSP页面被JSP引擎(Web容器)转译成Servlet时，JSP引擎遇到自定义的标签，会把这个自定义标签转化成对一个称为“标签处理类”的调用
当这个JSP页面被执行时，JSP引擎就会调用这个“标签处理类”对象，并执行其内部定义的相应操作方法，从而完成相应的功能。

开发流程

使用Java处理类来开发自定义JSP标签时，主要分为下几个步骤。

创建标签的处理类(Tag Handle Class)。这个类实现Tag接口，用来定义标签的行为，并在JSP引擎遇到自定义标签时调用执行。
创建标签库描述（tld）文件(Tag Library Descriptor File)，在tld文件中对标签处理器类进行描述。
在JSP文件中用taglib指令引入标签库，然后使用标签库描述文件中指定的标签名来使用它。

【案例一】输出客户机IP。

1. 不实用自定义标签：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>  <head>        <title>不使用标签输出客户机IP</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">  </head>    <body>    您的IP地址是：    <%       String ip = request.getRemoteAddr();   out.println(ip);     %>  </body></html>

2. 使用自定义标签输出客户端IP：

编写一个实现tag接口的类：ViewIpTag.java

package com.hbsi.web.tag;import java.io.IOException;import javax.servlet.http.HttpServletRequest;import javax.servlet.jsp.JspException;import javax.servlet.jsp.JspWriter;import javax.servlet.jsp.tagext.TagSupport;public class ViewIpTag extends TagSupport  {@Override//重写doStartTag方法public int doStartTag() throws JspException {//获取隐式对象HttpServletRequest request = (HttpServletRequest) this.pageContext.getRequest();JspWriter out = this.pageContext.getOut();//获取主机地址String ip = request.getRemoteAddr();try {out.println(ip);} catch (IOException e) {// TODO Auto-generated catch blocke.printStackTrace();}return super.doStartTag();}}

建立tld文件，对标签处理类进行描述。（放在WEB-INF文件夹下） hbsi.tld
（C:\apache-tomcat-6.0.18\webapps\examples\WEB-INF\jsp2）

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>          </taglib>

在jsp文件中使用自定义的标签：Demo1.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>  <head>        <title>My JSP 'Demo1.jsp' starting page</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">  </head>   <body>    您的IP地址是：<hbsi:viewIP/>  </body></html>

在别人机子上访问此地址，输出的是自己的地址。

如果我在地址栏输入别人配好的服务器地址，显示的也是自己的服务器地址

Tag接口的执行流程

JSP引擎将遇到自定义标签时，首先创建标签处理器类的实例对象，然后按照JSP规范定义的通信规则依次调用它的方法。

public void setPageContext(PageContext pc)，JSP引擎实例化标签处理器后，将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器，标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。
public void setParent(Tag t)，setPageContext方法执行完后，WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null。
public int doStartTag()，调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法。
public int doEndTag()，WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法。
public void release()，通常WEB容器执行完自定义标签后，标签处理器会驻留在内存中，为其它请求服务器，直至停止web应用时，web容器才会调用release方法。

自定义标签功能扩展

开发人员在编写Jsp页面时，经常还需要在页面中引入一些逻辑，例如：
- 控制jsp页面某一部分内容是否执行。
- 控制整个jsp页面是否执行。
- 控制jsp页面内容重复执行。
- 修改jsp页面内容输出。
自定义标签除了可以移除jsp页面java代码外，它也可以实现以上功能。
tld文件中的四种标签体类型
1. EMPTY
2. JSP
3. scriptless
4. tagdepentend

JSP标签API

JSP 1.1和1.2规范中常用的接口主要有以下3个。

Tag：此接口定义对于所有标签处理类都需要实现的方法。
IterationTag：此接口扩展了Tag接口，增加了控制重复执行标签主体的方法。
BodyTag：此接口扩展了IterationTag接口，并增加了访问和操作标签主体内容的方法。

标签库描述符

标签库描述符文件是一个以“.tld”结尾的标准XML文档，用来记录一个标签库内拥有哪些标签、每个标签包含哪些属性。
以下是一个JSP 2.0规范的标签库描述文件的内容：
<taglib>元素是标签库描述符的根元素，它包含12个子元素，详细介绍如下。
1. <description>：标签库的一个文本描述。
2. <tlib-version>：指定标签库的版本。
3. <short-name>：为标签定义简短的名字，在taglib指令中可作为首选的前缀名使用。
4. <uri>：定义一个URI，用于唯一地标识此标签库。
5. <tag>：用于指定自定义标签的相关信息。
6. <display-name>：为标签库指定一个简短的别名。
7. <small-icon>：为标签库指定大小为16×16的小图标(gif或jpeg格式)，该图标可在图形界面工具中显示。
8. <large-icon>：为标签库指定大小为32×32的大图标(gif或jpeg格式)，该图标可在图形界面工具中显示。
9. <validator>：为标签库提供一个验证器。
10. <listener>：为标签库提供一个监听器。
11. <tag-file>：用于描述标签文件。
12. <function>：用于指定在表达式语言中使用的函数。

javax.servlet.jsp.tagext包

这组类和接口放置在javax.servlet.jsp.tagext包中

传统标签的开发

在开发传统标签之前，需要了解清楚两个支持类(TagSupport和BodyTagSupport)的生命周期。
- TagSupport类的生命周期
- BodyTagSupport类的生命周期
用BodyTagSupport类开发自定义标签
- BodyTagSupport类中增加了两个方法：
BodyContent类专门用于缓存标签主体返回的内容，包括静态文本以及由嵌套标签或脚本元素所创建的动态内容。

【案例】：控制jsp页面某一部分内容是否执行。

利用doStartTag()的返回值控制

return this.SKIP_BODY; //忽略标签体

return this.EVAL_BODY_INCLUDE; //执行标签体

1. BuFenTag.java

package com.hbsi.web.tag;import javax.servlet.jsp.JspException;import javax.servlet.jsp.tagext.TagSupport;public class BuFenTag extends TagSupport {@Overridepublic int doStartTag() throws JspException {         //忽略签体         //return this.SKIP_BODY;         //执行标签体         return this.EVAL_BODY_INCLUDE;     }}

2.hbsi.tld

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>         <tag> <name>BuFen</name><tag-class>com.hbsi.web.tag.BuFenTag</tag-class><body-content>JSP</body-content>    </tag>     </taglib>

3. BuFen.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>  <head>        <title>控制jsp页面某一部分内容是否执行</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">  </head>    <body> <hbsi:BuFen> <br>This is my JSP page. <br> </hbsi:BuFen>       </body></html>

忽略标签体：

源文件：

执行标签体：

源文件：

【案例】：控制整个jsp页面是否执行。

利用doEndTag()的返回值控制

return this.SKIP_PAGE; //跳过页面标签后余下的jsp代码

return this.EVAL_PAGE;//继续执行余下jsp代码

1. ZhengGeTag.java

package com.hbsi.web.tag;import javax.servlet.jsp.JspException;import javax.servlet.jsp.tagext.TagSupport;public class ZhengGeTag extends TagSupport {@Overridepublic int doEndTag() throws JspException {//return this.SKIP_PAGE;  //跳过页面标签后余下的jsp代码return this.EVAL_PAGE;//继续执行余下jsp代码}}

2. hbsi.tld

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>         <tag> <name>BuFen</name><tag-class>com.hbsi.web.tag.BuFenTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>ZhengGe</name><tag-class>com.hbsi.web.tag.ZhengGeTag</tag-class><body-content>empty</body-content>    </tag>     </taglib>

3. ZhengGe.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <hbsi:ZhengGe/><html>  <head>        <title>控制整个jsp页面是否执</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">  </head>    <body>     This is my JSP page. <br>  </body></html>

跳过页面标签后余下的jsp代码

继续执行余下的jsp代码

【案例】：控制jsp页面内容重复执行。

利用Tag子接口Iteration中定义的doAfterBody()和返回值EVAL_BODY_AGAIN,SKIP_BODY实现

a) 先覆盖doStartTag()方法，返回EVAL_BODY_INCLUDE

b) 覆盖doAfterBody()

1. RepeatTag.java

package com.hbsi.web.tag;import javax.servlet.jsp.JspException;import javax.servlet.jsp.tagext.TagSupport;public class RepeatTag extends TagSupport {int times = 0;@Overridepublic int doAfterBody() throws JspException {times++;int result = this.EVAL_BODY_AGAIN;if(times>4){result = this.SKIP_BODY;}return result;}@Overridepublic int doStartTag() throws JspException {// TODO Auto-generated method stubreturn super.EVAL_BODY_INCLUDE;}}

2. hbsi.tld

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>         <tag> <name>BuFen</name><tag-class>com.hbsi.web.tag.BuFenTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>ZhengGe</name><tag-class>com.hbsi.web.tag.ZhengGeTag</tag-class><body-content>empty</body-content>    </tag>        <tag> <name>Repeat</name><tag-class>com.hbsi.web.tag.RepeatTag</tag-class><body-content>JSP</body-content>    </tag>         <tag> <name>dateTest</name><tag-class>com.hbsi.web.tag.DateTestTag</tag-class><body-content>JSP</body-content>    </tag>      </taglib>

3. Repeat.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>  <head>        <title>控制jsp页面内容重复执行</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">  </head>    <body>  <hbsi:Repeat>  <br>This is my JSP page. <br>  </hbsi:Repeat>       </body></html>

【案例】：修改jsp页面内容输出。

自定义标签修改内容（标签体）EVAL_BODY_BUFFERED;

标签处理类：

a) 继承BodyTagSupport

b) 覆盖doStartTag()，并返回EVAL_BODY_BUFFERED;

c) 覆盖doEndTag()

1. ChangeTag.java

package com.hbsi.web.tag;import java.io.IOException;import javax.servlet.jsp.JspException;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 ChangeTag extends BodyTagSupport{@Overridepublic int doEndTag() throws JspException {BodyContent bc = this.getBodyContent();String c = bc.getString();c = c.toUpperCase();JspWriter out = this.pageContext.getOut();try {out.write(c);} catch (IOException e) {throw new RuntimeException(e);}return this.EVAL_PAGE;}}

2. hbsi.tld

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>         <tag> <name>BuFen</name><tag-class>com.hbsi.web.tag.BuFenTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>ZhengGe</name><tag-class>com.hbsi.web.tag.ZhengGeTag</tag-class><body-content>empty</body-content>    </tag>        <tag> <name>Repeat</name><tag-class>com.hbsi.web.tag.RepeatTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>Change</name><tag-class>com.hbsi.web.tag.ChangeTag</tag-class><body-content>JSP</body-content>    </tag>     </taglib>

3. Change.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!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>  <hbsi:Change>  aaaaaaaaaaaaaaaaaaa <br>  </hbsi:Change>      </body></html>

【小练习】

实现一个自定义标签，

功能：判断一个YYYY-MM-DD格式的日期修改为下面格式输出

年：YYYY

月：MM

日：DD

1. DateTestTag.java

package com.hbsi.web.tag;import java.io.IOException;import java.io.StringWriter;import javax.servlet.jsp.JspException;import javax.servlet.jsp.JspWriter;import javax.servlet.jsp.tagext.BodyContent;import javax.servlet.jsp.tagext.BodyTagSupport;public class DateTestTag extends BodyTagSupport{@Overridepublic int doEndTag() throws JspException {BodyContent bc = this.getBodyContent();         StringWriter sw = new StringWriter();          String c = bc.getString();                  String[] results = c.split("-");                 JspWriter out = this.pageContext.getOut();         try {out.write("年："+results[0]+"<br>");out.write("月："+results[1]+"<br>");        out.write("日："+results[2]+"<br>");} catch (IOException e) {// TODO Auto-generated catch blocke.printStackTrace();}              /*  for(String each:results){              try {    out.write(each);out.write("<br>"); } catch (IOException e) {// TODO Auto-generated catch blocke.printStackTrace();}                       }*/        return this.EVAL_PAGE;}}

2. hbsi.tld

<?xml version="1.0" encoding="UTF-8" ?><taglib xmlns="http://java.sun.com/xml/ns/j2ee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"    version="2.0">    <description>A tag library exercising SimpleTag handlers.</description>    <tlib-version>1.0</tlib-version>    <short-name>hbsi</short-name>    <uri>http://www.hbsi.com</uri>        <tag> <name>viewIP</name><tag-class>com.hbsi.web.tag.ViewIpTag</tag-class><body-content>empty</body-content>    </tag>         <tag> <name>BuFen</name><tag-class>com.hbsi.web.tag.BuFenTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>ZhengGe</name><tag-class>com.hbsi.web.tag.ZhengGeTag</tag-class><body-content>empty</body-content>    </tag>        <tag> <name>Repeat</name><tag-class>com.hbsi.web.tag.RepeatTag</tag-class><body-content>JSP</body-content>    </tag>        <tag> <name>Change</name><tag-class>com.hbsi.web.tag.ChangeTag</tag-class><body-content>JSP</body-content>    </tag>         <tag> <name>dateTest</name><tag-class>com.hbsi.web.tag.DateTestTag</tag-class><body-content>JSP</body-content>    </tag>      </taglib>

3. dateTest.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib uri="http://www.hbsi.com" prefix="hbsi" %><!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">  </head>    <body>  <hbsi:dateTest>         2012-11-17 <br>  </hbsi:dateTest>      </body></html>