JSF自定义组件之五 JSF实现-Renderer

           上篇已介绍了JSF Tag类的开发，本篇将继续介绍JSF Renderer的开发。

           Renderer类是JSF组件开发中一个较重要的类，该类主要功能是在Java和HTML之间的转换，在响应阶段将Java组件的属性转换为HTML代码，在接受请求阶段将HTML Request中传来的资料转换为Java组件的属性。

           开发Renderer类时需要集成javax.faces.render.Renderer类，需实现其中的encode和decode方法，分别用来用来转换HTML和接受HTML值。

     在Render过程中，有一个难点就是如何将组件中的CSS，Javascript和图片加载到客户端，这里我们会新增一个JSF Phase监听器，用来监听RESTORE_VIEW阶段，判断所请求资源是否为组件所用到的资源，如果请求资源是组件用到的CSS等资源，则直接将资源写到Response中。

 

     Renderer类代码如下：

1. package net.moon.jsf.customer.render;
3. import java.io.IOException;
4. import javax.faces.FacesException;
5. import javax.faces.component.UIComponent;
6. import javax.faces.context.FacesContext;
7. import javax.faces.context.ResponseWriter;
8. import javax.faces.render.Renderer;
10. import net.moon.jsf.customer.component.HtmlDropdownList;
12. public class DropdownListRenderer extends Renderer {
14.     private static final String SELECTOR = "_SELECTOR";
15.     private static final String AREA = "_AREA";
16.     private final static String INPUT = "_INPUT";
17.     private final static String IMAGE = "_IMAGE";
19.     public final static String UNIQURE_JS_KEY = "resource/moonscript.js.jsf";
20.     public final static String UNIQURE_CSS_KEY = "resource/mooncomponent.css.jsf";
21.     public final static String UNIQURE_IMAGE_KEY = "resource/dropdownList.png.jsf";
22.     public final static String UNIQURE_AJAX_KEY = "moonDDL.jsf";
24.     @Override
25.     public void decode(FacesContext context, UIComponent component) {
26.         // TODO Auto-generated method stub
27.         super.decode(context, component);
28.     }
30.     private void renderResourceOnce(FacesContext context) throws IOException {
31.         // render javascript to client
32.         Object isRendered = context.getExternalContext().getRequestMap().get(
33.                 UNIQURE_JS_KEY);
34.         ResponseWriter out = context.getResponseWriter();
35.         out.write("/n");
36.         if (isRendered != null && (Boolean) isRendered) {
37.         } else {
38.             // rendered the javascript
39.             out.startElement("script", null);
40.             out.writeAttribute("type", "text/javascript", null);
41.             out.writeAttribute("src", UNIQURE_JS_KEY, null);
42.             out.endElement("script");
43.             context.getExternalContext().getRequestMap().put(UNIQURE_JS_KEY,
44.                     true);
45.         }
47.         out.write("/n");
48.         isRendered = context.getExternalContext().getRequestMap().get(
49.                 UNIQURE_CSS_KEY);
50.         if (isRendered != null && (Boolean) isRendered) {
51.         } else {
52.             // rendered this css
53.             out.startElement("link", null);
54.             out.writeAttribute("rel", "stylesheet", null);
55.             out.writeAttribute("type", "text/css", null);
56.             out.writeAttribute("href", UNIQURE_CSS_KEY, null);
57.             out.endElement("link");
58.             out.write("/n");
59.             context.getExternalContext().getRequestMap().put(UNIQURE_CSS_KEY,
60.                     true);
61.         }
62.     }
64.     @Override
65.     public void encodeBegin(FacesContext context, UIComponent component)
66.             throws IOException {
67.         // TODO Auto-generated method stub
68.         super.encodeBegin(context, component);
69.         renderResourceOnce(context);
70.         if (context == null || component == null) {
71.             throw new FacesException("context can't be null");
72.         }
73.         if (!(component instanceof HtmlDropdownList)) {
74.             throw new FacesException("error dropdownList object");
75.         }
76.         rendererInput(context, (HtmlDropdownList) component);
78.         rendererImage(context, (HtmlDropdownList) component);
80.         rendererOthers(context, (HtmlDropdownList) component);
82.     }
84.     private void rendererOthers(FacesContext context, HtmlDropdownList component)
85.             throws IOException {
86.         String clientId = component.getClientId(context);
87.         ResponseWriter out = context.getResponseWriter();
89.         out.startElement("div", component);
90.         out.writeAttribute("id", clientId + AREA, null);
91.         out.writeAttribute("class", "dropdown_area", null);
93.         out.startElement("select", component);
94.         out.writeAttribute("id", clientId + SELECTOR, null);
95.         out.writeAttribute("name", clientId + SELECTOR, null);
96.         out.writeAttribute("multiple", "multiple", null);
97.         out.writeAttribute("class", "dropdown_selector", null);
98.         out.writeAttribute("onchange", "giveValue();", null);
99.         out.endElement("select");
101.         out.endElement("div");
102.     }
104.     private void rendererImage(FacesContext context, HtmlDropdownList component)
105.             throws IOException {
106.         // TODO Auto-generated method stub
107.         String clientId = component.getClientId(context);
108.         ResponseWriter out = context.getResponseWriter();
110.         String imageURL = component.getImage();
112.         out.startElement("image", component);
113.         out.writeAttribute("src", imageURL == null ? UNIQURE_IMAGE_KEY
114.                 : imageURL, null);
115.         out.writeAttribute("id", clientId + IMAGE, null);
116.         out.writeAttribute("name", clientId + IMAGE, null);
117.         out.writeAttribute("class", "dropdown_button", null);
118.         out.writeAttribute("onclick", "showSelector(this, '"
119.                 + (component.getValueList() == null ? component
120.                         .getValueExpression("valueList").getExpressionString()
121.                         : component.getValueList()) + "');", null);
122.         out.endElement("image");
123.     }
125.     public DropdownListRenderer() {
126.         super();
127.         // TODO Auto-generated constructor stub
128.     }
130.     private void rendererInput(FacesContext context, HtmlDropdownList component)
131.             throws IOException {
132.         String clientId = component.getClientId(context);
133.         String root = context.getExternalContext().getRequestContextPath();
134.         ResponseWriter out = context.getResponseWriter();
136.         out.startElement("input", component);
137.         out.writeAttribute("type", "text", null);
138.         out.writeAttribute("id", clientId + INPUT, null);
139.         out.writeAttribute("name", clientId + INPUT, null);
140.         out.writeAttribute("class",
141.                 component.getStyleClass() == null ? "dropdown_input"
142.                         : component.getStyleClass(), null);
143.         String changeMethod = component.getValueChange();
144.         if (changeMethod != null) {
145.             out.writeAttribute("onchange", "callBack('" + root + "/"
146.                     + UNIQURE_AJAX_KEY + "?ACTION=VALUECHANGE', '"
147.                     + changeMethod + "', '');", null);
148.         }
149.         out.endElement("input");
150.     }
152. }

Phase Listener代码如下：

 

1. package net.moon.jsf.customer.listener;
3. import java.io.BufferedReader;
4. import java.io.IOException;
5. import java.io.InputStream;
6. import java.io.InputStreamReader;
7. import java.io.OutputStreamWriter;
8. import java.io.PrintWriter;
9. import java.net.URL;
10. import java.net.URLConnection;
12. import javax.el.ValueExpression;
13. import javax.faces.event.PhaseEvent;
14. import javax.faces.event.PhaseId;
15. import javax.faces.event.PhaseListener;
16. import javax.servlet.ServletOutputStream;
17. import javax.servlet.http.HttpServletRequest;
18. import javax.servlet.http.HttpServletResponse;
20. import net.moon.jsf.customer.render.DropdownListRenderer;
22. public class DropDownListener implements PhaseListener {
24.     public void afterPhase(PhaseEvent event) {
25.         // TODO Auto-generated method stub
26.         String rootId = event.getFacesContext().getViewRoot().getViewId();
28.         String root = "/";
30.         if (rootId.endsWith(DropdownListRenderer.UNIQURE_JS_KEY.replace(".jsf",
31.                 ".jsp"))) {
32.             handleResourceRequest(event, root
33.                     + DropdownListRenderer.UNIQURE_JS_KEY, "text/javascript");
34.         } else if (rootId.endsWith(DropdownListRenderer.UNIQURE_CSS_KEY
35.                 .replace(".jsf", ".jsp"))) {
36.             handleResourceRequest(event, root
37.                     + DropdownListRenderer.UNIQURE_CSS_KEY, "text/javascript");
38.         } else if (rootId.endsWith(DropdownListRenderer.UNIQURE_IMAGE_KEY
39.                 .replace(".jsf", ".jsp"))) {
40.             handleImageRequest(event, root
41.                     + DropdownListRenderer.UNIQURE_IMAGE_KEY, "image/png");
42.         } else if (rootId
43.                 .endsWith(root
44.                         + DropdownListRenderer.UNIQURE_AJAX_KEY.replace(".jsf",
45.                                 ".jsp"))) {
46.             handleAjaxEvent(event);
47.         }
48.     }
50.     private void handleAjaxEvent(PhaseEvent event) {
51.         HttpServletResponse response = (HttpServletResponse) event
52.                 .getFacesContext().getExternalContext().getResponse();
53.         PrintWriter out = null;
54.         Object req = event.getFacesContext().getExternalContext().getRequest();
55.         HttpServletRequest request = null;
57.         if (!(req instanceof HttpServletRequest)) {
58.             return;
59.         }
60.         request = (HttpServletRequest) req;
61.         String action = request.getParameter("ACTION");
62.         try {
63.             out = response.getWriter();
64.             ValueExpression ve = event.getFacesContext().getApplication()
65.                     .getExpressionFactory().createValueExpression(
66.                             event.getFacesContext().getELContext(), action,
67.                             String.class);
68.             if (!ve.isLiteralText()) {
69.                 out.write((String) ve.getValue(event.getFacesContext()
70.                         .getELContext()));
71.             } else {
72.                 out.write(ve.toString());
73.             }
74.             response.setStatus(HttpServletResponse.SC_OK);
75.             event.getFacesContext().responseComplete();
76.         } catch (IOException ex) {
77.             ex.printStackTrace();
78.         }
79.         
80.     }
82.     private void handleImageRequest(PhaseEvent event, String resource,
83.             String contentType) {
84.         resource = resource.replace(".jsf", "");
85.         URL url = this.getClass().getResource(resource);
86.         HttpServletResponse response = (HttpServletResponse) event
87.                 .getFacesContext().getExternalContext().getResponse();
88.         ServletOutputStream out = null;
90.         response.setContentType(contentType);
91.         response.setStatus(200);
92.         InputStream input = null;
93.         try {
94.             input = url.openStream();
95.             out = response.getOutputStream();
96.             byte[] cache = new byte[1024];
97.             int readed = 0;
98.             while ((readed = input.read(cache)) != -1) {
99.                 try {
100.                     out.write(cache, 0, readed);
101.                 } catch (Exception ex) {
102.                     System.out.println("*****");
103.                     ex.printStackTrace();
104.                 }
105.             }
106.             input.close();
107.             out.flush();
108.             out.close();
109.         } catch (IOException e) {
110.             // TODO Auto-generated catch block
111.             e.printStackTrace();
112.         }
113.         event.getFacesContext().responseComplete();
114.     }
116.     private void handleResourceRequest(PhaseEvent event, String resource,
117.             String contentType) {
118.         resource = resource.replace(".jsf", "");
119.         URL url = DropDownListener.class.getResource(resource);
121.         URLConnection conn = null;
122.         InputStream stream = null;
123.         BufferedReader bufReader = null;
124.         HttpServletResponse response = (HttpServletResponse) event
125.                 .getFacesContext().getExternalContext().getResponse();
126.         OutputStreamWriter outWriter = null;
127.         String curLine = null;
129.         try {
130.             outWriter = new OutputStreamWriter(response.getOutputStream(),
131.                     response.getCharacterEncoding());
132.             conn = url.openConnection();
133.             conn.setUseCaches(false);
134.             stream = conn.getInputStream();
135.             bufReader = new BufferedReader(new InputStreamReader(stream));
136.             response.setContentType(contentType);
137.             response.setStatus(200);
139.             while (null != (curLine = bufReader.readLine())) {
140.                 outWriter.write(curLine + "/n");
141.             }
143.             outWriter.flush();
144.             outWriter.close();
145.             event.getFacesContext().responseComplete();
146.         } catch (Exception e) {
147.             String message = "Can't load resource:" + url.toExternalForm();
148.             System.err.println(message);
149.             e.printStackTrace();
150.         }
151.     }
153.     public void beforePhase(PhaseEvent event) {
154.         // TODO Auto-generated method stub
155.     }
157.     public PhaseId getPhaseId() {
158.         // TODO Auto-generated method stub
159.         return PhaseId.RESTORE_VIEW;
160.     }
162. }

    本篇就介绍这些，下篇将对组件进行总体汇总，并提供完整代码下载。