JSP自定义标签详细.docx
《JSP自定义标签详细.docx》由会员分享，可在线阅读，更多相关《JSP自定义标签详细.docx（18页珍藏版）》请在冰豆网上搜索。
JSP自定义标签详细
JSP标签库
在这篇文章中，我们主要讨论：
·什么是自定义tag标签？
·怎么使用tag标签？
o声明要使用的tag库
o找到与之对应的tag处理类
otag标签的类型
·自定义tag标签
otag处理类
otag库描述
otag标签示例
o带属性的tag
o带body的tag
o定义了脚本变量的tag
o具有协作关系的tag
·自定义tag标签
o一个迭代tag的例子
o一个模板tag库
otag处理类到底是怎样被调用的？
什么是自定义的tag?
一个自定义的tag标签是用户定义的一种JSP标记。
当一个含有自定义的tag标签的JSP页面被jsp引擎编译成servlet时，tag标签被转化成了对一个称为tag处理类的对象进行的操作。
于是当JSP页面被jsp引擎转化为servlet后，实际上tag标签被转化成为了对tag处理类的操作。
自定义tag标签有很多特色，诸如：
·可以在JSP页面中自定义tag标签的属性
·访问JSP页面中的所有对象
·可以动态地修改页面输出
·彼此这间可以相互通信。
你可以先创建一个JavaBeans组件，然后在一个tag中调用此JavaBeans组件，同时可以在另一个tag中调用它。
·tag允许相互嵌套，可以在一个JSP页面中完成一些复杂的交互。
使用tag标签
本节主要描述怎样在JSP页面中使用tag标签，以及tag标签的不同类型。
要使用tag标签，JSP程序员必须做2件事：
·声明此tag标签的tag库
·实现此tag标签
声明tag标签所在的tag库
如果要使用tag标签，则应用JSP的taglib指示符来指定其tag库（注意：
taglib要在在使用此tag标签之前声明）
<%tagliburi=”/WEB-INF/tutorial-template.tld”prefix=”tt”%>
uri属性定义了唯一的标签库描述（以下简称TLD），它可以是直接是tld文件名或一个独一无二的名字。
prefix是用来区别其它TLD中和本TLD中有重名的tag的一种手段。
TLD必须以.tld作为扩展名，并且存放在当前应用的WEB-INF目录或其子目录下。
你可以通过它的文件名直接引用它，也可以通过别的方式间接地引用它。
以下taglib指示符直接引用一个TLD：
<%tagliburi=”/WEB-INF/tutorial-template.tld”prefix=”tt”%>
以下的taglib指示符通过一个逻辑名称间接地引用一个TLD：
<%tagliburi=”/tutorial-template”prefix=”tt”%>
如果是间接引用TLD的话，那你必须还要在web.xml中定义此逻辑名称与tld文件之间的映射，具体做法是在web.xml中加入一个名为taglib的元素：
/tutorial-template
/WEB-INF/tutorial-template.tld
实现此tag标签
为了实现tag标签，你有2种方法来存放tag处理类。
一、让tag处理类以.class的方式存放于当前应用的WEB-INF/class子目录下，二、如果tag处理类是以JAR包的形式存在的话，那可以放在当前应用的WEB-INF/lib目录下，如果tag处理类要在多个应用中共享，那么它就应放在jsp服务器上的common/lib目录下，对于tomcat来说，就是tomcat/common/lib目录下。
tag标签类型
自定义的tag标签遵循XML语法。
它有一个开始标记和一个结束标记，有的还有body（即文本节点）：
tag>
body
tag>
一个不带body的tag标签如下：
tag/>
简单的tag标签
一个没有body和属性的tag标签如下：
simple/>
带属性的tag标签
自定义标签可以有自己的属性。
属性一般在开始标记中定义，语法为attr=”value”。
属性的作用相当于自定义标签的一个参数，它影响着tag处理类的行为。
你可以在TLD中详细定义它。
你可以用一个String常量给一个属性赋值，也可以通过表达式给它赋值，如<%=...%>。
以struts为例，它的logic:
present标签就是用的String常量来给属性赋值：
presentparameter=“Clear”>
而另一个标签logic:
iterate是用表达式来给属性赋值：
iteratecollection=”<%=bookDB.getBooks（）%>”
id=”book”type=”database.BookDetails”>
带body的tag标签
一个自定义标签可以包含其它自定义标签、脚本变量、HTML标记或其它容。
在下述例子中，此JSP页面使用了struts的logic:
present标签，如果些标签定义了parameter=”Clear”的属性，则将清除购物车的容，然后打印出一条信息：
presentparameter=”Clear”>
<%cart.clear（）;%>
你选择了清除购物车！
present>
到底是用属性还是用body来传递信息？
如上所述，我们既可以通过属性，也可以通过body来传递信息。
但一般来说，比较简单的类型，如字符串或简单表达式最好采用属性来传递信息。
定义脚本变量的tag标签
所谓脚本变量，是指JSP中可以调用的变量或对象。
它可由tag标签产生。
以下示例阐述了一个tag标签定义了一个名为tx的由JNDI所定义的事务处理对象。
脚本变量可以是ejb对象、事务、数据库连接等等：
lookupid=”tx”type=”UserTransaction”name=”java:
comp/UserTransaction”/>
<%tx.begin（）;%>
...
具有协作关系的tag标签
自定义tag标签之间可以通过共享对象来实现协作。
在下述例子中，标签tag1创建了一个名为obj1的对象，在标签tag2仍可以重复使用obj。
tag1attr1=”obj1”value1=”value”/>
tag2attr1=”obj1”/>
在以下这个例子当中，如果外层的tag标签创建了一个对象，那么其层的所有tag标签都可以使用这个对象。
由于这样产生的对象没有一个指定的名字，那么就可以将少重名的冲突。
这个例子阐述了一系列协作的嵌套对象。
outerTag>
innerTag/>
outerTag>
Tag处理类
Tag处理类必须实现Tag接口或BodyTag接口，不过现在一般都流行从TagSupport或BodyTagSupport类中继承，这些类或接口都可以在javax.servlet.jsp.tagext包中找到。
当JSP引擎看到自己的JSP页面中包含有tag标签时，它会调用doStartTag方法来处理tag标签的开头，调用doEndTag方法来处理tag标签的结束。
下表说明不同类型的tag所需要不同的处理过程：
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处理类可以通过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的文件扩展名必须为.tld，而且必须放在当前WEB应用的WEB-INF目录或其子目录中。
一个TLD的容的开头必须遵守标准的XML开头，用于描述DTD和xml的版本，例如：
xmlversion="1.0"encoding="ISO-8859-1"?
>
DOCTYPEtaglibPUBLIC"-//SunMicrosystems,Inc.//DTDJSPTagLibrary1.2//EN""java.sun./dtd/web-jsptaglibrary_1_2.dtd">
TLD必须以来作为它的根元素，的子元素如下表：
的子元素
Element
Description
tlib-version
Tag库的版本
jsp-version
Tag库所需要的jsp的版本
short-name
助记符，tag的一个别名（可选）
uri
用于确定一个唯一的tag库
display-name
被可视化工具（诸如Jbuilder）用来显示的名称（可选）
small-icon
被可视化工具（诸如Jbuilder）用来显示的小图标（可选）
large-icon
被可视化工具（诸如Jbuilder）用来显示的大图标（可选）
description
对tag库的描述（可选）
listener
参见下面listener元素
tag
参见下面tag元素
Listener元素
一个tag库可能定义一些类做为它的事件侦听类，这些类在TLD中被称为listener元素，jsp服务器将会实例化这些侦听类，并且注册它们。
Listener元素中有一个叫listener-class的子元素，这个元素的值必须是该侦听类的完整类名。
Tag元素
每个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。
其中脚本变量的值可以直接在TLD中定义或通过tag附加信息的类来取得。
每个属性描述了这个属性是否可以省略，它的值是否可以通过<%=…%>这样的JSP语法来获得，以及属性的类型。
每一个tag在TLD中对应一个tag元素，下表是tag元素的子元素：
Tag元素的子元素
元素名称
描述
name
独一无二的元素名
tag-class
Tag标签对应的tag处理类
tei-class
javax.servlet.jsp.tagext.TagExtraInfo的子类，用于表达脚本变量（可选）
body-content
Tag标签body的类型
display-name
被可视化工具（诸如Jbuilder）用来显示的名称（可选）
small-icon
被可视化工具（诸如Jbuilder）用来显示的小图标（可选）
large-icon
被可视化工具（诸如Jbuilder）用来显示的大图标（可选）
description
此tag标签的描述
variable
提供脚本变量的信息（同tei-class）（可选）
attribute
Tag标签的属性名
以下章节介绍对于不同类型的tag，如何具体地实现它们。
简单的tag
tag处理类
简单的tag处理类必须实现Tag接口的doStartTag和doEndTag方法。
当jsp引擎碰到tag标签的开头时，doStartTag被调用，因为简单的tag没有body，所以此方法将返回SKIP_BODY。
当jsp引擎碰到tag标签的结尾时，doEndTag被调用，如果余下的页面还要被计算，那它将返回EVAL_PAGE,否则将会返回SKIP_PAGE。
以下是例子：
对于标签simple/>，它的tag处理类实现如下：
publicSimpleTagextendsTagSupport
{
publicintdoStartTag（）throwsJspException
{
try{
pageContext.getOut（）.print（“Hello.”）;
}catch（Exceptione）{
thrownewJspTagException（“SimpleTag:
“+e.getMessage（））;
}
returnSKIP_BODY;
}
publicintdoEndTag（）
{
returnEVAL_PAGE;
}
}
注意：
如果tag标签没有容的话，那必须定义body-content元素为空，例如
empty
带属性的tag标签
tag处理类
对于tag标签的每个属性，你必须依照JavaBeans规来定义其属性，以及get和set方法。
以struts的logic:
present标签为例，
presentparameter=”Clear”>
与此相应，此tag处理类应有如下方法和定义：
protectedStringparameter=null;
publicStringgetParameter（）
{
returnthis.parameter;
}
publicvoidsetParameter（Stringparameter）
{
this.parameter=parameter;
}
注意：
如果你的属性名为id，而且你的tag处理类是从TagSupport类继承的，那你就不需要定义它的属性和set和get方法,因为他们早已在TagSupport被定义过了。
Attribute元素
对于tag标签的每个属性，你必须定义它是否必须的，它的值是否可以用诸如<%=…%>的表达式来获得，以及它的类型（可选），如果不指定它的类型，那就默认为是java.lang.String类型。
如果rtexprvalue元素被定义为true或yes，那么在type元素中就定义了attribute的返回类型。
attr1
true|false|yes|no
true|false|yes|no
attribute的返回类型（只用当rtexprvalue为真是才有效）
如果tag的某个属性不是必须的，那tag处理类会自动提供一个缺省值。
例如，在logic:
present这个tag标签中定义了一个属性叫parameter，但它不是必须的，而且它可以被诸如<%=…%>的表达式来赋值。
present
org.apache.struts.taglib.logic.PresentTag
JSP
…
parameter
false
true
…
属性元素的校验
有关于tag标签的有效值可以从tag库的说明文档中获得，当JSP页面被编译时，jsp引擎会强制性地参照TLD中定义的规则进行检查。
还有一个方法也可以进行属性元素的校验，就是先继承类TagExtraInfo，然后调用它的isValid方法。
这个类同时也起到提供tag中定义的脚本变量信息的作用。
IsValid方法通过TagData对象来传递属性信息，它包括着tag的所有的属性名－值的信息。
由于校验发生在运行时刻，因此这个属性的值将被赋值为TagData.REQUEST_TIME_VALUE。
例如tag标签twaattr1=”value1”/>在TLD中定义如下：
attr1
true
true
这个定义说明了attr1能在运行期间被赋值。
以下的isValid方法检查attr1属性的值是否属于Boolean类型。
注意由于attr1能在运行刻被赋值，那么isValid方法必须检查tag用户是否对此tag进行了运行时刻赋值。
PublicclassTwaTEIextendsTagExtraInfo
{
publicbooleanisValid（Tagdatadata）
{
Objecto=data.getAttribute（“attr1”）;
If（o!
=null&&o!
=TagData.REQUEST_TIME_VALUE）
{
if（（（String）o）.toLowerCase（）.equals（“true”）||
（（String）o）.toLowerCase（）.equals（“false”））
returntrue;
else
returnfalse;
}
else
returntrue;
}
}
带body的tag
tag处理类
如果tag标签含有容，那处理方式会略微有些不同，而且还要视tag处理类是否要与body交互的情况而定。
如果要与body交互，那我们认为tag处理类要可能要对body进行操作。
Tag处理类不与body交互
如果tag处理类不与body交互，tag处理类应该实现Tag接口或从TagSupport中派生，如果body要被计算，那么doStartTag方法应返回EVAL_BODY_INCLUDE，否则应返回SKIP_BODY。
如果tag处理类要对body反复运算，则它应该实现IterationTag或从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的容写入到out对象中。
其中out对象通过tag处理类的getPreviousOut方法来获得。
如果body的容需要被计算，那么doStartTag方法必须返回EVAL_BODY_BUFFERED，否则，它将返回SKIP_BODY。
doInitBody方法
此方法在body容已经设好，但未被计算之前被调用。
你可以根据不同的body容来制定初始化策略。
doAfterBody方法
此方法在body容已被计算后进行调用。
和doStartTag方法一样，doAfterBody方法返回一个指示符指示是否要继续计算body，如果要继续计算，则doAfterBody应返回EVAL_BODY_BUFFERED，否则，它应返回SKIP_BODY。
release方法
tag处理类调用此方法将它的状态重置为初始状态，并释放所有的私有资源。
以下的例子读取body的容（其中含有一条sql语句），然后将它传递给一个对象，让它进行查询。
由于此处body不须重新计算，所以doAfterBody会返回SKIP_BODY。
PublicclassQueryTagextendsBodyTagSupport
{
publicintdoAfterBody（）throwsJspTagException
{
BodyContentbc=getBodyContent（）;
//将body的容以字符串的格式提取出来
Stringquery=bc.getString（）;
//清除body
bc.clearBody（）;
try{
Statementstmt=connection.createStatement（）;
Resultresult=stmt.executeQuery（query）;
}catch（SQLExceptione）{
thrownewJspTagException（“queryTag:
“+e.getMessage（））;
returnSKIP_BODY;
}
}
body-content元素
由于tag可能会有body，你必须用body-content元素来指定body容的类型：
JSP|tagdependent
如果body的容是定制的或部的tag、脚本元素、或HTML广本，则归类为JSP类型。
其他的类型，比如上面代码所述的?
D?
D将sqlstatement类传给querytag的这种类型应该标为tagdependent。
注意：
实际上body-content的值并不影响tag处理类对body容的处理，它仅仅是被tag编辑工具用来描述此body的容。
用tags定义脚本变量
tag处理类
tag处理类负责创建或设置页面中定义的脚本变量，用pageContext.setAttribute（name,value,scope）或pageContext.setAttribute（name,value）方法来实现。
一般来说，tag处理类通过脚本变量的名称来获取它，脚本变量的名称一般可用get方法来获得。
如果脚本变量的值依赖于tag处理类中的上下文中某一对象，那它可用pageContext.getAttribute（name,scope）方法来找到那个对象。
一般的处理过程是tag处理类先找到脚本变量，再对其进行处理，然后用pageContext.setAttribute（name,object）的方法来
升级会员 