自定义标签简介
1、 自定义标签主要用于移除Jsp页面中的java代码。
2、 移除jsp页面中的java代码,只需要完成两个步骤:
• 编写一个实现Tag接口的Java类,并覆盖doStartTag方法,把jsp页面中的java代码写到doStartTag方法中。
• 编写标签库描述符(tld)文件,在tld文件中对自定义标签进行描述。
• 完成以上操作,即可在JSP页面中导入和使用自定义标签。
查看tag接口api文档,分析自定义标签的执行流程。
Tag接口的执行流程
一、 JSP引擎将遇到自定义标签时,首先创建标签处理器类的实例对象,然后按照JSP规范定义的通信规则依次调用它的方法。
1、public void setPageContext(PageContext pc), JSP引擎实例化标签处理器后,将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器,标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。
2、public void setParent(Tag t),setPageContext方法执行完后,WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器,如果当前标签没有父标签,则传递给setParent方法的参数值为null。
3、public int doStartTag(),调用了setPageContext方法和setParent方法之后,WEB容器执行到自定义标签的开始标记时,就会调用标签处理器的doStartTag方法。
4、public int doEndTag(),WEB容器执行完自定义标签的标签体后,就会接着去执行自定义标签的结束标记,此时,WEB容器会去调用标签处理器的doEndTag方法。
5、public void release(),通常WEB容器执行完自定义标签后,标签处理器会驻留在内存中,为其它请求服务器,直至停止web应用时,web容器才会调用release方法。
自定义标签功能扩展
l 自定义标签除了可以移除Jsp页面中的java代码外,它还可以用于完成一些页面逻辑,例如:
• 通过自定义标签可以控制jsp页面某一部分内容是否执行。
例如:<c:if>标签
• 通过自定义标签可以控制标签后的jsp页面是否执行。
• 通过自定义标签可以控制jsp页面某一部分内容重复执行。
例如:<c:foreach>标签
• 通过自定义标签可以修改jsp页面内容输出。
• tld文件中的四种标签体类型
EMPTY、 JSP、 scriptless 、 tagdepentend
Tip-简单标签
在JSP 2.0中定义了一个更为简单、便于编写和调用的SimpleTag接口来实现标签的功能。实现SimpleTag接口的标签通常称为简单标签。简单标签共定义了5个方法:
1、 setJspContext方法
• 用于把JSP页面的pageContext对象传递给标签处理器对象
2、 setParent方法
• 用于把父标签处理器对象传递给当前标签处理器对象
3、 getParent方法
• 用于获得当前标签的父标签处理器对象
4、 setJspBody方法
• 用于把代表标签体的JspFragment对象传递给标签处理器对象
5、 doTag方法
• 用于完成所有的标签逻辑,包括输出、迭代、修改标签体内容等。
注:在doTag方法中可以抛出javax.servlet.jsp.SkipPageException异常,用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容,这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。
Tip:SimpleTag接口方法的执行顺序
1、 当web容器开始执行标签时,会调用如下方法完成标签的初始化
• WEB容器调用标签处理器对象的setJspContext方法,将代表JSP页面的pageContext对象传递给标签处理器对象。
• WEB容器调用标签处理器对象的setParent方法,将父标签处理器对象传递给这个标签处理器对象。注意,只有在标签存在父标签的情况下,WEB容器才会调用这个方法。
• 如果调用标签时设置了属性,容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或脚本表达式,则WEB容器首先计算表达式的值,然后把值传递给标签处理器对象。
• 如果简单标签有标签体,容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来。
2、执行标签时:
• 容器调用标签处理器的doTag()方法,开发人员在方法体内通过操作JspFragment对象,就可以实现是否执行、迭代、修改标签体的目的。
Tip:JspFragment类
1、WEB容器在处理简单标签的标签体时,会把标签体内容用一个JspFragment对象表示,并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法,如下所示:
(1) getJspContext方法
• 用于返回代表调用页面的JspContext对象.
(2)public abstract void invoke(java.io.Writer out)
• 用于执行JspFragment对象所代表的JSP代码片段
• 参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中,如果传递给参数out的值为null,则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之,可以理解为写给浏览器)
Tip:invoke方法详解
1、 JspFragment.invoke方法可以说是JspFragment最重要的方法,利用这个方法可以控制是否执行和输出标签体的内容、是否迭代执行标签体的内容或对标签体的执行结果进行修改后再输出。例如:
• 在标签处理器中如果没有调用JspFragment.invoke方法,其结果就相当于忽略标签体内容;
• 在标签处理器中重复调用JspFragment.invoke方法,则标签体内容将会被重复执行;
• 若想在标签处理器中修改标签体内容,只需在调用invoke方法时指定一个可取出结果数据的输出流对象(例如StringWriter),让标签体的执行结果输出到该输出流对象中,然后从该输出流对象中取出数据进行修改后再输出到目标设备,即可达到修改标签体的