使用自定义标签实现JSP页面和代码的分离 - Q.yuhen(转载)
Code
在上篇使用JavaBean实现JSP页面和代码分离中,我们使用JavaBean来达到分离的目的至于本文要使用的自定义标签并不新鲜,此处我也不过是照本宣科地走一遭罢了只是某些细节处,还应当多注意些
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <%= new java.util.Date().toString() %> <br>
File : <input value="<%= request.getServletPath() %>" />
</body>
</html>
为了将这个这个Test.jsp改成自定义标签方法,我们分别使用简单标签和内容标签两种不同的方式实现
1. 简单标签
由于我们需要输出两个内容(日期和文件名),因此我们为标签创建一个参数具体代码:
DemoTag.java package com.mycompany;
import java.util.Date;
import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
public class DemoTag extends TagSupport {
public int doStartTag() throws JspException {
try {
HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
JspWriter out = pageContext.getOut();
if (parameter.compareToIgnoreCase("filename") == 0)
out.print(request.getServletPath());
else
out.print(new Date());
} catch (java.io.IOException e) {
throw new JspTagException(e.getMessage());
}
return SKIP_BODY;
}
private String parameter = "date";
public void setParameter(String parameter) {
this.parameter = parameter;
}
public String getParameter() {
return parameter;
}
}
接下来,我们创建标签文件 MyTagLib.tld标签文件其实只是一个XML格式的说明文件,内容也很简单
MyTagLib.tld <?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<tag>
<name>demo</name>
<tag-class>com.mycompany.DemoTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>parameter</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
</taglib>
在这个标签文件中,我们将我们创建的标签取名 demo,并声明了类型和参数(parameter)将该文件保存在 /WEB-INF 下面
当然,我们还需要将我们自定义的标签添加到 web.xml 中,否则还是无法使用
web.xml <?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<jsp-config>
<taglib>
<taglib-uri>/WEB-INF/MyTagLib</taglib-uri>
<taglib-location>/WEB-INF/MyTagLib.tld</taglib-location>
</taglib>
</jsp-config>
</web-app>
你可能在别处看到过类似的声明,只是没有外面的 jsp-config,但是我们使用的是DTD 2.4,如果不加,Eclipse 会提示出错
到此为止,我们的自定义标签算是创建完毕接下来,我们可以开始改写那个JSP文件来分离代码了
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <mytag:demo parameter="date" /><br>
File : <mytag:demo parameter="filename" />
</body>
</html>
上面这些想必你已经很熟悉,我就不做多说了
2. 内容标签
创建过程和上面大抵相同,只是程序文件和配置内容有些差异
DemoTag2.java package com.mycompany;
import java.io.IOException;
import java.util.Date;
import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
public class DemoTag2 extends BodyTagSupport {
public int doStartTag() throws JspTagException {
return EVAL_BODY_BUFFERED;
}
public int doEndTag() throws JspTagException {
String body = this.getBodyContent().getString();
HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
body = body.replace("$date", new Date().toString());
body = body.replace("$filename", request.getServletPath());
try {
pageContext.getOut().print(body);
}
catch (IOException e) {
throw new JspTagException(e.getMessage());
}
return SKIP_BODY;
}
}
我们将新的标签 DemoTag2 加入到上面的标签文件中
MyTagLib.tld <?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<tag>
<name>demo</name>
<tag-class>com.mycompany.DemoTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>parameter</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<tag>
<name>demo2</name>
<tag-class>com.mycompany.DemoTag2</tag-class>
<body-content>jsp</body-content>
</tag>
</taglib>
web.xml 文件无需修改
看看同时使用两种标签的Test.jsp效果
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <mytag:demo parameter="date" /><br>
File : <mytag:demo parameter="filename" />
<hr>
<mytag:demo2>
Date: $date<br>
File: $filename
</mytag:demo2>
</body>
</html>
至此,两种标签方式都完成
本文并没有就相关技术细节做出说明,建议您看看Sun有关JSP自定义标签的官方文档
无论是用自定义标签,还是使用JavaBean,都没有太大的区别,各人或者团队可以根据自己的习惯使用如果需要在独立类库中封装一些供页面使用的单元,自定义标签应该更适合些不过现在的IDE环境(MyEclipse)在编写自定义标签的时候可能有些不太舒服的情况,界面开发人员使用JavaBean方式可能更方便些,免得莫名其妙的提示干扰您的工作
在上篇使用JavaBean实现JSP页面和代码分离中,我们使用JavaBean来达到分离的目的至于本文要使用的自定义标签并不新鲜,此处我也不过是照本宣科地走一遭罢了只是某些细节处,还应当多注意些
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <%= new java.util.Date().toString() %> <br>
File : <input value="<%= request.getServletPath() %>" />
</body>
</html>
为了将这个这个Test.jsp改成自定义标签方法,我们分别使用简单标签和内容标签两种不同的方式实现
1. 简单标签
由于我们需要输出两个内容(日期和文件名),因此我们为标签创建一个参数具体代码:
DemoTag.java package com.mycompany;
import java.util.Date;
import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
public class DemoTag extends TagSupport {
public int doStartTag() throws JspException {
try {
HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
JspWriter out = pageContext.getOut();
if (parameter.compareToIgnoreCase("filename") == 0)
out.print(request.getServletPath());
else
out.print(new Date());
} catch (java.io.IOException e) {
throw new JspTagException(e.getMessage());
}
return SKIP_BODY;
}
private String parameter = "date";
public void setParameter(String parameter) {
this.parameter = parameter;
}
public String getParameter() {
return parameter;
}
}
接下来,我们创建标签文件 MyTagLib.tld标签文件其实只是一个XML格式的说明文件,内容也很简单
MyTagLib.tld <?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<tag>
<name>demo</name>
<tag-class>com.mycompany.DemoTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>parameter</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
</taglib>
在这个标签文件中,我们将我们创建的标签取名 demo,并声明了类型和参数(parameter)将该文件保存在 /WEB-INF 下面
当然,我们还需要将我们自定义的标签添加到 web.xml 中,否则还是无法使用
web.xml <?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<jsp-config>
<taglib>
<taglib-uri>/WEB-INF/MyTagLib</taglib-uri>
<taglib-location>/WEB-INF/MyTagLib.tld</taglib-location>
</taglib>
</jsp-config>
</web-app>
你可能在别处看到过类似的声明,只是没有外面的 jsp-config,但是我们使用的是DTD 2.4,如果不加,Eclipse 会提示出错
到此为止,我们的自定义标签算是创建完毕接下来,我们可以开始改写那个JSP文件来分离代码了
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <mytag:demo parameter="date" /><br>
File : <mytag:demo parameter="filename" />
</body>
</html>
上面这些想必你已经很熟悉,我就不做多说了
2. 内容标签
创建过程和上面大抵相同,只是程序文件和配置内容有些差异
DemoTag2.java package com.mycompany;
import java.io.IOException;
import java.util.Date;
import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
public class DemoTag2 extends BodyTagSupport {
public int doStartTag() throws JspTagException {
return EVAL_BODY_BUFFERED;
}
public int doEndTag() throws JspTagException {
String body = this.getBodyContent().getString();
HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
body = body.replace("$date", new Date().toString());
body = body.replace("$filename", request.getServletPath());
try {
pageContext.getOut().print(body);
}
catch (IOException e) {
throw new JspTagException(e.getMessage());
}
return SKIP_BODY;
}
}
我们将新的标签 DemoTag2 加入到上面的标签文件中
MyTagLib.tld <?xml version="1.0" encoding="ISO-8859-1"?>
<taglib>
<tlib-version>1.0</tlib-version>
<jsp-version>1.2</jsp-version>
<tag>
<name>demo</name>
<tag-class>com.mycompany.DemoTag</tag-class>
<body-content>empty</body-content>
<attribute>
<name>parameter</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
<tag>
<name>demo2</name>
<tag-class>com.mycompany.DemoTag2</tag-class>
<body-content>jsp</body-content>
</tag>
</taglib>
web.xml 文件无需修改
看看同时使用两种标签的Test.jsp效果
Test.jsp <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<%@taglib uri="/WEB-INF/MyTagLib" prefix="mytag"%>
<html>
<head>
<title>My JSP 'Test.jsp' starting page</title>
</head>
<body>
This is my JSP page. <br>
Date : <mytag:demo parameter="date" /><br>
File : <mytag:demo parameter="filename" />
<hr>
<mytag:demo2>
Date: $date<br>
File: $filename
</mytag:demo2>
</body>
</html>
至此,两种标签方式都完成
本文并没有就相关技术细节做出说明,建议您看看Sun有关JSP自定义标签的官方文档
无论是用自定义标签,还是使用JavaBean,都没有太大的区别,各人或者团队可以根据自己的习惯使用如果需要在独立类库中封装一些供页面使用的单元,自定义标签应该更适合些不过现在的IDE环境(MyEclipse)在编写自定义标签的时候可能有些不太舒服的情况,界面开发人员使用JavaBean方式可能更方便些,免得莫名其妙的提示干扰您的工作