如何建立一个简单的标记处理器?
需要做三件事:
一、编写标签处理器(java文件)
二、在标签库描述符文件中描述该标签 (TLD文件)
三、在jsp文件中引用该标签
具体步骤:
step1:编写一个扩展SimpleTagSupport的类
package foo; import javax.servlet.jsp.tagext.SimpleTagSupport; //mort import... public class SimpleTagTest1 extands SimpleTagSupport{ //这里放标记处理代码 }
step2: 实现doTag()方法
public void doTag() throws JspException, IOException { //在response中打印 "This is xxxxxx" getJspContext().getOut().print("This is xxxxxx"); }
step3: 为标记创建一个TLD (taglib description, 标签库描述符)
<?xml version="1.0" encoding="ISO-8859-1" ?> <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/jsee/web-jsptagLibrary_2_0.xsd" version="2.0"> <tlib-version>1.2</tlib-version> <uri>simpleTags</uri> <tag> <name>simple1</name> <description>xxxxxxxx</description> <tag-class>foo.SimpleTagTest1</tag-class> <body-content>empty</body-content> </tag> </taglib>
step4: 部署标记处理器和TLD
把TLD文件放在WEB-INF下,并把标记处理器放在WEB-INF/classes下,这里当然还要遵循包目录结构。换句话说,标记处理器类要与所有其他web应用Java类放在同一个位置上。
step5: 编写一个使用标记的JSP
<%@ taglib prefix="myTags" uri="simpleTags" %> <html> <body> <myTags:simple1 %> </body> </html>
uri中的名称要与TLD文件中的uri的名称一致。
至此,就建立了一个简单的自定义标签。
自定义标签还有几种常见的情况,分别为:
一、有体的标记 (如,<x:label>...</x:label>,"..."为标签的body)
二、标记体中使用了表达式 (如,<x:label> ${movie} </x:label>, "${movie}"为标签的体中出现的EL表达式)
三、循环执行标签体
四、含有属性的简单标签 (如,<x:label movie="${movie}" />)
以下,将分别介绍这几种情况:
情况一:编写的是有体(body)的标记,如:
<myTags:simple2> This is the body //这个就是标记的body </myTags:simple2>
那么在这种情况下,为了执行body内的语句就需要加入这样一句话到doTag()方法中:
getJspBody().invoke(null);
invoke的意思是“处理标记的body,并把它打印到响应(response)中”。
null的意思是把内容输出到响应(response),而不是输出到什么别的书写器(Writer)上。
除此以外,TLD中的 “<body-content>empty</body-content>” 一栏也需要改动,要改为:
<body-content>scriptless</body-content>
之后会介绍四种不同的body-content的参数。
情况二、如果标记体使用了表达式,如:
<myTags:simple3> Message is : ${message} </myTags:simple3>
那么这个表达式的赋值需要在标签处理器的doTag()中完成,如:
getJspContext().setAttribute("message","wear sunscreen"); getJspBody().invoke(null);//一定要记得写这句,否则标签体不会执行
情况三、若想要循环输出一个集合的数据,应该如何实现?如:
<table> <myTags:simple3> <tr><td>${movie}</td></tr> </myTags:simple3> </table>
显然,希望通过循环输出不同的movie来形成 一个表格。那么标记处理器的doTag()方法应该改为:
String[] movies = {"Monsoon Wedding", "Saved!", ".. ..."}; public void doTag() throws JspException, IOException { for(int i = 0; i < movies.length; i++){ getJspContext().setAttribute("movie",movies[i]); getJspBody().invoke(null);//每次invoke,都会执行一次标签body } }
情况四、如果这个简单标记是有属性的,怎么办?如:
<table> <myTags:simple5 movieList="${movieCollection}"> <tr> <td>${movie.name}</td> <td>${movie.genre}</td> </tr> </myTags:simple5> </table>
由于标记中出现了属性,所以TLD中的描述必须反映这一情况,因此TLD应调整为:
<?xml version="1.0" encoding="ISO-8859-1" ?> <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/jsee/web-jsptagLibrary_2_0.xsd" version="2.0"> <tlib-version>1.2</tlib-version> <uri>simpleTags</uri> <tag> <name>simple1</name> <description>xxxxxxxx</description> <tag-class>foo.SimpleTagTest1</tag-class> <body-content>empty</body-content> <attribute> <name>movieList</name> <required>true</required><!-- 说明movieList属性是必需的 --> <rtexprvalue>true</rtexprvalue><!-- 说明movieList属性可以是一个运行时表达式(不用非得是一个常量String) --> </attribute> </tag> </taglib>
另外,在标记处理器类中,也要对这一属性有相应的体现:
public class SimpleTagTest5 extends SimpleTagSupport{ private List movieList; public void setMovieList(List movieList){ this.movieList = movieList; } public void doTag() .... }
补充:
<body-content></body-content>中可以写入的参数有四种:
① empty
即标记体为空
② scriptless
这个标记不能有脚本元素,但可以有模板文本和EL, 还可以是定制和标准动作
③ tagdependent
标记体要看做是纯文本,所以不会计算EL,也不会出发标记/动作
④ JSP
能放在JSP中的东西都能放在这个标记体中