JSP自定义标签(详细)

1、JSP标签库在这篇文章中，我们主要讨论：· 什么是自定义tag标签？· 怎么使用tag标签？o 声明要使用的tag库o 找到与之对应的tag处理类o tag标签的类型· 自定义tag标签o tag处理类o tag库描述o tag标签示例o 带属性的tago 带body的tago 定义了脚本变量的tago 具有协作关系的tag· 自定义tag标签o 一个迭代tag的例子o 一个模板tag库o tag处理类到底是怎样被调用的？什么是自定义的tag?一个自定义的tag标签是用户定义的一种JSP标记。当一个含有自定义的tag标签的JSP页面被jsp引擎编译成se

2、rvlet时，tag标签被转化成了对一个称为tag处理类的对象进行的操作。于是当JSP页面被jsp引擎转化为servlet后，实际上tag标签被转化成为了对tag处理类的操作。自定义tag标签有很多特色，诸如：· 可以在JSP页面中自定义tag标签的属性· 访问JSP页面中的所有对象· 可以动态地修改页面输出· 彼此这间可以相互通信。你可以先创建一个JavaBeans组件，然后在一个tag中调用此JavaBeans组件，同时可以在另一个tag中调用它。· tag允许相互嵌套，可以在一个JSP页面中完成一些复杂的交互。使用tag标签本节主要描述怎

3、样在JSP页面中使用tag标签，以及tag标签的不同类型。要使用tag标签，JSP程序员必须做2件事：· 声明此tag标签的tag库· 实现此tag标签声明tag标签所在的tag库如果要使用tag标签，则应用JSP的taglib指示符来指定其tag库（注意：taglib要在在使用此tag推荐精选标签之前声明）<% taglib uri=”/WEB-INF/tutorial-template.tld” prefix=”tt” %>uri属性定义了唯一的标签库描述(以下简称TLD)，它可以是直接是tld文件名或一个独一无二的名字。prefix是用来区别其它TLD中和

4、本TLD中有重名的tag的一种手段。TLD必须以.tld作为扩展名，并且存放在当前应用的WEB-INF目录或其子目录下。你可以通过它的文件名直接引用它，也可以通过别的方式间接地引用它。以下taglib指示符直接引用一个TLD：<% taglib uri=”/WEB-INF/tutorial-template.tld” prefix=”tt” %>以下的taglib指示符通过一个逻辑名称间接地引用一个TLD：<% taglib uri=”/tutorial-template” prefix=”tt” %>如果是间接引用TLD的话，那你必须还要在web.xml中定义此逻辑名

5、称与tld文件之间的映射，具体做法是在web.xml中加入一个名为taglib的元素：<taglib><taglib-uri>/tutorial-template</taglib-uri><taglib-location>/WEB-INF/tutorial-template.tld</taglib-location></taglib>实现此tag标签为了实现tag标签，你有2种方法来存放tag处理类。一、让tag处理类以.class的方式存放于当前应用的WEB-INF/class子目录下，二、如果tag处理类是以JAR包的

6、形式存在的话，那可以放在当前应用的WEB-INF/lib目录下，如果tag处理类要在多个应用中共享，那么它就应放在jsp服务器上的common/lib目录下，对于tomcat来说，就是tomcat/common/lib目录下。tag标签类型自定义的tag标签遵循XML语法。它有一个开始标记和一个结束标记，有的还有body（即文本节点）：<tt:tag>body</tt:tag>一个不带body的tag标签如下：<tt:tag />推荐精选简单的tag标签一个没有body和属性的tag标签如下：<tt:simple />带属性的tag标签自定义标签

7、可以有自己的属性。属性一般在开始标记中定义，语法为 attr=”value”。属性的作用相当于自定义标签的一个参数，它影响着tag处理类的行为。你可以在TLD中详细定义它。你可以用一个String常量给一个属性赋值，也可以通过表达式给它赋值，如<%= .%>。以struts为例，它的logic:present标签就是用的String常量来给属性赋值：<loglic:present parameter = “Clear”>而另一个标签logic:iterate是用表达式来给属性赋值：<logci:iterate collection=”<%= bookDB.g

8、etBooks() %>”id=”book” type=”database.BookDetails”>带body的tag标签一个自定义标签可以包含其它自定义标签、脚本变量、HTML标记或其它内容。在下述例子中，此JSP页面使用了struts的logic:present标签，如果些标签定义了parameter=”Clear”的属性，则将清除购物车的内容，然后打印出一条信息：<logic:present parameter=”Clear”><% cart.clear(); %><font color=”#ff0000” size=”+2”><s

9、trong> 你选择了清除购物车！</strong></font></logic:present>到底是用属性还是用body来传递信息？如上所述，我们既可以通过属性，也可以通过body来传递信息。但一般来说，比较简单的类型，如字符串或简单表达式最好采用属性来传递信息。定义脚本变量的tag标签所谓脚本变量，是指JSP中可以调用的变量或对象。它可由tag标签产生。以下示例阐述了一个tag标签定义了一个名为tx的由JNDI所定义的事务处理对象。脚本变量可以是ejb对象、事务、数据库连接等等：<tt:lookup id=”tx” type=”UserTr

10、ansaction” name=”java:comp/UserTransaction” /><% tx.begin(); %>.推荐精选具有协作关系的tag标签自定义tag标签之间可以通过共享对象来实现协作。在下述例子中，标签tag1创建了一个名为obj1的对象，在标签tag2仍可以重复使用obj。<tt:tag1 attr1=”obj1” value1=”value” /><tt:tag2 attr1=”obj1” />在以下这个例子当中，如果外层的tag标签创建了一个对象，那么其内层的所有tag标签都可以使用这个对象。由于这样产生的对象没有一个指定

11、的名字，那么就可以将少重名的冲突。这个例子阐述了一系列协作的嵌套对象。<tt:outerTag><tt:innerTag /></tt:outerTag>Tag处理类Tag处理类必须实现Tag接口或BodyTag接口，不过现在一般都流行从TagSupport或BodyTagSupport类中继承，这些类或接口都可以在javax.servlet.jsp.tagext包中找到。当JSP引擎看到自己的JSP页面中包含有tag标签时，它会调用doStartTag方法来处理tag标签的开头，调用doEndTag方法来处理tag标签的结束。下表说明不同类型的tag所需要

12、不同的处理过程：Tag处理类的方法Tag标签类型所调用的方法基本标签doStartTag, doEndTag, release带属性的标签doStartTag, doEndTag, set/getAttribute1.N, release带内容的标签doStartTag, doEndTag, release带内容的标签，且内容重复循环doStartTag, doAfterBody, doEndTag, release带内容的标签，且内容与JSP交互doStartTag, doEndTag, release, doInitBody, doAfterBody, release一个tag处理类可以通

13、过javax.servlet.jsp.PageContext来与JSP交互，通过javax.servlet.jsp.PageContext类，tag处理类可以访问JSP中的request、session和application对像。推荐精选如果tag标签是互相嵌套的，那内层的tag处理类可以通过它的parent属性来访问上层的tag处理类。一般情况都将所有的tag处理类打成了JAR的包，以便于发布。Tag库描述(简称TLD)Tag库是用xml语言描述的，TLD包括了tag库中所有tag标签的描述，它一般用来被jsp服务器用来校验tag的语法正确性，或者被jsp开发者用来开发新的标签。TLD的文

14、件扩展名必须为.tld，而且必须放在当前WEB应用的WEB-INF目录或其子目录中。一个TLD的内容的开头必须遵守标准的XML开头，用于描述DTD和xml的版本，例如：<?xml version="1.0" encoding="ISO-8859-1" ?><!DOCTYPE taglib PUBLIC "-/Sun Microsystems, Inc./DTD JSP Tag Library 1.2/EN" "TLD必须以<taglib>来作为它的根元素，<taglib>的子元素如下

15、表：<taglib>的子元素ElementDescriptiontlib-versionTag库的版本jsp-versionTag库所需要的jsp的版本short-name助记符，tag的一个别名（可选）uri用于确定一个唯一的tag库display-name被可视化工具（诸如Jbuilder）用来显示的名称（可选）small-icon被可视化工具（诸如Jbuilder）用来显示的小图标（可选）large-icon被可视化工具（诸如Jbuilder）用来显示的大图标（可选）description对tag库的描述（可选）listener参见下面listener元素tag参见下面tag

16、 元素Listener元素一个tag库可能定义一些类做为它的事件侦听类，这些类在TLD中被称为listener 元素，jsp服务器将会实例化这些侦听类，并且注册它们。Listener元素中有一个叫listener-class的子元素，这个元素的值必须是该侦听类的完整类名。Tag元素每个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。其中脚本变量的值可以直接在TLD中定义或通过tag附加信息的类来取得。每个属性描述了这个属性是否可以省略，它的值是否可以通过<%= %>这样的JSP语法来获得，以及属性的类型。推荐精选每一个tag在TLD中对应一个tag元素，下表是

17、tag元素的子元素：Tag元素的子元素元素名称描述name独一无二的元素名tag-classTag标签对应的tag处理类tei-classjavax.servlet.jsp.tagext.TagExtraInfo的子类，用于表达脚本变量（可选）body-contentTag标签body的类型display-name被可视化工具（诸如Jbuilder）用来显示的名称（可选）small-icon被可视化工具（诸如Jbuilder）用来显示的小图标（可选）large-icon被可视化工具（诸如Jbuilder）用来显示的大图标（可选）description此tag标签的描述variable提供脚本变

18、量的信息（同tei-class）(可选)attributeTag标签的属性名以下章节介绍对于不同类型的tag，如何具体地实现它们。简单的tagtag处理类简单的tag处理类必须实现Tag接口的doStartTag和doEndTag方法。当jsp引擎碰到tag标签的开头时，doStartTag被调用，因为简单的tag没有body，所以此方法将返回 SKIP_BODY。当jsp引擎碰到tag标签的结尾时，doEndTag被调用，如果余下的页面还要被计算，那它将返回EVAL_PAGE,否则将会返回SKIP_PAGE。 以下是例子：对于标签 <tt:simple /> ，它的tag处理类实

19、现如下：public SimpleTag extends TagSupportpublic int doStartTag() throws JspExceptiontrypageContext.getOut().print(“Hello.”);catch(Exception e)throw new JspTagException(“SimpleTag: “ + e.getMessage();return SKIP_BODY;public int doEndTag()推荐精选return EVAL_PAGE;注意：如果tag标签没有内容的话，那必须定义body-content元素为空，例如<

20、;body-content>empty</body-content>带属性的tag标签tag处理类对于tag标签的每个属性，你必须依照JavaBeans规范来定义其属性，以及get和set方法。以struts的logic:present 标签为例，<logic:present parameter=”Clear”>与此相应，此tag处理类应有如下方法和定义：protected String parameter = null;public String getParameter()return this.parameter;public void setParamet

21、er(String parameter)this.parameter = parameter;注意：如果你的属性名为id，而且你的tag处理类是从TagSupport类继承的，那你就不需要定义它的属性和set和get方法,因为他们早已在TagSupport被定义过了。Attribute元素对于tag标签的每个属性，你必须定义它是否必须的，它的值是否可以用诸如<%= %>的表达式来获得，以及它的类型（可选），如果不指定它的类型，那就默认为是java.lang.String类型。如果rtexprvalue元素被定义为true或yes，那么在type元素中就定义了attribute的返回

22、类型。<attribute><name>attr1</name><required>true|false|yes|no</required><rtexprvalue>true|false|yes|no</rtexprvalue><type>attribute的返回类型（只用当rtexprvalue为真是才有效）</type></attribute>如果tag的某个属性不是必须的，那tag处理类会自动提供一个缺省值。例如，在logic:present这个tag标签中定义了一个属

23、性叫parameter，但它不是必须的，而且它可以被诸如<%= %>的表达式来赋值。<tag><name>present</name><tag-class>org.apache.struts.taglib.logic.PresentTag</tag-class>推荐精选<body-content>JSP</body-content><attribute><name>parameter</name><required>false</required

24、><rtexprvalue>true</rtexprvalue></attribute></tag>属性元素的校验有关于tag标签的有效值可以从tag库的说明文档中获得，当JSP页面被编译时，jsp引擎会强制性地参照TLD中定义的规则进行检查。还有一个方法也可以进行属性元素的校验，就是先继承类TagExtraInfo，然后调用它的isValid方法。这个类同时也起到提供tag中定义的脚本变量信息的作用。IsValid方法通过TagData对象来传递属性信息，它包括着tag的所有的属性名值的信息。由于校验发生在运行时刻，因此这个属性的值将被赋

25、值为TagData.REQUEST_TIME_VALUE。例如tag标签<tt:twa attr1=”value1” />在TLD中定义如下：<attribute><name>attr1</name><required>true</required><rtexprvalue>true</rtexprvalue></attribute>这个定义说明了attr1能在运行期间被赋值。以下的isValid方法检查attr1属性的值是否属于Boolean类型。注意由于attr1能在运行刻被赋值，那

26、么isValid方法必须检查tag用户是否对此tag进行了运行时刻赋值。Public class TwaTEI extends TagExtraInfopublic boolean isValid(Tagdata data)Object o = data.getAttribute(“attr1”);If(o != null && o != TagData.REQUEST_TIME_VALUE)if( ( (String)o).toLowerCase().equals(“true”) |(String)o).toLowerCase().equals(“false”) )retur

27、n true;elsereturn false;else推荐精选return true;带body的tagtag处理类如果tag标签含有内容，那处理方式会略微有些不同，而且还要视tag处理类是否要与body交互的情况而定。如果要与body交互，那我们认为tag处理类要可能要对body进行操作。Tag处理类不与body交互如果tag处理类不与body交互，tag处理类应该实现Tag接口或从TagSupport中派生，如果body要被计算，那么doStartTag方法应返回 EVAL_BODY_INCLUDE，否则应返回SKIP_BODY。如果tag处理类要对body反复运算，则它应该实现Iter

28、ationTag或从TagSupport中派生。如果tag处理类认为body还未计算完的话，那它的doStartTag方法和doAfterBody方法必须返回EVAL_BODY_AGAIN。Tag处理类与body交互如果tag处理类与body交互，那tag处理类应实现BodyTag接口或从BodyTagSupport中派生。这种tag处理类一般要实现doInitBody和doAfterBody方法。Body允许一些方法来读写它的内容。Tag处理类可以调用body内容的getString或getReader方法来从body中提取信息，也可用 writeOut(out) 方法来将body的内容写入

29、到out对象中。其中out对象通过tag处理类的getPreviousOut方法来获得。 如果body的内容需要被计算，那么doStartTag方法必须返回EVAL_BODY_BUFFERED，否则，它将返回 SKIP_BODY。doInitBody 方法此方法在body内容已经设好，但未被计算之前被调用。你可以根据不同的body内容来制定初始化策略。doAfterBody方法此方法在body内容已被计算后进行调用。和doStartTag方法一样，doAfterBody方法返回一个指示符指示是否要继续计算body，如果要继续计算，则doAfterBody应返回EVAL_BODY_BUFFERE

30、D，否则，它应返回SKIP_BODY。release 方法tag处理类调用此方法将它的状态重置为初始状态，并释放所有的私有资源。以下的例子读取body的内容（其中含有一条sql语句），然后将它传递给一个对象，让它进行查询。由于此处body不须重新计算，所以doAfterBody会返回SKIP_BODY。Public class QueryTag extends BodyTagSupportpublic int doAfterBody() throws JspTagExceptionBodyContent bc = getBodyContent();/将body的内容以字符串的格式提取出来推荐精

31、选String query = bc.getString();/清除bodybc.clearBody();tryStatement stmt = connection.createStatement();Result result = stmt.executeQuery(query);catch(SQLException e)throw new JspTagException(“queryTag: “ + e.getMessage() );return SKIP_BODY;body-content元素由于tag可能会有body，你必须用body-content元素来指定body内容的类型：&l

32、t;body-content>JSP|tagdependent</body-content>如果body的内容是定制的或内部的tag、脚本元素、或HTML广本，则归类为JSP类型。其他的类型，比如上面代码所述的?D?D将sql statement类传给 query tag的这种类型应该标为tagdependent。注意：实际上body-content的值并不影响tag处理类对body内容的处理，它仅仅是被tag编辑工具用来描述此body的内容。用tags定义脚本变量tag处理类tag处理类负责创建或设置页面中定义的脚本变量，用pageContext.setAttribute(

33、name,value,scope)或pageContext.setAttribute(name,value)方法来实现。一般来说，tag处理类通过脚本变量的名称来获取它，脚本变量的名称一般可用get方法来获得。如果脚本变量的值依赖于tag处理类中的上下文中某一对象，那它可用pageContext.getAttribute(name,scope)方法来找到那个对象。一般的处理过程是tag处理类先找到脚本变量，再对其进行处理，然后用pageContext.setAttribute(name,object)的方法来设置它的新值。对象的生存周期(scope)如下表：对象的生存周期表名字可访问范围生存周

34、期page当前页面一直有效，除非页面向客户提交响应或重定向到一个新页面request当前页面或当前页面重定向到的页面一直有效，除非页面向客户提交响应session当前页面或在同一浏览器窗口中的页面一直有效,除非关闭当前浏览器、超时、网络故障application整个web应用程序的所有请求一直有效，除非发生网络故障、服务器故障推荐精选提供关于脚本变量的信息以下示例定义了一个名为“book”的脚本变量，用来访问程序中关于书的信息：<bean:define id=”book” name=”bookDB” property=”bookDetails” type=”database.BookDe

35、tails” /><font color=”red” size=”+2” ><%= messages.getString(“CartRemoved”) %><strong><jsp:getProperty name=”book” property=”title” /></strong></font>当包含此tag的JSP页面被编译时，jsp引擎会自动生成关于此book的同步的代码（同步可以避免几个客户同时访问此book时造成的冲突），要生成同步代码，jsp引擎需要知道此脚本变量的如下信息：· 脚本变量名称&

36、#183; 脚本变量所属的类· 此脚本变量是否引用了一个新的或已存在的对象· 此脚本变量的有效性有两种办法可以向jsp引擎提供关于脚本变量的信息：在TLD中定义variable子元素，或用tei-class子元素定义一个额外tag信息类。用variable最简单，但可能降低了一些灵活性。Variable元素Variable元素有如下子元素：· name-given ?D?D 给出的名字，是一个常量· name-from-attribute?D?D 属性名，在编译时给出的属性名name-given或name-from-attribute两者必须选一，但以下

37、子元素是可选的：· variable-class?D?D变量的类型，缺省为java.lang.String。· declare?D?D此脚本变量是否引用了一个新对象，缺省为True。· scope?D?D脚本变量的范围，缺省为NESTED。下表描述了scope的几种类型：脚本变量的有效范围值有效性方法NESTED在tag标签的开始和结束之间如果tag处理类实现BodyTag接口，则在doInitBody和doAfterBody中调用，否则在doStartTag中调用AT_BEGIN从tag标签的开始一直到页面结束如果tag处理类实现BodyTag接口，则在doIn

38、itBody、doAfterBody和doEndTag中调用，否则在doStartTag和doEndTag中调用AT_END从tag标签的结束一直到页面结束在doEndTag中调用推荐精选以struts为例，它的bean:define标签的实现遵循JSP1.1规范，此规范要求使用额外tag信息类来定义脚本变量。Variable元素是JSP1.2规范中加入的。以bean:define标签为例，你可以定义如下variable元素：<tag><variable><name-from-attribute>id</name-from-attribute>&

39、lt;variable-class>database.BookDetails</variable-class> <declare>true</declare><scope>AT_BEGIN</scope></variable></tag>额外tag信息类如果要定义一个额外tag信息类，你要继承javax.servlet.jsp.TagExtraInfo类。一个TagExtraInfo类必须实现getVariableInfo方法，此方法返回一个叫VariableInfo的数组类，它包括如下信息：·

40、 变量名· 变量所属类名· 此变量是否引用了一个新对象· 此变量的有效范围jsp引擎将一个名为data的参数传给getVariableInfo方法，data中包括tag标签中的所有“属性名?D?D属性值”对。它可以用来向VariableInfo对象提供脚本变量的名字和类名。以struts为例，它在bean:define标签中定义了一个名为DefineTei的额外tag信息类，用来向脚本变量提供信息。由于脚本变量的名称（book）和类名（database.BookDetails）是通过tag标签的属性来传递的，它们一般定义在VariableInfo的构建代码中，并且

41、可用data.getAttributeString方法来得到这些信息。如果要允许book脚本变量能在从tag开始直到整个JSP页面结束的范围内都可用的话，那它的范围应设为AT_BEGIN。如下所示：public class DefineTei extends TagExtraInfopublic VariableInfo getVariableInfo(TagData data)String type = data.getAttributeString(“type”);If( type = null)type = “java.lang.Object”;return new VariableIn

42、fo new VariableInfo(data.getAttributeString(“id”),type,true,VariableInfo.AT_BEGIN)推荐精选;注意：关于额外tag信息类的类名必须要在TLD中的tag标签下的tei-class子元素中定义。因此，DefineTei的tei-class中的定义看起来如下：<tei-class>org.apache.struts.taglib.bean.DefineTagTei</tei-class>具有协作关系的tagtag通过共享对象来进行协作，JSP技术支持2种方式的对象共享。第一种方法是使用pageContext对象进行对象的共享（可支持JSP页面和tag处理类之间的共享），如果在一个tag处理类中要调用由另一个tag处理类创建的对象，可调用pageContext.getAttribute(name, scope)方法。第二各方式的共享是对于tag之间有嵌套关系而言的，外层的tag所创建的对象对于内层的tag来说是可以共用的。这种形式的共享的好处是减少了可能存在的重名冲突。要访问一个嵌套tag创建的对象，tag处理类必须先找到此嵌套tag对象，可用TagSupport的静态方法 TagSupport.findAncestorWithClass(from, class)或T