标准的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?
一个自定义的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的元素:
<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包的形式存在的话,那可以放在当前应用的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标签
自定义标签可以有自己的属性。属性一般在开始标记中定义,语法为 attr=”value”。属性的作用相当于自定义标签的一个参数,它影响着tag处理类的行为。你可以在tld中详细定义它。
你可以用一个string常量给一个属性赋值,也可以通过表达式给它赋值,如<%= ...%>。以struts为例,它的logic:present标签就是用的string常量来给属性赋值:
<loglic:present parameter = “clear”>
而另一个标签logic:iterate是用表达式来给属性赋值:
<logci:iterate collection=”<%= bookdb.getbooks() %>”
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”><strong>
你选择了清除购物车!
</strong></font>
</logic:present>
到底是用属性还是用body来传递信息?
如上所述,我们既可以通过属性,也可以通过body来传递信息。但一般来说,比较简单的类型,如字符串或简单表达式最好采用属性来传递信息。
定义脚本变量的tag标签
所谓脚本变量,是指jsp中可以调用的变量或对象。它可由tag标签产生。以下示例阐述了一个tag标签定义了一个名为tx的由jndi所定义的事务处理对象。脚本变量可以是ejb对象、事务、数据库连接等等:
<tt:lookup id=”tx” type=”usertransaction” name=”java:comp/usertransaction” />
<% tx.begin(); %>
...
具有协作关系的tag标签
自定义tag标签之间可以通过共享对象来实现协作。在下述例子中,标签tag1创建了一个名为obj1的对象,在标签tag2仍可以重复使用obj。
<tt:tag1 attr1=”obj1” value1=”value” />
<tt:tag2 attr1=”obj1” />
在以下这个例子当中,如果外层的tag标签创建了一个对象,那么其内层的所有tag标签都可以使用这个对象。由于这样产生的对象没有一个指定的名字,那么就可以将少重名的冲突。这个例子阐述了一系列协作的嵌套对象。
<tt:outertag>
<tt:innertag />
</tt: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的版本,例如:
<?xml version="1.0" encoding="iso-8859-1" ?>
<!doctype taglib public "-//sun microsystems, inc.//dtd jsp tag library 1.2//en" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
tld必须以<taglib>来作为它的根元素,<taglib>的子元素如下表:
<taglib>的子元素
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。
以下是例子:对于标签 <tt:simple /> ,它的tag处理类实现如下:
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元素为空,例如
<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 setparameter(string parameter)
{
this.parameter = parameter;
}
注意:如果你的属性名为id,而且你的tag处理类是从tagsupport类继承的,那你就不需要定义它的属性和set和get方法,因为他们早已在tagsupport被定义过了。
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>
属性元素的校验
有关于tag标签的有效值可以从tag库的说明文档中获得,当jsp页面被编译时,jsp引擎会强制性地参照tld中定义的规则进行检查。
还有一个方法也可以进行属性元素的校验,就是先继承类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>
这个定义说明了attr1能在运行期间被赋值。
以下的isvalid方法检查attr1属性的值是否属于boolean类型。注意由于attr1能在运行刻被赋值,那么isvalid方法必须检查tag用户是否对此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内容的类型:
<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(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”的脚本变量,用来访问程序中关于书的信息:
<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
在tag标签的开始和结束之间
如果tag处理类实现bodytag接口,则在doinitbody和doafterbody中调用,否则在dostarttag中调用
at_begin
从tag标签的开始一直到页面结束
如果tag处理类实现bodytag接口,则在doinitbody、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>
<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 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中的定义看起来如下:
<tei-class>
org.apache.struts.taglib.bean.definetagtei
</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种定义中任选一种:
<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>
菜鸟学堂:新闻热点
疑难解答