taglib 自定义标签

来源：互联网发布：淘宝可以买到美沙酮吗编辑：程序博客网时间：2024/06/04 19:49

taglib自定义标签

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

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

[1]提供属性的set方法，此后这个属性就可以在jsp页面设置。以jstl标签为例 c:outvalue=""/，这个value就是jsp数据到tag之间的入口。所以tag里面必须有一个setValue方法，具体的属性可以不叫value。例如setValue(Stringdata){this.data = data;}
这个“value”的名称是在tld里以attribute元素存在的。
取什么名字都可以，只需tag里提供相应的set方法即可。

[2]处理 doStartTag 或 doEndTag 。这两个方法是 TagSupport提供的。还是以c:outvalue=""/为例，当jsp解析这个标签的时候，在“<”处触发 doStartTag事件，在“>”时触发 doEndTag 事件。通常在 doStartTag里进行初始化,流程选择操作，在 doEndTag 里后续页面输出控制。
[3]编写tld文件,就是把编写的tag组件的信息以mxl形式告诉容器,它才好以一定步骤解释tag组件
[4]在jsp页面导入tld。这样，你的jsp页面就可以使用自己的tag组件了。

通常你会发现自己绝大多数活动都集中在 doStartTag 或doEndTag方法里,如果在服务器端处理标签中的正文或则是嵌套标签时的话,还是过问一下doAfterBody。
一个简单的例子：OutputTag
1.
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);
　　} catch (Exception e) { throw new JspException(e); }
return EVAL_PAGE;
}
}

public class HelloWorldTag extends SimpleTagSupport {

   @Override
   public void doTag() throws JspException, IOException {
       System.out.println("do tag execute");

       //获取out 对象
       JspWriter out = getJspContext().getOut();
       //获取标签体的内容，并输出
       getJspBody().invoke(out);
       out.write("<h1>hello world</h1>");
   }
}

简要说明：
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="UTF-8"?>
<taglib
   xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="
   http://java.sun.com/xml/ns/javaee
   http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd"

version="2.1">

<description>我的自定义标签</description>
   <display-name>自定义标签</display-name>
   <tlib-version>1.0</tlib-version>
   <short-name>m</short-name>
   <uri>/mytags</uri>

   <tag>
       
       <description>输出hello world</description>
       
       <name>hello</name>
       
       <tag-class>com.test.web.tag.HelloWorldTag</tag-class>
       
       

       <body-content>tagdependent</body-content>
   </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:outvalue=""/里的value。名字可任意取，只要类里提供相应的set方法即可。
required：是否必填属性。
rtexprvalue：是否支持运行时表达式取值就是是否可以<%=%>或则是${}方式传值。
这是tag的强大功能。
编写jsp页面

<%@ page language="java"%>
<%@ taglib uri="/WEB-INF/tlds/test.tld"prefix="test"%>
<html>
<body>
Test Tag: <test:outname="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中使用

方式：

1.继承SimpleTagSupport，实现doTag()方法，在WEN-INF下创建*.tld文件并配置

2.直接在WEB-INF下创建tags的文件夹并创建*.tag的文件，文件名就是标签名

0 0