使 JSF 支持带有 HTML 标签 的 Message

背景介绍

JSF 的 HtmlMessage 标签一般用于显示系统的 Error 或者 Validation 消息，至于其标准用法可以参考官方文档。在大部分的文章中，都讲解了其如何绑定到标签或者基于 table 和 list 去显示消息，但是这些消息都是标准的文字格式，没有夹带有 HTML tag。比如说，原有系统的所有 error 消息都是存在与 property 文件中，而且格式为

xml 代码

1. ems=<b>Amount Countb> must be more than <font color=green>150$font>

这种格式的消息在被 HtmlMessage tag 渲染显示后，全部变为了转义后的字符，也就是在页面中显示的和上面的文字完全相同。

由于 HtmlOutputText 控件有 escape 属性，所以可以很好地解决这种问题，可是在 HtmlMessage 控件中没有提供这种属性。

解决方法

正是受到 HtmlOutputText 的影响，才想到能不能自己写一个类似的标签来解决相应的问题。那么问题的关键是这些 validation message 是在什么时候被转义的，是在传递到标签之前还是之后。如果是在传递到标签之前，那么这种方法是没有任何意义的，因为无论你的标签怎么写，你所接受到的都是已经转义后的内容了。

经过求证发现，所有的 FacesMessage 可以通过 FacesContext 获取到，而且 Message 中的消息都是没有转义之前的内容，这样就可以通过自定义标签来解决上面的问题了。

java 代码

1. package com.xxx.xxx;
2. import javax.servlet.jsp.*;
3. import javax.servlet.jsp.tagext.*;
4. import java.io.IOException;
6. import java.util.Iterator;
8. import javax.faces.application.FacesMessage;
9. import javax.faces.context.FacesContext;
11. public class ValidatorTag implements javax.servlet.jsp.tagext.Tag{
12. private PageContext pageContext;
13. private Tag parent;
15. public ValidatorTag() {
16. super();
17. }
19. /**
20. * configure tag context
21. */
23. public void setPageContext(PageContext pageContext){
24. this.pageContext = pageContext;
25. }
27. /**
28. * configure the last level tag
29. */
31. public void setParent(Tag parent){
32. this.parent = parent;
33. }
35. public int doStartTag()throws JspTagException{
36. return SKIP_BODY;
37. }
39. public int doEndTag() throws JspTagException{
40. try{
41. // there is tag logic
42. String errorMessages = "";
43. FacesContext ctx = FacesContext.getCurrentInstance();
44. if(ctx.getMessages()!=null){
45. for (Iterator i = ctx.getMessages(); i.hasNext(); ) {
46. FacesMessage o = (FacesMessage) i.next();
47. errorMessages = errorMessages + o.getDetail();
48. }
49. }
50. if(!errorMessages.equals(""))
51. pageContext.getOut().write(errorMessages);
52. }catch(IOException e){
53. throw new JspTagException(e.getMessage());
54. }
55. return EVAL_PAGE;
56. }
58. public void release(){
60. }
62. public PageContext getPageContext() {
63. return pageContext;
64. }
66. public Tag getParent() {
67. return parent;
68. }
69. }

因为仅仅是为了在页面上显示 validation 信息，所以没有必要在 faces-config.xml 中注册。为了在JSP页面中可用，需要在TLD中进行声明如下：

xml 代码

1. xml version="1.0" encoding="ISO-8859-1" ?>
2. <taglib xmlns="http://java.sun.com/xml/ns/j2ee"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee web-jsptablibrary_2_0.xsd"
5. version="2.0">
6. <description>Demo</description>
7. <tlib-version>1.0</tlib-version>
9. <short-name>Demo Tag</short-name>
10. <uri>http://com.demo/tags</uri>
12. <tag>
13. <description>This is a Tag for Validation Error Message</description>
14. <name>errorMessage</name>
15. <tag-class>com.cxxx.xxx.ValidatorTag</tag-class>
16. <body-content>empty</body-content>
17. </tag>
18. </taglib>