JSP自定义标签
自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet,标签转化为对呗成为tag handler的对象的操作,即当servlet执行时Web container调用那些操作。
JSP标签扩展可以让你创建新的标签并可以把它直接插入到一个JSP页面。JSP 2.0规范中引入Simple Tag Handlers来编写这些自定义标记。
你可以继承SimpleTagSupport类并重写doTag()方法来开发简单的自定义标签。
创建”HELLO”标签
接下来我们想创建一个自定义标签叫做ex,标签格式为:
<ex:Hello />
要创建自定义的JSP标签,你首先必须处理标签的Java类。所以让我们创建一个HelloTag类,如下所示:
package com.runoob;
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对象,并将“HelloCustomTag!”传输给JspWritter对象。编译以上类,并将其复制到环境变量ClassPath目录中。最后创建如下标签库:(路径:\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.runoob.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.runoob;
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.runoob.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
自定义标签属性
你可以在自定义标签中设置各种属性,要接受属性值,自定义标签必须实现set方法,JavaBean中的setter方法如下所示:
package com.runoob;
import javax.servlet.jsp.tagext.*;
import javax.servlet.jsp.*;
mport 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”,所以setMessage()方法。现在让我们通过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.runoob.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>
还可以包含以下属性
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>
.....