JSP 自定义标签

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

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

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

创建"Hello"标签

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

  1. <ex:Hello />

要创建自定义的JSP标签，你首先必须创建处理标签的Java类。所以，让我们创建一个HelloTag类，如下所示：

  1. package com.tutorialspoint;
  3. import javax.servlet.jsp.tagext.*;
  4. import javax.servlet.jsp.*;
  5. import java.io.*;
  7. public class HelloTag extends SimpleTagSupport {
  9.   public void doTag() throws JspException, IOException {
  10.     JspWriter out = getJspContext().getOut();
  11.     out.println("Hello Custom Tag!");
  12.   }
  13. }

以下代码重写了doTag()方法，方法中使用了getJspContext()方法来获取当前的JspContext对象，并将"Hello Custom Tag!"传递给JspWriter对象。

编译以上类，并将其复制到环境变量CLASSPATH目录中。最后创建如下标签库：<Tomcat安装目录>webapps\ROOT\WEB-INF\custom.tld。

  1. <taglib>
  2.   <tlib-version>1.0</tlib-version>
  3.   <jsp-version>2.0</jsp-version>
  4.   <short-name>Example TLD</short-name>
  5.   <tag>
  6.     <name>Hello</name>
  7.     <tag-class>com.tutorialspoint.HelloTag</tag-class>
  8.     <body-content>empty</body-content>
  9.   </tag>
  10. </taglib>

接下来，我们就可以在JSP文件中使用Hello标签：

  1. <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
  2. <html>
  3.   <head>
  4.     <title>A sample custom tag</title>
  5.   </head>
  6.   <body>
  7.     <ex:Hello/>
  8.   </body>
  9. </html>

以上程序输出结果为：

  1. Hello Custom Tag!

访问标签体

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

  1. <ex:Hello>
  2.    This is message body
  3. </ex:Hello>

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

  1. package com.tutorialspoint;
  3. import javax.servlet.jsp.tagext.*;
  4. import javax.servlet.jsp.*;
  5. import java.io.*;
  7. public class HelloTag extends SimpleTagSupport {
  9.    StringWriter sw = new StringWriter();
  10.    public void doTag()
  11.       throws JspException, IOException
  12.     {
  13.        getJspBody().invoke(sw);
  14.        getJspContext().getOut().println(sw.toString());
  15.     }
  17. }

接下来我们需要修改TLD文件，如下所示： 

  1. <taglib>
  2.   <tlib-version>1.0</tlib-version>
  3.   <jsp-version>2.0</jsp-version>
  4.   <short-name>Example TLD with Body</short-name>
  5.   <tag>
  6.     <name>Hello</name>
  7.     <tag-class>com.tutorialspoint.HelloTag</tag-class>
  8.     <body-content>scriptless</body-content>
  9.   </tag>
  10. </taglib>

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

  1. <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
  2. <html>
  3.   <head>
  4.     <title>A sample custom tag</title>
  5.   </head>
  6.   <body>
  7.     <ex:Hello>
  8.         This is message body
  9.     </ex:Hello>
  10.   </body>
  11. </html>

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

  1. This is message body

自定义标签属性

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

  1. package com.tutorialspoint;
  3. import javax.servlet.jsp.tagext.*;
  4. import javax.servlet.jsp.*;
  5. import java.io.*;
  7. public class HelloTag extends SimpleTagSupport {
  9.    private String message;
  11.    public void setMessage(String msg) {
  12.       this.message = msg;
  13.    }
  15.    StringWriter sw = new StringWriter();
  17.    public void doTag()
  18.       throws JspException, IOException
  19.     {
  20.        if (message != null) {
  21.           /* 从属性中使用消息 */
  22.           JspWriter out = getJspContext().getOut();
  23.           out.println( message );
  24.        }
  25.        else {
  26.           /* 从内容体中使用消息 */
  27.           getJspBody().invoke(sw);
  28.           getJspContext().getOut().println(sw.toString());
  29.        }
  30.    }
  32. }

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

  1. <taglib>
  2.   <tlib-version>1.0</tlib-version>
  3.   <jsp-version>2.0</jsp-version>
  4.   <short-name>Example TLD with Body</short-name>
  5.   <tag>
  6.     <name>Hello</name>
  7.     <tag-class>com.tutorialspoint.HelloTag</tag-class>
  8.     <body-content>scriptless</body-content>
  9.     <attribute>
  10.        <name>message</name>
  11.     </attribute>
  12.   </tag>
  13. </taglib>

现在我们就可以在JSP文件中使用message属性了，如下所示：

  1. <%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
  2. <html>
  3.   <head>
  4.     <title>A sample custom tag</title>
  5.   </head>
  6.   <body>
  7.     <ex:Hello message="This is custom tag" />
  8.   </body>
  9. </html>

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

  1. This is custom tag

你还可以包含以下属性：

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

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

  1. .....
  2.     <attribute>
  3.       <name>attribute_name</name>
  4.       <required>false</required>
  5.       <type>java.util.Date</type>
  6.       <fragment>false</fragment>
  7.     </attribute>
  8. .....

如果你使用了两个属性，修改TLD文件，如下所示：

  1. .....
  2.     <attribute>
  3.       <name>attribute_name1</name>
  4.       <required>false</required>
  5.       <type>java.util.Boolean</type>
  6.       <fragment>false</fragment>
  7.     </attribute>
  8.     <attribute>
  9.       <name>attribute_name2</name>
  10.       <required>true</required>
  11.       <type>java.util.Date</type>
  12.     </attribute>
  13. .....