自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet,标签转化为对被 称为tag handler的对象的操做,即当servlet执行时Web container调用那些操做。html
JSP标签扩展能够让你建立新的标签而且能够直接插入到一个JSP页面。 JSP 2.0规范中引入Simple Tag Handlers来编写这些自定义标记。java
你能够继承SimpleTagSupport类并重写的doTag()方法来开发一个最简单的自定义标签。web
接下来,咱们想建立一个自定义标签叫做<ex:Hello>,标签格式为:app
<ex:Hello />
要建立自定义的JSP标签,你首先必须建立处理标签的Java类。因此,让咱们建立一个HelloTag类,以下所示:less
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对象,并将"Hello Custom Tag!"传递给JspWriter对象。webapp
编译以上类,并将其复制到环境变量CLASSPATH目录中。最后建立以下标签库:<Tomcat安装目录>webapps\ROOT\WEB-INF\custom.tld。jsp
<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标签:ui
<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%> <html> <head> <title>A sample custom tag</title> </head> <body> <ex:Hello/> </body> </html>
以上程序输出结果为:this
Hello Custom Tag!
你能够像标准标签库同样在标签中包含消息内容。如咱们要在咱们自定义的Hello中包含内容,格式以下:spa
<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
你能够在自定义标准中设置各类属性,要接收属性,值自定义标签类必须实现setter方法, JavaBean 中的setter方法以下所示:
package com.runoob; 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.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>
以上实例数据输出结果为:
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> .....