标准的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 带属性的tag o 带body的tag o 定义了脚本变量的tag o 具有协作关系的tag · 自定义tag标签 o 一个迭代tag的例子 o 一个模板tag库 o 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程序员必须做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的元素: <taglib> <taglib-uri>/tutorial-template</taglib-uri> <taglib-location> /WEB-INF/tutorial-template.tld </taglib-location> </taglib>
<tt:tag> body </tt:tag>
<tt:tag />
一个没有body和属性的tag标签如下: <tt:simple />
你可以用一个String常量给一个属性赋值,也可以通过表达式给它赋值,如<%= ...%>。以struts为例,它的logic:present标签就是用的String常量来给属性赋值: <loglic:present parameter = Clear> 而另一个标签logic:iterate是用表达式来给属性赋值: <logci:iterate collection=<%= bookDB.getBooks() %> id=book type=database.BookDetails>
一个自定义标签可以包含其它自定义标签、脚本变量、HTML标记或其它内容。 在下述例子中,此JSP页面使用了struts的logic:present标签,如果些标签定义了parameter=Clear的属性,则将清除购物车的内容,然后打印出一条信息: <logic:present parameter=Clear> <% cart.clear(); %> <font color=#ff0000 size=+2><strong> 你选择了清除购物车! </strong></font> </logic:present>
如上所述,我们既可以通过属性,也可以通过body来传递信息。但一般来说,比较简单的类型,如字符串或简单表达式最好采用属性来传递信息。
所谓脚本变量,是指JSP中可以调用的变量或对象。它可由tag标签产生。以下示例阐述了一个tag标签定义了一个名为tx的由JNDI所定义的事务处理对象。脚本变量可以是ejb对象、事务、数据库连接等等: <tt:lookup id=tx type=UserTransaction name=java:comp/UserTransaction /> <% tx.begin(); %> ...
自定义tag标签之间可以通过共享对象来实现协作。在下述例子中,标签tag1创建了一个名为obj1的对象,在标签tag2仍可以重复使用obj。 <tt:tag1 attr1=obj1 value1=value /> <tt:tag2 attr1=obj1 /> 在以下这个例子当中,如果外层的tag标签创建了一个对象,那么其内层的所有tag标签都可以使用这个对象。由于这样产生的对象没有一个指定的名字,那么就可以将少重名的冲突。这个例子阐述了一系列协作的嵌套对象。 <tt:outerTag> <tt:innerTag /> </tt:outerTag> Tag处理类
当JSP引擎看到自己的JSP页面中包含有tag标签时,它会调用doStartTag方法来处理tag标签的开头,调用doEndTag方法来处理tag标签的结束。 下表说明不同类型的tag所需要不同的处理过程: Tag处理类的方法 Tag标签类型 基本标签 带属性的标签 带内容的标签 带内容的标签,且内容重复循环 带内容的标签,且内容与JSP交互 一个tag处理类可以通过javax.servlet.jsp.PageContext来与JSP交互,通过javax.servlet.jsp.PageContext类,tag处理类可以访问JSP中的request、session和application对像。 如果tag标签是互相嵌套的,那内层的tag处理类可以通过它的parent属性来访问上层的tag处理类。 一般情况都将所有的tag处理类打成了JAR的包,以便于发布。
TLD的文件扩展名必须为.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" "">
Element tlib-version jsp-version short-name uri display-name small-icon large-icon description listener tag Listener元素 一个tag库可能定义一些类做为它的事件侦听类,这些类在TLD中被称为listener 元素,jsp服务器将会实例化这些侦听类,并且注册它们。Listener元素中有一个叫listener-class的子元素,这个元素的值必须是该侦听类的完整类名。 Tag元素 每个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。其中脚本变量的值可以直接在TLD中定义或通过tag附加信息的类来取得。每个属性描述了这个属性是否可以省略,它的值是否可以通过<%= …%>这样的JSP语法来获得,以及属性的类型。 每一个tag在TLD中对应一个tag元素,下表是tag元素的子元素: Tag元素的子元素 元素名称 name tag-class tei-class body-content display-name small-icon large-icon description variable attribute 以下章节介绍对于不同类型的tag,如何具体地实现它们。
简单的tag处理类必须实现Tag接口的doStartTag和doEndTag方法。当jsp引擎碰到tag标签的开头时,doStartTag被调用,因为简单的tag没有body,所以此方法将返回 SKIP_BODY。当jsp引擎碰到tag标签的结尾时,doEndTag被调用,如果余下的页面还要被计算,那它将返回EVAL_PAGE,否则将会返回SKIP_PAGE。 以下是例子:对于标签 <tt:simple /> ,它的tag处理类实现如下:
{ 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; } }
<body-content>empty</body-content>
对于tag标签的每个属性,你必须依照JavaBeans规范来定义其属性,以及get和set方法。以struts的logic:present 标签为例, <logic:present parameter=Clear> 与此相应,此tag处理类应有如下方法和定义:
public String getParameter() { return this.parameter; } public void setParameter(String parameter) { this.parameter = parameter; }
Attribute元素 对于tag标签的每个属性,你必须定义它是否必须的,它的值是否可以用诸如<%= …%>的表达式来获得,以及它的类型(可选),如果不指定它的类型,那就默认为是java.lang.String类型。如果rtexprvalue元素被定义为true或yes,那么在type元素中就定义了attribute的返回类型。 <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标签中定义了一个属性叫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> <rtexprvalue>true</rtexprvalue> </attribute> … </tag>
还有一个方法也可以进行属性元素的校验,就是先继承类TagExtraInfo,然后调用它的isValid方法。这个类同时也起到提供tag中定义的脚本变量信息的作用。 IsValid方法通过TagData对象来传递属性信息,它包括着tag的所有的属性名-值的信息。由于校验发生在运行时刻,因此这个属性的值将被赋值为TagData.REQUEST_TIME_VALUE。 例如tag标签<tt:twa attr1=value1 />在TLD中定义如下: <attribute> <name>attr1</name> <required>true</required> <rtexprvalue>true</rtexprvalue> </attribute>
以下的isValid方法检查attr1属性的值是否属于Boolean类型。注意由于attr1能在运行刻被赋值,那么isValid方法必须检查tag用户是否对此tag进行了运行时刻赋值。
{ 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处理类不与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处理类调用此方法将它的状态重置为初始状态,并释放所有的私有资源。
{ 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>JSP|tagdependent</body-content>
注意:实际上body-content的值并不影响tag处理类对body内容的处理,它仅仅是被tag编辑工具用来描述此body的内容。
tag处理类
如果脚本变量的值依赖于tag处理类中的上下文中某一对象,那它可用pageContext.getAttribute(name,scope)方法来找到那个对象。一般的处理过程是tag处理类先找到脚本变量,再对其进行处理,然后用pageContext.setAttribute(name,object)的方法来设置它的新值。 对象的生存周期(scope)如下表: 对象的生存周期表 名字 page request session application 提供关于脚本变量的信息 以下示例定义了一个名为book的脚本变量,用来访问程序中关于书的信息: <bean:define id=book name=bookDB property=bookDetails type=database.BookDetails /> <font color=red size=+2 > <%= messages.getString(CartRemoved) %> <strong><jsp:getProperty name=book property=title /></strong> </font> 当包含此tag的JSP页面被编译时,jsp引擎会自动生成关于此book的同步的代码(同步可以避免几个客户同时访问此book时造成的冲突),要生成同步代码,jsp引擎需要知道此脚本变量的如下信息: · 脚本变量名称 · 脚本变量所属的类 · 此脚本变量是否引用了一个新的或已存在的对象 · 此脚本变量的有效性 有两种办法可以向jsp引擎提供关于脚本变量的信息:在TLD中定义variable子元素,或用tei-class子元素定义一个额外tag信息类。用variable最简单,但可能降低了一些灵活性。 Variable元素 Variable元素有如下子元素: · name-given ?D?D 给出的名字,是一个常量 · name-from-attribute?D?D 属性名,在编译时给出的属性名 name-given或name-from-attribute两者必须选一,但以下子元素是可选的: · variable-class?D?D变量的类型,缺省为java.lang.String。 · declare?D?D此脚本变量是否引用了一个新对象,缺省为True。 · scope?D?D脚本变量的范围,缺省为NESTED。下表描述了scope的几种类型: 脚本变量的有效范围 值 NESTED AT_BEGIN AT_END 以struts为例,它的bean:define标签的实现遵循JSP1.1规范,此规范要求使用额外tag信息类来定义脚本变量。Variable元素是JSP1.2规范中加入的。以bean:define标签为例,你可以定义如下variable元素: <tag> <variable> <name-from-attribute>id</name-from-attribute> <variable-class>database.BookDetails</variable-class> <declare>true</declare> <scope>AT_BEGIN</scope> </variable> </tag> 额外tag信息类 如果要定义一个额外tag信息类,你要继承javax.servlet.jsp.TagExtraInfo类。一个TagExtraInfo类必须实现getVariableInfo方法,此方法返回一个叫VariableInfo的数组类,它包括如下信息: · 变量名 · 变量所属类名 · 此变量是否引用了一个新对象 · 此变量的有效范围 jsp引擎将一个名为data的参数传给getVariableInfo方法,data中包括tag标签中的所有属性名?D?D属性值对。它可以用来向VariableInfo对象提供脚本变量的名字和类名。 以struts为例,它在bean:define标签中定义了一个名为DefineTei的额外tag信息类,用来向脚本变量提供信息。由于脚本变量的名称(book)和类名(database.BookDetails)是通过tag标签的属性来传递的,它们一般定义在VariableInfo的构建代码中,并且可用data.getAttributeString方法来得到这些信息。如果要允许book脚本变量能在从tag开始直到整个JSP页面结束的范围内都可用的话,那它的范围应设为AT_BEGIN。如下所示:
{ 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) }; } }
第一种方法是使用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对象。
{ 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(); } } }
<tt:connection id=con01 ...> ... </tt:connection> <tt:query id=balances connection=con01 > SELECT account, balance FROM acct_table where customer_num = <%= request.getCustno() %> </tt:query> 或 <tt:connection ...> <x:query id=balances> SELECT account, balance FROM acct_table where customer_num = <%= request.getCustno() %> </x:query> </tt:connection> 与此同时,在TLD中必须指定connection属性为可选的,定义如下: <tag> ... <attribute> <name>connection</name> <required>false</required> </attribute> </tag> |