JSP的自定义标签

标签是一种xml元素，通过标签可以使JSP网页变得简洁并且易于维护，还可以方便地实现同一个JSP文件支持多种语言版本。由于标签是XML元素，所以它的名称和属性都是大小写敏感的

由一系列功能相似、逻辑上互相联系的标签构成的集合称为标签库。

标签库描述文件是一个XML文件，这个文件提供了标签库中类和JSP中对标签引用的映射关系。它是一个配置文件，和web.xml是类似的。4.标签处理类(TagHandleClass): 标签处理类是一个java类，这个类继承了TagSupport或者扩展了SimpleTag接口，通过这个类可以实现自定义JSP标签的具体功能 两种标签 可以定义两种类型的标签：javax.servlet.jsp.tagext.Tagjavax.servlet.jsp.tagext.BodyTag 有标签体的标签必须实现BodyTagSupport 接口。<jsptag:mapscope=“session”name=“tagMap”>body </jsptag:map> 也可能没有标签体： <jsptag:map/> 无标签体的简单标签可以实现TagSupport 接口。

1. <%@taglibPRefix=”someprefix”uri=”/sometaglib”%> 为了使到JSP容器能够使用标签库中的自定义行为，必须满足以下两个条件：

1)从一个指定的标签库中识别出代表这种自定义行为的标签

2)找到实现这些自定义行为的具体类 第一个必需条件－找出一个自定义行为属于那个标签库－是由标签指令的前缀(TaglibDirective'sPrefix)属性完成，所以在同一个页面中使用相同前缀的元素都属于这个标签库。

每个标签库都定义了一个默认的前缀，用在标签库的文档中或者页面中插入自定义标签。所以，你可以使用除了诸如jsp,jspx,java,servlet,sun,sunw(它们都是在JSP白皮书中指定的保留字)之类的前缀。

uri属性满足了以上的第二个要求。为每个自定义行为找到对应的类。这个uri包含了一个字符串，容器用它来定位TLD文件。在TLD文件中可以找到标签库中所有标签处理类的名称

2.当web应用程序启动时，容器从WEB-INF文件夹的目录结构的META-INF搜索所有以.tld结尾的文件。也就是说它们会定位所有的TLD文件。对于每个TLD文件，容器会先获取标签库的URI，然后为每个TLD文件和对应的URI创建映射关系。

在JSP页面中，我们仅需通过使用带有URI属性值的标签库指令来和具体的标签库匹配

1．在JSP中引入标签库：

<%@taglibprefix=”taglibprefix”uri=”tagliburi”%>

2．在JSP中使用标签库标签

3．Web容器根据第二个步骤中的prefix，获得第一个步骤中声明的taglib的uri属性值

4．Web容器根据uri属性在web.xml找到对应的元素（4、5两步可以不要）

5．从元素中获得对应的元素的值

<taglib> <taglib-uri>/myTag</taglib-uri> <taglib-location>/WEB-INF/myTag.tld</taglib-location></taglib> <taglib-uri>对应tld文件中的<uri>，<taglib-location>指出tld文件的位置。

6．Web容器根据元素的值从WEB-INF/目录下找到对应的.tld文件

7．从.tld文件中找到与tagname对应的元素

8．从元素中获得对应的元素的值9．Web容器根据元素的值创建相应的taghandleclass的实例10.Web容器调用这个实例的doStartTag/doEndTag方法完成相应的处理

1.创建标签的处理类(TagHandlerClass)

2.创建标签库描述文件(TagLibraryDescrptorFile)

3.在web.xml文件中配置元素

4.在JSP文件中引人标签库

1.标签库描述文件，简称TLD，采用XML文件格式，定义了用户的标签库。TLD文件中的元素可以分成3类：

A.：标签库元素

B.：标签元素

C.：标签属性元素2.标签库元素用来设定标签库的相关信息，它的常用属性有：

A.shortname：指定TagLibrary默认的前缀名(prefix)

B.uri：设定TagLibrary的惟一访问表示符

3.标签元素用来定义一个标签，它的常见属性有： A.name：设定Tag的名字 B.tagclass：设定Tag的处理类 C.bodycontent：设定标签的主体(body)内容 (1)tagdependent：标签体内容直接被写入BodyContent，由自定义标签类来进行处理，而不被JSP容器解释，

如下：<test:myList> selectname,agefromusers</test:myList> (2)JSP：接受所有JSP语法，如定制的或内部的tag、scripts、静态HTML、脚本元素、JSP指令和动作。

如：<my:test> <%=request.getProtocol()%> //②</my:test> (3)empty：空标记，即起始标记和结束标记之间没有内容。下面几种写法都是有效的，

<test:mytag/>

<test:mytaguname="Tom"/>

<test:mytag></test:mytag>

(4)scriptless：接受文本、EL和JSP动作。如上述②使用<body-content>scriptless</body-content>则报错，具体可参考后面附源码。 4.标签属性元素用来定义标签的属性，它的常见属性有： A.name：属性名称 B.required：属性是否必需的，默认为false C.rtexprvalue：属性值是否可以为request-time表达式，也就是类似于<%=„%>的表达式

例子：WEB-INF/tlds/test.tld <?xmlversion="1.0"encoding="UTF-8"?> <taglibversion="2.0"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/j2eeweb-jsptaglibrary_2_0.xsd">

<tlib-version>1.0</tlib-version> <short-name>test</short-name>//标签库名,也称为前缀。比如“c:outvalue=""/”里的“c”

<uri>/WEB-INF/tlds/test</uri>//在jsp页面上引用的路径

<tag> <name>out</name>//定义标签的名例如“test:outvalue=""/”里的"out”，

<tag-class>gdufs.tags.OutputTag</tag-class>//指出标签处理程序类记着带包名

<body-content>empty</body-content>//如果没有标签体，设置empty,如果有标签休必须设置JSP

<attribute> <name>name</name>//属性名字。例如test:outvalue=""/里的value。名字可任意取，只要类里提供相应的set方法即可。 <required>false</required>//是否必填属性 <rtexprvalue>false</rtexprvalue>//是否支持运行时表达式取值就是是否可以是${}方式传值。"

</attribute>

</tag>

</taglib>

1.引入必需的资源： 2.继承TagSupport类并覆盖doStartTag()/doEndTag()方法

TagSupport类简介： 1.处理标签的类必须扩展javax.servlet.jsp.TagSupport.

2.TagSupport类的主要属性： A.parent属性：代表嵌套了当前标签的上层标签的处理类 B.pageContex属性：代表Web应用中的javax.servlet.jsp.PageContext对象，通过此对象可向jsp页面中输出信息 3.JSP容器在调用doStartTag或者doEndTag方法前，会先调用setPageContext和setParent方法，设置pageContext和parent。因此在标签处理类中可以直接访问pageContext变量 4.在TagSupport的构造方法中不能访问pageContext成员变量，因为此时JSP容器还没有调用setPageContext方法对pageContext进行初始化

1.TagSupport类提供了两个处理标签的方法： publicintdoStartTag()throwsJspException

publicintdoEndTag()throwsJspException 2.doStartTag：但JSP容器遇到自定义标签的起始标志，就会调用doStartTag()方法。 doStartTag()方法返回一个整数值，用来决定程序的后续流程。

A.Tag.SKIP_BODY：表示?>„之间的内容被忽略 B.Tag.EVAL_BODY_INCLUDE：表示标签之间的内容被正常执行 3.doEndTag：但JSP容器遇到自定义标签的结束标志，就会调用doEndTag()方法。doEndTag()方法也返回一个整数值，用来决定程序后续流程。 A.Tag.SKIP_PAGE：表示立刻停止执行网页，网页上未处理的静态内容和JSP程序均被忽略任何已有的输出内容立刻返回到客户的浏览器上。 B.Tag_EVAL_PAGE：表示按照正常的流程继续执行JSP网页

1.如果Web应用中用到了自定义JSP标签，则必须在web.xml文件中加入元素，它用于声明所引用的标签所在的标签库 /WEB-INF/ltds/test.tld 2.：设定TagLibrary的惟一标示符，在Web应用中将根据它来引用TagLibray3.：指定和TagLibrary对应的TLD文件的位置 4.在JSP文件中需要加入<%@taglib%>指令来声明对标签库的引用。例如：<%@taglibprefix=“somePrefix”uri="/someuri"%> 5.prefix表示在JSP网页中引用这个标签库的标签时的前缀，uri用来指定TagLibrary的标识符

例子：test.jsp <%@pagecontentType="text/html"%>

<%@pagepageEncoding="UTF-8"%>

<%@pagelanguage="java"%> <%@tagliburi="/WEB-INF/tlds/test.tld"prefix="t"%>

<html>

<body> TestTag:<t:outname="TEST"/><br>标签后面的内容 </body><!--没有标签体-->

</html>

要开发带标签体的标签，可实现BodyTag接口，也可从BodyTag接口的实现类BodyTagSupport继承，为简化开发，推荐从BodyTagSupport类继承开发。 BodyTagSupport默认doStartTag()返回EVAL_BODY_BUFFERED/doInitBody()什么也不做/doAfterBody()返回SKIP_BODY 下面是自定义tag的执行过程（由上至下），对于以上各常量的实际运用为： 注意其中的doInitBody/setBodyContent方法在自定义标签实现了BodyTag接口或继承BodyTagSupport才可以使用

编写标签对应的实现类时，需要重载BodyTagSupport类几个方法：doStartTag(),setBodyContent(),doInitBody(),doAfterBody(),doEndTag()，他们执行顺序如下： doStartTag()→doInitBody()→setBodyContent()→doAfterBody()→doEndTag() doStartTag()方法可返回EVAL_BODY_INCLUDE或SKIP_BODY，如果返回EVAL_BODY_INCLUDE则继续执行；如果返回SKIP_BODY则接下来的doInitBody(),setBodyContent(),doAfterBody()三个方法不会被执行，而直接执行doEndTag()方法。 setBodyContent()方法用于设置标签体内容，如果在此之前要作一些初始化工作，则在doInitBody()方法中完成。

标签体内容执行完后，会调用doAfterBody()方法，此方法可返回EVAL_BODY_TAG,SKIP_BODY,EVAL_PAGE或SKIP_PAGE。如果返回EVAL_BODY_TAG则会再次设置标签体内容，直到返回SKIP_BODY；如果返回EVAL_PAGE则标签体执行完后会继续执行JSP页面中接下来的部分；如果返回SKIP_PAGE，则JSP页面的后续内容将不再执行。

本实例将要开发一个带标签体的标签bodyTag1，这个标签有一个属性countNum，用于设置输出标签体内容的次数，输出内容为当前的系统时间。

（1）第一步：开发标签实现类。

BodyTag1.java

 1 package body; 2 import javax.servlet.jsp.JspWriter; 3 import javax.servlet.jsp.tagext.BodyTagSupport;    4  5 public class bodyTag1 extends BodyTagSupport{      6  7 　　private int countNum=0;//循环显示时间的次数      8  9 　　private int currentNum=1;//当前执行次数   10 11   //----标签开始时调用此方法-------12     public int doStartTag(){        13 14  try{15             JspWriter out=pageContext.getOut();16             out.print("标签开始了:<br>");17              if(countNum>0)18                 return EVAL_BODY_TAG;            19               else20                 return SKIP_BODY;             21         }22     catch(Exception e){           23   System.out.println(e);            24  return SKIP_BODY;         25 }     26 }27     //----标签体执行完后调用此方法----    28  public int doAfterBody(){        29      try{30          JspWriter out=pageContext.getOut();31          out.print("第"+currentNum+"次执行标签体。标签体执行完毕。<br>");         32  if(countNum>1){//如果还需要执行标签体             33  countNum--;            34  currentNum++;35              return EVAL_BODY_TAG;         36  }else 37 return SKIP_BODY;         38 }catch(Exception e){            39  System.out.println(e);            40 return SKIP_BODY;        41  }     42 }43     //----标签结束时调用此方法-------    44  public int doEndTag(){        45  try{46             JspWriter out=pageContext.getOut();             47 //----输出标签体的内容----48             bodyContent.writeOut(bodyContent.getEnclosingWriter());             out.print("标签结束了。");         49 }catch(Exception e){             50 System.out.println(e);         51 }52         return EVAL_PAGE;     }   53     public int getCountNum() {         54 return countNum;    55  }56     public void setCountNum(int countNum) {         57 this.countNum = countNum;58         this.currentNum=1;      59  }   60 }     

执行标签体并不会直接输出标签体中的内容，因此本实例在doEndTag()方法中一次性把执行的结果输出。

（2）第二步：编写标签描述tld文件。 因为本章所有实例共用一个Web应用，故本例在myTag.tld文件中增加内容。在<taglib>与</taglib>之间增加的内容如下：

 1 <!--bodyTag1--> 2 <tag> 3 <!--标签名称--> 4 <name>bodyTag1</name> 5 <!--标签对应的处理类--> 6 <tag-class>body.bodyTag1</tag-class> 7 <!--标签体内容,有标签体则设为jsp--> 8 <body-content>jsp</body-content><!--标签的属性声明--> 9 <attribute>10 <name>countNum</name>11 <required>true</required>12 <rtexprvalue>true</rtexprvalue>13 </attribute>14 </tag>

对于属性countNum的声明中，<required>设置为true，表示此属性为必输项；<rtexprvalue>设置为true，表示标签体支持运行时的表达式取值，如果为false则表示标签体为一个静态文本，默认情况下设置为true。

（3）第三步：在Web应用的web.xml文件中声明标签库引用。（不是必须的）

1 <taglib>2 <taglib-uri>/myTag</taglib-uri>3 <taglib-location>/WEB-INF/myTag.tld</taglib-location>4 </taglib>

4）第四步：在JSP页面中声明并调用标签。

UseBodyTag1.jsp

 1 <%@tagliburi="/myTag"prefix="myTag"%> 2 <%@pagecontentType="text/html;charset=GB2312"%> 3 <%@pageimport="java.util.Date"%> 4 <html> 5 <head> 6 <title>开发带有标签体的标签</title> 7 </head> 8 <body> 9 下面是应用这个带有属性的自定义标签的结果：<br>10 <myTag:bodyTag1countNum="6">11 现在的时间是：<%=newDate()%><br>12 </myTag:bodyTag1>13 </body>14 </html>15 

运行结果:

JSP2.0中为了简化标签的复杂性，增加了制作SimpleTag的标签类SimpleTagSupport类。SimpleTagSupport类是实现SimpleTag接口的。它只需要实现一个doTag()方法即可，而不需要一堆回传值 例子：1、处理类

 1 package gdufs.tag;  2 import javax.servlet.jsp.tagext.SimpleTagSupport; 3 import javax.servlet.jsp.*; import java.io.*;  4 public class SimpleHelloTag extends SimpleTagSupport{      5 public void doTag() throws JspException,IOException{        6   JspWriter out=this.getJspContext().getOut();         7  out.println("hello world");     8  } 9  }  10 package gdufs.tag; 11 import javax.servlet.jsp.*; import java.io.*; 12 import javax.servlet.jsp.tagext.*;  13 public class SimpleTextProcessTag extends SimpleTagSupport{      14     //要处理标签体的文本内容，使用StringWriter 15     public void doTag() throws JspException,IOException{         //标签体内容 16         JspFragment frag=this.getJspBody(); 17         JspWriter out=this.getJspContext().getOut();        18  StringWriter sout=new StringWriter(); 19         //1.标签体的内容写到字符串输出流对象sout         20 frag.invoke(sout); 21         //2.获得标签体的文本内容         22 String msg=sout.toString(); 23         //3.处理并输出(逗号转换成空格) 24         out.println(msg.replaceAll(","," "));            25  }      26 }  27 package gdufs.tag; 28 import javax.servlet.jsp.*; import java.io.*; 29 import javax.servlet.jsp.tagext.SimpleTagSupport; import javax.servlet.jsp.tagext.JspFragment; 30 public class SimpleTextTag extends SimpleTagSupport{        31  public void doTag() throws JspException,IOException{        32  //fragment封装了标签体 33         JspFragment fragment=this.getJspBody(); 34         //将标签体的内容写到指定的输出流，null表示写入预设的getJspContext.getOut()取得的输出流对象 35         fragment.invoke(null);     36 }     37  }