JSP 自定义标签

jsp 自定义标签

自定义标签是用户定义的jsp语言元素。当jsp页面包含一个自定义标签时将被转化为servlet,标签转化为对被 称为tag handler的对象的操作,即当servlet执行时web container调用那些操作。

jsp标签扩展可以让你创建新的标签并且可以直接插入到一个jsp页面。 jsp 2.0规范中引入simple tag handlers来编写这些自定义标记。

你可以继承simpletagsupport类并重写的dotag()方法来开发一个最简单的自定义标签。

创建"hello"标签

接下来,我们想创建一个自定义标签叫作<ex:hello>,标签格式为:

<ex:hello />

要创建自定义的jsp标签,你首先必须创建处理标签的java类。所以,让我们创建一个hellotag类,如下所示:

package com.yapf;

import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;

public class hellotag extends simpletagsupport {

  public void dotag() throws jspexception, ioexception {
    jspwriter out = getjspcontext().getout();
    out.println("hello custom tag!");
  }
}

以下代码重写了dotag()方法,方法中使用了getjspcontext()方法来获取当前的jspcontext对象,并将"hello custom tag!"传递给jspwriter对象。

编译以上类,并将其复制到环境变量classpath目录中。最后创建如下标签库:<tomcat安装目录>webapps\root\web-inf\custom.tld。

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>example tld</short-name>
  <tag>
    <name>hello</name>
    <tag-class>com.yapf.hellotag</tag-class>
    <body-content>empty</body-content>
  </tag>
</taglib>

接下来,我们就可以在jsp文件中使用hello标签:

<%@ taglib prefix="ex" uri="web-inf/custom.tld"%>
<html>
  <head>
    <title>a sample custom tag</title>
  </head>
  <body>
    <ex:hello/>
  </body>
</html>

以上程序输出结果为:

hello custom tag!

访问标签体

你可以像标准标签库一样在标签中包含消息内容。如我们要在我们自定义的hello中包含内容,格式如下:

<ex:hello>
   this is message body
</ex:hello>

我们可以修改标签处理类文件,代码如下:

package com.yapf;

import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;

public class hellotag extends simpletagsupport {

   stringwriter sw = new stringwriter();
   public void dotag()
      throws jspexception, ioexception
    {
       getjspbody().invoke(sw);
       getjspcontext().getout().println(sw.tostring());
    }

}

接下来我们需要修改tld文件,如下所示:

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>example tld with body</short-name>
  <tag>
    <name>hello</name>
    <tag-class>com.yapf.hellotag</tag-class>
    <body-content>scriptless</body-content>
  </tag>
</taglib>

现在我们可以在jsp使用修改后的标签,如下所示:

<%@ taglib prefix="ex" uri="web-inf/custom.tld"%>
<html>
  <head>
    <title>a sample custom tag</title>
  </head>
  <body>
    <ex:hello>
        this is message body
    </ex:hello>
  </body>
</html>

以上程序输出结果如下所示:

this is message body

自定义标签属性

你可以在自定义标准中设置各种属性,要接收属性,值自定义标签类必须实现setter方法, javabean 中的setter方法如下所示:

package com.yapf;

import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
import java.io.*;

public class hellotag extends simpletagsupport {

   private string message;

   public void setmessage(string msg) {
      this.message = msg;
   }

   stringwriter sw = new stringwriter();

   public void dotag()
      throws jspexception, ioexception
    {
       if (message != null) {
          /* 从属性中使用消息 */
          jspwriter out = getjspcontext().getout();
          out.println( message );
       }
       else {
          /* 从内容体中使用消息 */
          getjspbody().invoke(sw);
          getjspcontext().getout().println(sw.tostring());
       }
   }

}

属性的名称是"message",所以setter方法​​是的setmessage()。现在让我们在tld文件中使用的<attribute>元素添加此属性:

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>example tld with body</short-name>
  <tag>
    <name>hello</name>
    <tag-class>com.yapf.hellotag</tag-class>
    <body-content>scriptless</body-content>
    <attribute>
       <name>message</name>
    </attribute>
  </tag>
</taglib>

现在我们就可以在jsp文件中使用message属性了,如下所示:

<%@ taglib prefix="ex" uri="web-inf/custom.tld"%>
<html>
  <head>
    <title>a sample custom tag</title>
  </head>
  <body>
    <ex:hello message="this is custom tag" />
  </body>
</html>

以上实例数据输出结果为:

this is custom tag

你还可以包含以下属性:

属性 描述
name定义属性的名称。每个标签的是属性名称必须是唯一的。
required指定属性是否是必须的或者可选的,如果设置为false为可选。
rtexprvalue声明在运行表达式时,标签属性是否有效。
type定义该属性的java类类型 。默认指定为 string
description描述信息
fragment如果声明了该属性,属性值将被视为一个 jspfragment

以下是指定相关的属性实例:

.....
    <attribute>
      <name>attribute_name</name>
      <required>false</required>
      <type>java.util.date</type>
      <fragment>false</fragment>
    </attribute>
.....

如果你使用了两个属性,修改tld文件,如下所示:

.....
    <attribute>
      <name>attribute_name1</name>
      <required>false</required>
      <type>java.util.boolean</type>
      <fragment>false</fragment>
    </attribute>
    <attribute>
      <name>attribute_name2</name>
      <required>true</required>
      <type>java.util.date</type>
    </attribute>
.....
相关文章