创造JSP自定义标签

转自：http://ltc603.iteye.com/blog/70091，仅供学习

在JSP编程中，Struts一般用来处理form和业务逻辑，Struts中使用了很多自定义标签，如html、bean等，但很多时候我们还是需要使用 "<% java code %>" 这样的语句来操作一些输出。为了减少这种代码，可以创建自定义标签。?

???? 一个tag就是一个普通的java类，它唯一特别之处是它必须继承TagSupport或者BodyTagSupport类。这两个类提供了一些方法，负责jsp页面和你编写的类之间的交互，例如输入，输出。而这两个类是由jsp容器提供的，无须开发人员自己实现。换句话说，你只需把实现了业务逻辑的类继承TagSupport或者BodyTagSupport，再做一些特别的工作，你的类就是一个Tag。并且它自己负责和jsp页面的交互，不用你多操心。?

下面介绍如何创建一个自定义标签。?
一．编写java类继承TagSupport或TagSupport?
1） 提供属性的set方法，?
此后这个属性就可以在jsp页面设置。以jstl标签为例 ＜c:out value=""/＞，这个value就是jsp数据到tag之间的入口。所以tag里面必须有一个setValue方法，具体的属性可以不叫value。例如setValue(String data){this.data = data;}?
这个“value”的名称是在tld里定义的。取什么名字都可以，只需tag里提供相应的set方法即可。?
2）处理 doStartTag 或 doEndTag?
? 这两个方法是 TagSupport提供的。 还是以＜c:out value=""/＞为例，当jsp解析这个标签的时候，在“＜”处触发 doStartTag 事件，在“＞”时触发 doEndTag 事件。通常在 doStartTag 里进行逻辑操作，在 doEndTag 里控制输出。?
下面是一个简单的例子?

Java代码? ?

1. package?com.test.tag;??
2. import?java.io.IOException;??
3. import?javax.servlet.jsp.JspTagException;??
4. import?javax.servlet.jsp.tagext.BodyContent;??
5. import?javax.servlet.jsp.tagext.BodyTagSupport;??
6. /**?
7. *?PermissionBodyTag?根据是否有权限显示body内容?
8. ?*/??
9. public?class?PermissionBodyTag?extends?BodyTagSupport?{??
10. ????boolean?permission;??
11. ????public?boolean?isPermission()?{??
12. ????????return?permission;??
13. ????}??
14. ????public?void?setPermission(boolean?permission)?{??
15. ????????this.permission?=?permission;??
16. ????}??
17. ????public?int?doStartTag()?throws?JspTagException?{??
18. ????????if?(permission)?{??
19. ????????????return?EVAL_BODY_INCLUDE;??
20. ????????}?else?{??
21. ????????????return?SKIP_BODY;??
22. ????????}??
23. ????}??
24. ????public?int?doEndTag()?throws?JspTagException?{??
25. ????????System.out.println("doEndTag");??
26. ????????try?{??
27. ????????????if?(bodyContent?!=?null)?{??
28. ????????????????bodyContent.writeOut(bodyContent.getEnclosingWriter());??
29. ????????????}else{??
30. ????????????}??
31. ????????}?catch?(IOException?e)?{??
32. ????????????throw?new?JspTagException("IO?ERROR:"?+?e.getMessage());??
33. ????????}??
34. ????????return?EVAL_PAGE;??
35. ????}??
36. ????public?void?doInitBody()?throws?JspTagException?{??
37. ????}??
38. ????public?void?setBodyContent(BodyContent?bodyContent)?{??
39. ????????this.bodyContent?=?bodyContent;??
40. ????}??
41. }??

　通常你会发现自己绝大多数活动都集中在 doStartTag 或 doEndTag 方法里。确实如此，熟悉一些接口和类之后，写taglib很容易。正如《jsp设计》的作者所言：里面的逻辑稍微有点复杂，但毕竟没有火箭上天那么难。?

二．编写tld文件?
? 标签文件其实只是一个XML格式的说明文件，内容也很简单。?
? 创建tagTest-html.tld文件在这个标签文件中，我们将我们创建的标签取名 tagTest，并声明了类型和参数(permission)。将该文件保存在 /WEB-INF 下面。?

Java代码? ?

1. ?<?xml?version="1.0"?encoding="UTF-8"?>??
2. <!DOCTYPE?taglib?PUBLIC?"-//Sun?Microsystems,?Inc.//DTD?JSP?Tag?Library?1.1//EN"?"http://java.sun.com/j2ee/dtds/web-jsptaglibrary_1_1.dtd">??
3. <taglib>??
4. ????<tlibversion>1.2</tlibversion>??
5. ????<jspversion>1.1</jspversion>??
6. ????<shortname>tagTest</shortname>??
7. ????<uri>/taiji</uri>??
8. ????<tag>??
9. ????????<name>permission</name>??
10. ????????<tagclass>com.test.tag.PermissionBodyTag</tagclass>??
11. ????????<bodycontent>JSP</bodycontent>??
12. ????????<attribute>??
13. ????????????<name>permission</name>??
14. ????????????<required>true</required>??
15. ????????????<rtexprvalue>true</rtexprvalue>??
16. ????????</attribute>??
17. ????</tag>??
18. </taglib>??
19. ???

三．加到web.xml中?
当然，我们还需要将我们自定义的标签添加到 web.xml 中，否则还是无法使用。?

Java代码? ?

1. <taglib>??
2. ????<taglib-uri>/tagTest?</taglib-uri>??
3. ????<taglib-location>/WEB-INF/tagTest-html.tld</taglib-location>??
4. ??</taglib>??

四.在jsp页面导入tld?

Java代码? ?

1. <%@?taglib?uri="/tagTest?"?prefix="tagTest?"%>??

? 这样，你的jsp页面就可以使用自己的tag了。用这个标签就可以根据传人的boolean值来决定标签包的jsp内容是否输出?

Java代码? ?

1. <tagTest:permission?permission="<%?java?code%>">??
2. //需有权限输出，用户才能看到的内容??
3. </tagTest:permission>??

优点?
1. 修改后的JSP文件不再或尽量少包含java代码，. html代码变得非常干净，页面设计人员修改页面文件时，不用担心误删除程序代码了。?
2. 程序开发人员使用简单的空白页就可以进行开发，待页面设计人员提交目标页后，只需简单的编辑即可完成替换?

? 最终使页面和代码尽量分离。?

?

PS:直接继承SimpleTagSupport实现起来更方便简洁

?

?