随笔档案(496)

标准的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被定义过了。