JAVA自定义标签

Test.jsp 


 
    <title>My JSP 'Test.jsp' starting page</title>
    This is my JSP page. <br>
    Date :  <br>
    File : <input value="&lt;%= request.getServletPath() %&gt;">

为了将这个这个Test.jsp改成自定义标签方法，我们分别使用简单标签和内容标签两种不同的方式实现。

1. 简单标签

由于我们需要输出两个内容(日期和文件名)，因此我们为标签创建一个参数。具体代码：

DemoTag.java 
package com.mycompany;

import java.util.Date;

import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class DemoTag extends TagSupport {
 
  public int doStartTag() throws JspException {   
    try {
      HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
      JspWriter out = pageContext.getOut();     
     
      if (parameter.compareToIgnoreCase("filename") == 0)
        out.print(request.getServletPath());
      else
        out.print(new Date());
     
    } catch (java.io.IOException e) {
      throw new JspTagException(e.getMessage());
    }
   
    return SKIP_BODY;
  }
 
  private String parameter = "date";
 
  public void setParameter(String parameter) {
    this.parameter = parameter;
  }
 
  public String getParameter() {
    return parameter;
  }
}

接下来，我们创建标签文件 MyTagLib.tld。标签文件其实只是一个XML格式的说明文件，内容也很简单。

MyTagLib.tld 
&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;&lt;taglib&gt;&lt;tlib-version&gt;1.0&lt;/tlib-version&gt;&lt;jsp-version&gt;1.2&lt;/jsp-version&gt;&lt;tag&gt;&lt;name&gt;demo&lt;/name&gt;&lt;tag-class&gt;com.mycompany.DemoTag&lt;/tag-class&gt;&lt;body-content&gt;empty&lt;/body-content&gt;&lt;attribute&gt;&lt;name&gt;parameter&lt;/name&gt;&lt;required&gt;false&lt;/required&gt;&lt;rtexprvalue&gt;true&lt;/rtexprvalue&gt;&lt;/attribute&gt;&lt;/tag&gt;&lt;/taglib&gt;

在这个标签文件中，我们将我们创建的标签取名 demo，并声明了类型和参数(parameter)。将该文件保存在 /WEB-INF 下面。
当然，我们还需要将我们自定义的标签添加到 web.xml 中，否则还是无法使用。

web.xml 
&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemalocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"&gt;&lt;jsp-config&gt;&lt;taglib&gt;&lt;taglib-uri&gt;/WEB-INF/MyTagLib&lt;/taglib-uri&gt;&lt;taglib-location&gt;/WEB-INF/MyTagLib.tld&lt;/taglib-location&gt;&lt;/taglib&gt;&lt;/jsp-config&gt;&lt;/web-app&gt;

你可能在别处看到过类似的声明，只是没有外面的 jsp-config，但是我们使用的是DTD 2.4，如果不加，Eclipse 会提示出错。

到此为止，我们的自定义标签算是创建完毕。接下来，我们可以开始改写那个JSP文件来分离代码了。

Test.jsp 



 
    <title>My JSP 'Test.jsp' starting page</title>
    This is my JSP page. <br>
    Date : &lt;demo parameter="date"&gt;&lt;/demo&gt;<br>
    File : &lt;demo parameter="filename"&gt;&lt;/demo&gt;

上面这些想必你已经很熟悉，我就不做多说了。

2. 内容标签

创建过程和上面大抵相同，只是程序文件和配置内容有些差异。

DemoTag2.java 
package com.mycompany;

import java.io.IOException;
import java.util.Date;

import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class DemoTag2 extends BodyTagSupport {
 
  public int doStartTag() throws JspTagException {   
    return EVAL_BODY_BUFFERED;
  }
 
  public int doEndTag() throws JspTagException {
    String body = this.getBodyContent().getString();
    HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
   
    body = body.replace("$date", new Date().toString());
    body = body.replace("$filename", request.getServletPath());
   
    try {
      pageContext.getOut().print(body);
    }
    catch (IOException e) {
      throw new JspTagException(e.getMessage());
    }
   
    return SKIP_BODY;
  }
}

我们将新的标签 DemoTag2 加入到上面的标签文件中。

MyTagLib.tld 
&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;&lt;taglib&gt;&lt;tlib-version&gt;1.0&lt;/tlib-version&gt;&lt;jsp-version&gt;1.2&lt;/jsp-version&gt;&lt;tag&gt;&lt;name&gt;demo&lt;/name&gt;&lt;tag-class&gt;com.mycompany.DemoTag&lt;/tag-class&gt;&lt;body-content&gt;empty&lt;/body-content&gt;&lt;attribute&gt;&lt;name&gt;parameter&lt;/name&gt;&lt;required&gt;false&lt;/required&gt;&lt;rtexprvalue&gt;true&lt;/rtexprvalue&gt;&lt;/attribute&gt;&lt;/tag&gt;&lt;tag&gt;&lt;name&gt;demo2&lt;/name&gt;&lt;tag-class&gt;com.mycompany.DemoTag2&lt;/tag-class&gt;&lt;body-content&gt;jsp&lt;/body-content&gt;&lt;/tag&gt;&lt;/taglib&gt;

web.xml 文件无需修改。

看看同时使用两种标签的Test.jsp效果。

Test.jsp 



 
    <title>My JSP 'Test.jsp' starting page</title>
    This is my JSP page. <br>
    Date : &lt;demo parameter="date"&gt;&lt;/demo&gt;<br>
    File : &lt;demo parameter="filename"&gt;&lt;/demo&gt;<hr>&lt;demo2&gt;
    Date: $date&lt;br&gt;
    File: $filename
    &lt;/demo2&gt;

至此，两种标签方式都完成。
本文并没有就相关技术细节做出说明，建议您看看Sun有关JSP自定义标签的官方文档。

无论是用自定义标签，还是使用JavaBean，都没有太大的区别，各人或者团队可以根据自己的习惯使用。如果需要在独立类库中封装一些供页面使用的单元，自定义标签应该更适合些。不过现在的IDE环境(MyEclipse)在编写自定义标签的时候可能有些不太舒服的情况，界面开发人员使用JavaBean方式可能更方便些，免得莫名其妙的提示干扰您的工作。