简单标签:
实现SimpleTag接口的标签通常称为简单标签。简单标签共定义了5个方法:
setJspContext方法
setParent和getParent方法
setJspBody方法
doTag方法
setJspContext方法:
用于把JSP页面的pageContext对象传递给标签处理器对象
setParent方法:
用于把父标签处理器对象传递给当前标签处理器对象
getParent方法:
用于获得当前标签的父标签处理器对象
setJspBody方法:
用于把代表标签体的JspFragment对象传递给标签处理器对象
doTag方法:
用于完成所有的标签逻辑,包括输出、迭代、修改标签体内容等。在doTag方法中可以抛出javax.servlet.jsp.SkipPageException异常,用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容,这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。
SimpleTag接口方法的执行顺序:
当web容器开始执行标签时,会调用如下方法完成标签的初始化
WEB容器调用标签处理器对象的setJspContext方法,将代表JSP页面的pageContext对象传递给标签处理器对象。
WEB容器调用标签处理器对象的setParent方法,将父标签处理器对象传递给这个标签处理器对象。注意,只有在标签存在父标签的情况下,WEB容器才会调用这个方法。
如果调用标签时设置了属性,容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或脚本表达式,则WEB容器首先计算表达式的值,然后把值传递给标签处理器对象。
如果简单标签有标签体,容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来。
执行标签时:
容器调用标签处理器的doTag()方法,开发人员在方法体内通过操作JspFragment对象,就可以实现是否执行、迭代、修改标签体的目的。
JspFragment类:
javax.servlet.jsp.tagext.JspFragment类是在JSP2.0中定义的,它的实例对象代表JSP页面中的一段符合JSP语法规范的JSP片段,这段JSP片段中不能包含JSP脚本元素。
WEB容器在处理简单标签的标签体时,会把标签体内容用一个JspFragment对象表示,并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法,如下所示:
getJspContext方法
用于返回代表调用页面的JspContext对象.
public abstract void invoke(java.io.Writer out)
用于执行JspFragment对象所代表的JSP代码片段
参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中,如果传递给参数out的值为null,则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之,可以理解为写给浏览器)
invoke方法详解 :
JspFragment.invoke方法是JspFragment最重要的方法,利用这个方法可以控制是否执行和输出标签体的内容、是否迭代执行标签体的内容或对标签体的执行结果进行修改后再输出。
例如:
在标签处理器中如果没有调用JspFragment.invoke方法,其结果就相当于忽略标签体内容;
在标签处理器中重复调用JspFragment.invoke方法,则标签体内容将会被重复执行;
若想在标签处理器中修改标签体内容,只需在调用invoke方法时指定一个可取出结果数据的输出流对象(例如StringWriter),让标签体的执行结果输出到该输出流对象中,然后从该输出流对象中取出数据进行修改后再输出到目标设备,即可达到修改标签体的目的。
开发带属性的标签:
要想让一个自定义标签具有属性,通常需要完成两个任务:
在标签处理器中编写每个属性对应的setter方法
在TLD文件中描术标签的属性
为自定义标签定义属性时,每个属性都必须按照JavaBean的属性命名方式,在标签处理器中定义属性名对应的setter方法,用来接收JSP页面调用自定义标签时传递进来的属性值。 例如属性url,在标签处理器类中就要定义相应的setUrl(String url)方法。
在标签处理器中定义相应的set方法后,JSP引擎在解析执行开始标签前,也就是调用doStartTag方法前,会调用set属性方法,为标签设置属性。
<?xml version="1.0" encoding="UTF-8" ?> <taglib xmlns="http://java.sun.com/xml/ns/j2ee" 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" version="2.0"> <description>A tag library exercising SimpleTag handlers.</description> <tlib-version>1.0</tlib-version> <short-name>SimpleTagLibrary</short-name> <uri>/simpletag</uri> <tag> <name>demo</name> <!-- 为标签处理器类配一个标签名 --> <tag-class>cn.lcp.web.simple.SimpleTagDemo</tag-class> <body-content>scriptless</body-content> </tag> <tag> <name>demo2</name> <!-- 为标签处理器类配一个标签名 --> <tag-class>cn.lcp.web.simple.SimpleTagDemo2</tag-class> <body-content>scriptless</body-content> </tag> <tag> <name>demo3</name> <!-- 为标签处理器类配一个标签名 --> <tag-class>cn.lcp.web.simple.SimpleTagDemo3</tag-class> <body-content>scriptless</body-content> </tag> <tag> <name>demo4</name> <!-- 为标签处理器类配一个标签名 --> <tag-class>cn.lcp.web.simple.SimpleTagDemo4</tag-class> <body-content>empty</body-content> </tag> <tag> <name>demo5</name> <!-- 为标签处理器类配一个标签名 --> <tag-class>cn.lcp.web.simple.SimpleTagDemo5</tag-class> <body-content>scriptless</body-content> <attribute><!-- 设置属性 --> <name>count</name><!-- 设置属性名 --> <required>true</required><!-- 设置属性是否必须需要 --> <rtexprvalue>true</rtexprvalue><!-- 属性是否能用表达式 --> </attribute> <attribute><!-- 设置属性 --> <name>date</name><!-- 设置属性名 --> <required>true</required><!-- 设置属性是否必须需要 --> <rtexprvalue>true</rtexprvalue><!-- 属性是否能用表达式 --> </attribute> </tag> </taglib>
1) //控制标签体是否执行 public class SimpleTagDemo extends SimpleTagSupport { @Override public void doTag() throws JspException, IOException { JspFragment jf = this.getJspBody(); //控制标签体是否输出,给一个和浏览器相关的流,写给浏览器 jf.invoke(this.getJspContext().getOut()); //去掉这里,可以控制标签不输出 } } 2)//控制标签体循环输出 public class SimpleTagDemo2 extends SimpleTagSupport { @Override public void doTag() throws JspException, IOException { JspFragment jf = this.getJspBody(); for(int i = 0; i < 5; i ++){ jf.invoke(null); //默认输出给浏览器:相当于jf.invoke(this.getJspContext().getOut()); } } } 3)//控制标签体的内容 public class SimpleTagDemo3 extends SimpleTagSupport { @Override public void doTag() throws JspException, IOException { JspFragment jf = this.getJspBody(); StringWriter sw = new StringWriter(); //再把标签体写入StringWriter缓冲里面。 jf.invoke(sw); //把标签体写入到sw里面 String content = sw.toString(); //拿到标签体 content = content.toUpperCase(); this.getJspContext().getOut().write(content); } } 4)//控制标签体余下的jsp不执行 public class SimpleTagDemo4 extends SimpleTagSupport { @Override public void doTag() throws JspException, IOException { throw new SkipPageException(); } } 5) //控制带属性的标签 public class SimpleTagDemo5 extends SimpleTagSupport { private int count; private Date date; @Override public void doTag() throws JspException, IOException { JspFragment jf = this.getJspBody(); this.getJspContext().getOut().write(date.toString() + "<br/>"); for(int i = 0; i < count; i ++){ jf.invoke(null); } super.doTag(); } public void setDate(Date date) { this.date = date; } public void setCount(int count) { this.count = count; } }