天天看点

jsp 自定义标签 (taglib) 浅析

        一个 tag 就是一个普通的 java 类,它惟一特别之处是它必须继承 TagSupport 或者 BodyTagSupport 类。这两个类提供了一些方法,负责 jsp 页面和你编写的类之间的交互,例如输入,输出。而这两个类是由 jsp 容器提供的,无须开发人员自己实现。换句话说,你只需把实现了业务逻辑的类继承 TagSupport 或者 BodyTagSupport,再做一些特别的工作,你的类就是一个 Tag 。并且它自己负责和  jsp 页面的交互,不用你多操心。 

“特别的工作”通常有以下几个步骤: 

[1] 提供属性的 set 方法,此后这个属性就可以在 jsp 页面设置。以 jstl 标签为例 c:out value="",这个value就是 jsp 数据到 tag 之间的入口。所以 tag 里面必须有一个 setValue 方法,具体的属性可以不叫 value。例如 setValue(String data){this.data = data;} 

这个 “value” 的名称是在 tld 里以 attribute 元素存在的。 

取什么名字都可以,只需 tag 里提供相应的 set 方法即可。 

[2] 处理 doStartTag 或 doEndTag 。这两个方法是 TagSupport提供的。 还是以 c:out value=""为例,当jsp解析这个标签的时候,在“<”处触发 doStartTag 事件,在“>”时触发 doEndTag 事件。通常在 doStartTag 里进行初始化,流程选择操作,在 doEndTag 里后续页面输出控制。 

[3] 编写 tld 文件,就是把编写的 tag 组件的信息以 xml 形式告诉容器,它才好以一定步骤解释 tag 组件 

[4] 在 jsp 页面导入 tld。这样,你的 jsp 页面就可以使用自己的tag组件了。 

通常你会发现自己绝大多数活动都集中在 doStartTag 或 doEndTag方法里,如果在服务器端处理标签中的正文或则是嵌套标签时的话,还是过问一下doAfterBody。 

一个简单的例子:OutputTag 

package test; 
import javax.servlet.jsp.JspException; 
import javax.servlet.jsp.JspWriter; 
import javax.servlet.jsp.tagext.TagSupport; 

public class OutputTag extends TagSupport { 
private String name=null; 
public void setName(String name) { 
this.name = name; 
} 
public int doEndTag() throws JspException 
{ 
try { 
JspWriter out = pageContext.getOut(); 
out.print("Hello! " + name);    // 输出到jsp页面
}catch (Exception e){ 
          throw new JspException(e); 
     } 
//EVAL_PAGE 表示tag已处理完毕,返回jsp页面。还有几个值,例如 EVAL_BODY_AGAIN 和EVAL_BODY_INCLUDE等 跟流程控制有关. 
return EVAL_PAGE; 
} 
}
           

编写tld 

<?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"> 
<taglib> 
<tlib-version>1.0</tlib-version> 
<jsp-version>1.2</jsp-version> 
<short-name>test</short-name> 
<!--OutputTag--> 
<tag> 
<name>out</name> 
<tag-class>test.OutputTag</tag-class> 
<body-content>empty</body-content> 
<attribute> 
<name>name</name> 
<required>false</required> 
<rtexprvalue>false</rtexprvalue> 
</attribute> 
</tag> 
</taglib>
           

在WEB-INF下新建tlds文件夹,把这个文件取名为test.tld,放到tlds文件夹下。引用时的路径应该这样:WEB-INF\tlds\test.tld 

关于tld的简单说明: 

short-name:taglib 的名称,也称为前缀。比如 “c:out value=""/” 里的 “c” ;

name:tag 的名字。例如 “c:out value=""/” 里的 "out”,我们的类也取名为 out,由于有前缀作区分,不会同其他库的同名 tag 组件混淆 ;

tag-class:完整的 tag 组件路径,记着带包名 ;

body-content:指 tag 之间的内容。例如 c:out value="" ...... /c  起始和关闭标签之间就是 body-content。由于没有处理 body-content ,所以上面设为 empty ,如果是嵌套标签,或则是要在服务器端处理标签体的话,就是 jsp ;

“attribute”里的name:属性名字。例如 c:out value="" 里的 value。名字可任意取,只要类里提供相应的 set 方法即可;

required:是否必填属性; 

rtexprvalue:是否支持运行时表达式取值就是是否可以 <%=%> 或则是 ${} 方式传值。 

这是tag的强大功能。 

编写jsp页面 

<%@ page language="java"%> 
<%@ taglib uri="/WEB-INF/tlds/test.tld" prefix="test"%> 
<html> 
<body> 
Test Tag: <test:out name="TEST"/> 
</body> 
</html> 
           

启动服务器,如果一切按照上面步骤的话,就能看到 Test Tag: Hello! TEST 字样。最简单的tag就这么出来了。并不难,是不是? 

------------------------------------------------------------------ 

Tag 系列的 Interface 里定义的静态int,通过他们也能一窥 tag 组键的执行流程,这几个静态值分别是: 

SKIP_BODY : 跳过了开始和结束标签之间的代码,一般是在 doStartTag 中使用 

EVAL_BODY_INCLUDE  :处理嵌套的标签,一般是在 doStartTag 中使用,由负责处理标签正文的 tag接口提供 

EVAL_BODY_BUFFERED :对包含的内容进行解析 一般是在 doStartTag 中使用,由负责处理标签正文的 bodyTag 接口提供,目的是通知 jsp 容器作好读取正文的工作(创建一个 body-content 包装正文和获取存放操作结果的out对象,便于以后的操作和输出). 

EVAL_BODY_AGAIN: 处理标签正文,嵌套标签的 iteratorTag 接口的使用 

SKIP_PAGE : 忽略剩下的页面,一般是在 doEndTag 中使用 

EVAL_PAGE : 继续执行下面的页, 一般是在 doEndTag 中使用 

转载自:(优质文章)

http://www.iteye.com/topic/157737