自定义标签
1 自定义标签概述
1.1 自定义标签的步骤
其实我们在JSP页面中使用标签就等于调用某个对象的某个方法一样,例如:<c:if test=””>,这就是在调用对象的方法一样。自定义标签其实就是自定义类一样!
(1) 定义标签处理类:必须是Tag或SimpleTag的实现类;
(2) 编写标签库描述符文件(TLD);
SimpleTag接口是JSP2.0中新给出的接口,用来简化自定义标签,所以现在我们基本上都是使用SimpleTag。
Tag是老的,传统的自定义标签时使用的接口,现在不建议使用它了。
1.2 SimpleTag接口介绍
SimpleTag接口内容如下:
(1) void doTag():标签执行方法;每次执行标签时都会调用这个方法;
(2) JspTag getParent():获取父标签;(非生命周期方法)
(3) void setParent(JspTag parent):设置父标签
(4) void setJspContext(JspContext context):设置PageContext,设置jsp上下文对象,它儿子是PageContext
(5) void setJspBody(JspFragment jspBody):设置标签体对象;
请记住,万物皆对象!在JSP页面中的标签也是对象!你可以通过查看JSP的“真身”清楚的知道,所有标签都会变成对象的方法调用。标签对应的类我们称之为“标签处理类”!
标签的生命周期:
1. 当容器(Tomcat)第一次执行到某个标签时,会创建标签处理类的实例;
2. 然后调用setJspContext(JspContext)方法,把当前JSP页面的pageContext对象传递给这个方法;
3. 如果当前标签有父标签,那么使用父标签的标签处理类对象调用setParent(JspTag)方法;
4. 如果标签有标签体,那么把标签体转换成JspFragment对象,然后调用setJspBody()方法;
5. 每次执行标签时,都调用doTag()方法,它是标签处理方法。
HelloTag.java
public class HelloTag implements SimpleTag { private JspTagparent; private PageContextpageContext; private JspFragmentjspBody;
public void doTag() throws JspException, IOException { pageContext.getOut().print("Hello Tag!!!");//获取out对象,输出Hello Tag!!! } public void setParent(JspTag parent) { this.parent = parent; } public JspTag getParent() { return this.parent; } public void setJspContext(JspContext pc) { this.pageContext = (PageContext) pc; } public void setJspBody(JspFragment jspBody) { this.jspBody = jspBody; } } |
1.3 标签库描述文件(TLD)
标签库描述文件是用来描述当前标签库中的标签的!标签库描述文件的扩展名为tld,你可以把它放到WEB-INF下,这样就不会被客户端直接访问到了。
hello.tld
<?xmlversion="1.0"encoding="UTF-8"?> <taglibversion="2.0"xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xml="http://www.w3.org/XML/1998/namespace" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd ">
<tlib-version>1.0</tlib-version>//指定当前标签库的版本 <short-name>wyh</short-name>//指定当前标签库的简称,这个名称无所谓了,随便起。 <uri>http://www.wyh.cn/tags</uri>//指定标签库的uri <tag>//部署一个标签!一个<tag>表示一个标签。 <name>hello</name>//指定标签的名称 <tag-class>cn.wyh.tag.HelloTag</tag-class>//指定标签处理类 <body-content>empty</body-content>//指定标签体内容类型为空类型,即没有标签体。 </tag> </taglib>
复制这里的代码:hello.tld---------------------------------------------------------------------------------------------------------------------- <?xml version="1.0" encoding="UTF-8"?> |
1.4 使用标签
在页面中使用标签分为两步:
(1) 使用taglib导入标签库;
(2) 使用标签;
<%@ taglibprefix="it"uri="/WEB-INF/hello.tld" %> ...... <it:hello/> //prefix:指定标签库前缀 //uri:指定标签库的tld文件位置
index,jsp[重启服务器]----------------------------------------------------------------- <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> |
2 自定义标签进阶
2.1 继承SimpleTagSupport
继承SimpleTagSuppport要比实现SimpleTag接口方便太多了,现在你只需要重写doTag()方法,其他方法都已经被SimpleTagSuppport完成了。
public class HelloTag extends SimpleTagSupport { public void doTag() throws JspException, IOException { this.getJspContext().getOut().write("<p>Hello SimpleTag!</p>") ;//向页面输出!注意,不能向页面输出<%%>东西! } } |
2.2 有标签体的标签
我们先来看看标签体内容的可选值:
<body-content>元素的可选值有:
(1) empty:无标签体。
(2) JSP:传统标签支持它,SimpleTag已经不再支持使用<body-content>JSP</body-content>。标签体内容可以是任何东西:EL、JSTL、<%=%>、<%%>,以及html;
(3) scriptless:标签体内容不能是Java脚本,但可以是EL、JSTL等。在SimpleTag中,如果需要有标签体,那么就使用该选项;
(4) tagdependent:标签体内容不做运算,由标签处理类自行处理,无论标签体内容是EL、JSP、JSTL,都不会做运算。这个选项几乎没有人会使用!
自定义有标签体的标签需要:
(1) 获取标签体对象:JspFragment jspBody = getJspBody();;
(2) 把标签体内容输出到页面:jspBody.invoke(null);
(3) tld中指定标签内容类型:scriptless。
public class HelloTag extends SimpleTagSupport { public void doTag() throws JspException, IOException { PageContext pc = (PageContext) this.getJspContext(); HttpServletRequest req = (HttpServletRequest) pc.getRequest(); String s = req.getParameter("exec"); if(s !=null && s.endsWith("true")) { JspFragment body = this.getJspBody() ;//获取当前标签的标签体对象 body.invoke(null);//向页面输出标签内容 } } } |
<tag> <name>hello</name> <tag-class>cn.wyh.tags.HelloTag</tag-class> <body-content>scriptless</body-content>//指定标签体内容为scriptless,即标签体内容可以是正常的html,也可以是EL或JSTL </tag> |
<wyh:hello> <h1>哈哈哈~</h1> </itcast:hello> |
2.3 不执行标签下面的页面内容
如果希望在执行了自定义标签后,不再执行JSP页面下面的东西,那么就需要在doTag()方法中使用SkipPageException。
public class SkipTag extends SimpleTagSupport { public void doTag() throws JspException, IOException { this.getJspContext().getOut().print("<h1>只能看到我!</h1>"); throw new SkipPageException(); } } |
<tag> <name>skip</name> <tag-class>cn.wyh.tags.SkipTag</tag-class> <body-content>empty</body-content> </tag> |
<itcast:skip/> <h1>看不见我!</h1> |
2.4 带有属性的标签
一般标签都会带有属性,例如<c:iftest=””>,其中test就是一个boolean类型的属性。完成带有属性的标签需要:
(1) 在处理类中给出JavaBean属性(提供get/set方法);
(2) 在TLD中部属相关属性。
public class IfTag extends SimpleTagSupport { private boolean test; public boolean isTest() { returntest; } public void setTest (boolean test) {//该方法会在doTag()之前被调用,传入属性值。 this.test = test; } @Override public void doTag() throws JspException, IOException { if(test) { this.getJspBody().invoke(null); }//如果test为true,执行标签体内容,否则什么都不做。 } } |
<tag> <name>if</name> <tag-class>cn.wyh.tag.IfTag</tag-class> <body-content>scriptless</body-content> <attribute>//声明属性 <name>test</name>//属性名称为test <required>true</required>//属性是否必须,为false表示属性为可选的。 <rtexprvalue>true</rtexprvalue>//为true表示 :属性值可以为EL或JSTL,否则表示只能是常量。 </attribute> </tag> |
<% pageContext.setAttribute("one",true); pageContext.setAttribute("two",false); %> <it:iftest="${one }">xixi</it:if>//可以看到xixi <it:iftest="${two }">haha</it:if>//不会执行haha <it:iftest="true">hehe</it:if>//可以看到hehe |