tablib(tld)

司徒锐进

2023-12-01

标签库的目的在于让开发人员能像使用html标签一样的标签来完成前端的逻辑控制和内容显示，而把那些繁琐、复杂的java代码隐藏在背后。

标签库的组成：

（1）jar文件包。这个部分是标签库的功能实现部分，由java来实现。

（2）tld文件。是tablib library description的缩写，用来描述标签库的，其内容为标签库中所有标签的定义，包括标签名、功能类及各种属性。

一个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里定义的。取什么名字都可以，只需tag里提供相应的set方法即可。

2）处理 doStartTag 或 doEndTag 。这两个方法是 TagSupport提供的。还是以c:out value=""/为例，当jsp解析这个标签的时候，在“<”处触发 doStartTag 事件，在“>”时触发 doEndTag 事件。通常在 doStartTag 里进行逻辑操作，在 doEndTag 里控制输出。
3）编写tld文件。
4）在jsp页面导入tld。这样，你的jsp页面就可以使用自己的tag了。

通常你会发现自己绝大多数活动都集中在 doStartTag 或 doEndTag 方法里。确实如此，熟悉一些接口和类之后，写taglib很容易。正如《jsp设计》的作者所言：里面的逻辑稍微有点复杂，但毕竟没有火箭上天那么难。
一个简单的例子：OutputTag

package diegoyun;

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


/**
 * @author chenys
 */


public class OutputTag extends TagSupport{

 private String name=null; 
 public void setName(String name){
  this.name = name;
 }

public int doStartTag() throws JspException{


try{
   JspWriter out = pageContext.getOut();
   out.print("Hello! "   name);
  }
  catch (Exception e){  
   throw new JspException(e);
  }
  return EVAL_PAGE;
 }  
}

简要说明：
1 如何输出到jsp页面：调用JspWriter JspWriter out = pageContext.getOut();out.print......记住这个方法就可以了。
2 输出后如何作处理，函数会返回几个值之一。EVAL_PAGE 表示tag已处理完毕，返回jsp页面。还有几个值，例如 EVAL_BODY_AGAIN 和EVAL_BODY_INCLUDE等

编写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>diego</short-name> 
<!--OutputTag-->
<tag>
<name>out</name>
<tag-class>diegoyun.OutputTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>name</name>
<required>false</required>
<rtexprvalue>false</rtexprvalue>
</attribute>
</tag>
</taglib>

在WEB-INF下新建tlds文件夹，把这个文件取名为diego.tld，放到tlds文件夹下。路径应该这样：WEB-INF\tlds\diego.tld 。

Web应用启动时，Server容器会在应用的WEB-INF/lib目录下扫描所有的jar文件，从jar文件的META-INF目录中找出所有的tld文件。

关于tld的简单说明：
short-name：taglib的名称，也称为前缀。比如“c:out value=""/” 里的“c”
name：tag的名字。例如“c:out value=""/” 里的"out”，我们的类也取名为out，由于有前缀作区分，不会混淆
tag-class：具体的tag类。带包名
body-content：指tag之间的内容。例如c:out value="" ...... /c 起始和关闭标签之间就是body-content。由于没有处理body-content，所以上面设为empty
“attribute”里的name：属性名字。例如c:out value=""/里的value。名字可任意取，只要类里提供相应的set方法即可。
required：是否必填属性。
rtexprvalue：是否支持运行时表达式取值。这是tag的强大功能。以后我们会讨论。暂时设为false

uri：tld文件的全球标识，如果在jsp文件中引入某个标签，如<%@ taglib prefix="c" uri="myjstl" %>,其中的uri如果是自定义的，不是tld文件中的uri，则需要在web.xml中添加

<taglib>

    <taglib-uri>myjstl</taglib-uri>

    <taglib-location>/WEB-INF/tld/c.tld</taglib-location>

</taglib>

只有这样编译器才能找到对应的tld文件。如果jsp引入标签使用tld文件中使用的uri，则不需要向web.xml中添加内容。

编写jsp页面

<%@ page language="java"%>

<%@ taglib uri="/WEB-INF/tlds/diego.tld" prefix="diego"%> <html> <body> Test Tag: <diego:out name="diegoyun"/> </body> </html>

我的编程环境是eclipse tomcat.启动服务器，如果一切按照上面步骤的话，就能看到 Test Tag: Hello! diegoyun 字样。最简单的tag就这么出来了。并不难

1、 TagSupport与BodyTagSupport的区别

TagSupport与BodyTagSupport的区别主要是标签处理类是否需要与标签体交互，如果不需要交互的就用TagSupport，否则如果需要交互就用BodyTagSupport。
    交互就是标签处理类是否要读取标签体的内容和改变标签体返回的内容。
    用TagSupport实现的标签，都可以用BodyTagSupport来实现，因为BodyTagSupport继承了TagSupport。
2 、doStartTag(),doEndTag()，doAfterBody(),
    doStartTag()方法是遇到标签开始时会呼叫的方法，其合法的返回值是EVAL_BODY_INCLUDE与SKIP_BODY,前者表示将显示标签间的文字，后者表示不显示标签间的文字；
    doEndTag()方法是在遇到标签结束时呼叫的方法，其合法的返回值是EVAL_PAGE与 SKIP_PAGE，前者表示处理完标签后继续执行以下的JSP网页，后者是表示不处理接下来的JSP网页
    doAfterBody()这个方法是在显示完标签间文字之后呼叫的，其返回值有EVAL_BODY_AGAIN与SKIP_BODY，前者会再显示一次标签间的文字，后者则继续执行标签处理的下一步。

最后欢迎大家访问我的个人网站：1024s

tablib(tld)

相关阅读

相关文章

相关问答