标点符(钱魏 Way)

JSP自定义标记taglib学习笔记

一、什么是Taglib?

标记库(tag library),是指由在JSP页面中使用的标记所组成的库。JSP容器推出时带有一个小型的、默认的标记库。而自定义标记库是为了某种特定的用途或者目的,将一些标记放到一起而形成的一种库。在一个团队中协同工作的开发者们可能会为各自的项目创建一些非常特定化的自定义标记库,同时也会创建一个通用自定义标记库,以供当前使用。

标准的JSP 标记可以调用JavaBeans组件或者执行客户的请求,这大大降低了JSP开发的复杂度和维护量。JSP技术也允许你自定义taglib,其实换句话说,taglib可以看成是对JSP标记的一种扩展,正如xml是对html的一种扩展一样。taglib通常定义在tag标签库中,这种标签库存放着你自己定义的tag标签。简而言之,如果使用taglib,那么你可以设计自己的JSP标记。

一个自定义的tag标签是用户定义的一种JSP标记。当一个含有自定义的tag标签的JSP页面被jsp引擎编译成servlet时,tag标签被转化成了对一个称为tag处理类的对象进行的操作。当JSP页面被jsp引擎转化为servlet后,实际上tag标签被转化成为了对tag处理类的操作。

二、自定义tag标签有哪些特性?

  1. 可以在JSP页面中自定义tag标签的属性;
  2. 可以访问JSP页面中的所有对象;
  3. 可以动态地修改页面输出;
  4. 可以彼此之间相互通信;
  5. 可以先创建一个JavaBeans组件,然后在一个tag中调用此JavaBeans组件,同时可以在另一个tag中调用它;
  6. 可以相互嵌套,可以在一个JSP页面中完成一些复杂的交互。

三、如何使用自定义Tag?

1) 声明此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>

2) 实现此tag标签

为了实现tag标签,你有2种方法来存放tag处理类。

  1. 让tag处理类以.class的方式存放于当前应用的WEB-INF/class子目录下;
  2. 如果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 />

1)简单的tag标签

一个没有body和属性的tag标签如下:<tt:simple />

2)带属性的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”>

3)带body的tag标签

一个自定义标签可以包含其它自定义标签、脚本变量、HTML标记或其它内容。在下述例子中,此JSP页面使用了struts的logic:present标签,如果些标签定义了parameter=”Clear”的属性,则将清除购物车的内容,然后打印出一条信息:

<logic:present parameter=”Clear”>
<% cart.clear(); %>
<strong>你选择了清除购物车!</strong>
</logic:present>

如上所述,我们既可以通过属性,也可以通过body来传递信息。但一般来说,比较简单的类型,如字符串或简单表达式最好采用属性来传递信息。

4)定义脚本变量的tag标签

所谓脚本变量,是指JSP中可以调用的变量或对象。它可由tag标签产生。以下示例阐述了一个tag标签定义了一个名为tx的由JNDI所定义的事务处理对象。脚本变量可以是ejb对象、事务、数据库连接等等:

<tt:lookup id=”tx” type=”UserTransaction” name=”java:comp/UserTransaction” />
<% tx.begin(); %>

5)具有协作关系的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标签的结束。

  • 基本标签 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>的子元素如下表:

1)<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的子元素,这个元素的值必须是该侦听类的完整类名。

2)Tag元素

每个tag元素在tag库中都要指出它的名字、类名、脚本变量、tag的属性。其中脚本变量的值可以直接在TLD中定义或通过tag附加信息的类来取得。每个属性描述了这个属性是否可以省略,它的值是否可以通过<%= …%>这样的JSP语法来获得,以及属性的类型。每一个tag在TLD中对应一个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标签的属性名
码字很辛苦,转载请注明来自标点符《JSP自定义标记taglib学习笔记》

评论

  1. 游客 #1

    感谢分享

    回复
    28天前