摘要:标准的JSP 标记可以调用JavaBeans组件或者执行客户的请求,这大大降低了JSP开发的复杂度和维护量。JSP技
术也允许你自定义taglib,其实换句话说,taglib可以看成是对JSP标记的一种扩展,正如xml是对html的一种扩展一样。taglib通常
定义在tag标签库中,这种标签库存放着你自己定义的tag标签。简而言之,如果使用taglib,那么你可以设计自己的JSP标记!一
般来说,自定义tag标签主要用于操作隐藏对象、处理html提交表单、访问数据库或其它企业级的服务,诸如邮件和目录操作等等。自定义tag标签的使用
者一般都是那些对java编程语言非常精通,而且对数据访问和企业级服务访问都非常熟悉的程序员,对于HTML设计者来说,使得他可以不去关注那些较复杂
的商业逻辑,而将精力放在网页设计上。同时,它也将库开发者和库使用者进行合理分工,自定义tag标签将那些重复工作进行封装,从而大大提高了生产力,而
且可以使得tag库可用于不同的项目中,完美地体现了软件复用的思想。在这篇文章中,我们主要讨论:· 什么是自定义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引擎编译成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标签之前声明)<%@ taglib uri=”/WEB-INF/tutorial-template.tld” prefix=”tt” %>uri属性定义了唯一的标签库描述(以下简称TLD),它可以是直接是tld文件名或一个独一无二的名字。prefix是用来区别其它TLD中和本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中定义此逻辑名称与tld文件之间的映射,具体做法是在web.xml中加入一个名为taglib的元素:
实现此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标签
自定义标签可以有自己的属性。属性一般在开始标记中定义,语法为 attr=”value”。属性的作用相当于自定义标签的一个参数,它影响着tag处理类的行为。你可以在TLD中详细定义它。你可以用一个String常量给一个属性赋值,也可以通过表达式给它赋值,如<%= ...%>。以struts为例,它的logic:present标签就是用的String常量来给属性赋值:
带body的tag标签
一个自定义标签可以包含其它自定义标签、脚本变量、HTML标记或其它内容。在下述例子中,此JSP页面使用了struts的logic:present标签,如果些标签定义了parameter=”Clear”的属性,则将清除购物车的内容,然后打印出一条信息:
到底是用属性还是用body来传递信息?
如上所述,我们既可以通过属性,也可以通过body来传递信息。但一般来说,比较简单的类型,如字符串或简单表达式最好采用属性来传递信息。
定义脚本变量的tag标签
所谓脚本变量,是指JSP中可以调用的变量或对象。它可由tag标签产生。以下示例阐述了一个tag标签定义了一个名为tx的由JNDI所定义的事务处理对象。脚本变量可以是ejb对象、事务、数据库连接等等:
具有协作关系的tag标签
自定义tag标签之间可以通过共享对象来实现协作。在下述例子中,标签tag1创建了一个名为obj1的对象,在标签tag2仍可以重复使用obj。
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的版本,例如:TLD必须以
个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。其中脚本变量的值可以直接在TLD中定义或通过tag附加信息的类来取得。每
个属性描述了这个属性是否可以省略,它的值是否可以通过<%= …%>这样的JSP语法来获得,以及属性的类型。每一个tag在TLD中对应一个tag元素,下表是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提供脚本变量的信息(同tei-class)(可选)attributeTag标签的属性名以下章节介绍对于不同类型的tag,如何具体地实现它们。
简单的tag
tag处理类简
单的tag处理类必须实现Tag接口的doStartTag和doEndTag方法。当jsp引擎碰到tag标签的开头时,doStartTag被调用,
因为简单的tag没有body,所以此方法将返回 SKIP_BODY。当jsp引擎碰到tag标签的结尾时,doEndTag被调用,如果余下的页面还
要被计算,那它将返回EVAL_PAGE,否则将会返回SKIP_PAGE。以下是例子:对于标签
public SimpleTag extends TagSupport
{
public int doStartTag() throws JspException
{
try{
pageContext.getOut().print(“Hello.”);
}catch(Exception e){
throw new JspTagException(“SimpleTag: “ + e.getMessage());
}
return SKIP_BODY;
}
public int doEndTag()
{
return EVAL_PAGE;
}
}
注意:如果tag标签没有内容的话,那必须定义body-content元素为空,例如
带属性的tag标签
tag处理类对于tag标签的每个属性,你必须依照JavaBeans规范来定义其属性,以及get和set方法。以struts的logic:present 标签为例,
protected String parameter = null;
public String getParameter()
{
return this.parameter;
}
public void setParameter(String parameter)
{
this.parameter = parameter;
}
注意:如果你的属性名为id,而且你的tag处理类是从TagSupport类继承的,那你就不需要定义它的属性和set和get方法,因为他们早已在TagSupport被定义过了。Attribute元素对
于tag标签的每个属性,你必须定义它是否必须的,它的值是否可以用诸如<%= …%>的表达式来获得,以及它的类型(可选),如果不指定它
的类型,那就默认为是java.lang.String类型。如果rtexprvalue元素被定义为true或yes,那么在type元素中就定义了
attribute的返回类型。
属性元素的校验
有关于tag标签的有效值可以从tag库的说明文档中获得,当JSP页面被编译时,jsp引擎会强制性地参照TLD中定义的规则进行检查。还有一个方法也可以进行属性元素的校验,就是先继承类TagExtraInfo,然后调用它的isValid方法。这个类同时也起到提供tag中定义的脚本变量信息的作用。IsValid方法通过TagData对象来传递属性信息,它包括着tag的所有的属性名-值的信息。由于校验发生在运行时刻,因此这个属性的值将被赋值为TagData.REQUEST_TIME_VALUE。例如tag标签
Public class TwaTEI extends TagExtraInfo
{
public 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”) )
return true;
else
return false;
}
else
return true;
}
}
带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。
Public class QueryTag extends BodyTagSupport
{
public int doAfterBody() throws JspTagException
{
BodyContent bc = getBodyContent();
//将body的内容以字符串的格式提取出来
String query = bc.getString();
//清除body
bc.clearBody();
try{
Statement 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内容的类型:
用tags定义脚本变量
tag处理类
tag
处理类负责创建或设置页面中定义的脚本变量,用pageContext.setAttribute(name,value,scope)或
pageContext.setAttribute(name,value)方法来实现。一般来说,tag处理类通过脚本变量的名称来获取它,脚本变量的
名称一般可用get方法来获得。如果脚本变量的值依赖于tag处理类中的上下文中某一对象,那它可用
pageContext.getAttribute(name,scope)方法来找到那个对象。一般的处理过程是tag处理类先找到脚本变量,再对其进
行处理,然后用pageContext.setAttribute(name,object)的方法来设置它的新值。对象的生存周期(scope)如下表:对象的生存周期表名字可访问范围生存周期page当前页面一直有效,除非页面向客户提交响应或重定向到一个新页面request当前页面或当前页面重定向到的页面一直有效,除非页面向客户提交响应session当前页面或在同一浏览器窗口中的页面一直有效,除非关闭当前浏览器、超时、网络故障application整个web应用程序的所有请求一直有效,除非发生网络故障、服务器故障提供关于脚本变量的信息以下示例定义了一个名为“book”的脚本变量,用来访问程序中关于书的信息:
struts为例,它在bean:define标签中定义了一个名为DefineTei的额外tag信息类,用来向脚本变量提供信息。由于脚本变量的名称
(book)和类名(database.BookDetails)是通过tag标签的属性来传递的,它们一般定义在VariableInfo的构建代码
中,并且可用data.getAttributeString方法来得到这些信息。如果要允许book脚本变量能在从tag开始直到整个JSP页面结束的
范围内都可用的话,那它的范围应设为AT_BEGIN。如下所示:
public class DefineTei extends TagExtraInfo
{
public VariableInfo[] getVariableInfo(TagData data)
{
String type = data.getAttributeString(“type”);
If( type == null)
type = “java.lang.Object”;
return new VariableInfo[] {
new VariableInfo(data.getAttributeString(“id”),
type,
true,
VariableInfo.AT_BEGIN)
};
}
}
注意:关于额外tag信息类的类名必须要在TLD中的tag标签下的tei-class子元素中定义。因此,DefineTei的tei-class中的定义看起来如下:
具有协作关系的tag
tag通过共享对象来进行协作,JSP技术支持2种方式的对象共享。第一种方法是使用pageContext对象进行对象的共享(可支持JSP页面和tag处理类之间的共享),如果在一个tag处理类中要调用由另一个tag处理类创建的对象,可调用pageContext.getAttribute(name, scope)方法。第二各方式的共享是对于tag之间有嵌套关系而言的,外层的tag所创建的对象对于内层的tag来说是可以共用的。这种形式的共享的好处是减少了可能存在的重名冲突。要
访问一个嵌套tag创建的对象,tag处理类必须先找到此嵌套tag对象,可用TagSupport的静态方
法 TagSupport.findAncestorWithClass(from, class)或TagSupport.getParent方法。前
者在当不确定此tag是否为嵌套tag对象时使用。一旦它的父类被找到,它就能访问其所有动态或静态创建的对象。静态创建的对象是父类的成员,而动态创建
的对象可能是父类的私有对象。诸如此类的对象可以用tag处理类的setValue方法来保存,用getValue方法来获得。下例阐述
了以上两种共享对象的方法。在这个例子当中,一个查询tag检查一个名为connection的属性名是否在doStartTag中被设置。如果
connection属性被设置,tag处理类从pageContext中得到这个connection对象。否则,此tag处理类先找到它的父tag处
理类,然后从它的父tag处理类中找到connection对象。
public class QueryTag extends BodyTagSupport
{
private String connectionId;
public int doStartTag() throws JspException
{
String cid = getConnection();
if(cid != null)
{
//存在一个connection id,使用它。
connection = (Connection) pageContext.getAttribute(cid);
}
else
{
ConnectionTag ancestorTag = (ConnectionTag)findAncestorWithClass(this,
ConnectionTag.class);
if(ancestorTag == null)
{
throw new JspTagException(“一个没有connection属性的查询标签必须被一个connection标记嵌套。”);
}
connection = ancestorTag.getConnection();
}
}
}
此查询标签在JSP页面中的调用形式可以从以下2种定义中任选一种: