本文主要通過三個方面給大家介紹webwork action調用相關知識,三個方面分別是:
1.這部分框架類關系
2.Webwork 獲取和包裝 web 參數
3.DefaultActionProxyFactory、DefaultActionProxy、DefaultActionInvocation
一路走來,終於要開始 webwork 核心業務類的總結,webwork 通過對客戶端傳遞的 web 參數重新包裝,進行執行業務 Action 類,並反饋執行結果,本篇源碼分析對應下圖 WebWork 框架流轉圖中紅色框的地方。
1.這部分框架類關系
2.Webwork 獲取和包裝 web 參數
•每個Web 框架或多或少的對 Web 請求參數的包裝,用來拿來方便自己使用,當然webwork 也不例外。
•Webwork 每次響應請求的入口方法:
public void service(HttpServletRequest request, HttpServletResponse response) throws ServletException { try { if (encoding != null) { try { request.setCharacterEncoding(encoding); } catch (Exception localException) { } } if (locale != null) { response.setLocale(locale); } if (this.paramsWorkaroundEnabled) { request.getParameter("foo"); } request = wrapRequest(request); //封裝 request請求 serviceAction(request, response, getNameSpace(request), getActionName(request), getRequestMap(request), getParameterMap(request), getSessionMap(request), getApplicationMap()); } catch (IOException e) { String message = "Could not wrap servlet request with MultipartRequestWrapper!"; log.error(message, e); sendError(request, response, , new ServletException(message, e)); } }
•接受 request 、response 參數,並對 request 參數進行封裝,這次封裝主要是針對多媒體請求進行的特殊處理,例如項目中的文件上傳請求,導出各種類型文件等...
•包裝完 request 之後,service 方法調用 ServletDispatche.serviceAction() 方法,並調用 getApplicationMap、getSessionMap、getRequestMap、 getParameterMap、getActionName、getNameSpace 6 個方法開始了Action 業務邏輯調用前的前戲。
•getNameSpace 方法用來獲得一個Action所屬的名稱空間,例如 : "/my/MyAction.action"則返回"/my",具體實現如下:
protected String getNameSpace(HttpServletRequest request){ String servletPath = request.getServletPath(); return getNamespaceFromServletPath(servletPath); } public static String getNamespaceFromServletPath(String servletPath){ servletPath = servletPath.substring(, servletPath.lastIndexOf("/")); return servletPath; }
•getActionName 返回請求的Action的名字,例如:"MyAction.action"則返回"MyAction",具體實現如下:
protected String getActionName(HttpServletRequest request){ String servletPath = (String)request.getAttribute("javax.servlet.include.servlet_path"); if (servletPath == null) { servletPath = request.getServletPath(); } return getActionName(servletPath); } protected String getActionName(String name){ int beginIdx = name.lastIndexOf("/"); int endIdx = name.lastIndexOf("."); return name.substring(beginIdx == - ? : beginIdx + , endIdx == - ? name.length() : endIdx); }
• getRequestMap 方法返回一個包含請求中所有屬性的Map,具體實現類是 RequestMap,具體代碼如下:
protected Map getRequestMap(HttpServletRequest request){ return new RequestMap(request); }
•getParameterMap 方法返回一個包含請求中所有參數的Map,具體代碼如下:
protected Map getParameterMap(HttpServletRequest request) throws IOException{ return request.getParameterMap(); }
•getSessionMap 方法返回一個包含 session 中所有屬性的 Map,具體實現類是 SessionMap,具體代碼如下:
protected Map getSessionMap(HttpServletRequest request){ return new SessionMap(request); }
•getApplicationMap 方法返回一個包含 Application 中所有屬性的Map,具體實現類 是ApplicationMap,具體代碼如下:
protected Map getApplicationMap(){ return new ApplicationMap(getServletContext()); }
•WebWork之所以要把request 的屬性、參數,session 中的屬性,Application 中的屬性封裝成 Map,僅僅是為了自己使用方便。
public void serviceAction(HttpServletRequest request, HttpServletResponse response, String namespace, String actionName, Map requestMap, Map parameterMap, Map sessionMap, Map applicationMap) { HashMap extraContext = createContextMap(requestMap, parameterMap, sessionMap, applicationMap, request, response, getServletConfig()); extraContext.put("com.opensymphony.xwork.dispatcher.ServletDispatcher", this); OgnlValueStack stack = (OgnlValueStack) request.getAttribute("webwork.valueStack"); if (stack != null) { extraContext.put("com.opensymphony.xwork.util.OgnlValueStack.ValueStack", new OgnlValueStack(stack)); } try { ActionProxy proxy = ActionProxyFactory.getFactory().createActionProxy(namespace, actionName, extraContext); request.setAttribute("webwork.valueStack", proxy.getInvocation().getStack()); proxy.execute(); if (stack != null) { request.setAttribute("webwork.valueStack", stack); } } catch (ConfigurationException e) { log.error("Could not find action", e); sendError(request, response, 404, e); } catch (Exception e) { log.error("Could not execute action", e); sendError(request, response, 500, e); } }
•首先 ServiceAction 調用了createContextMap 創建Action 上下文(extraContext)。 它將JavaServlet 相關的對象進行包裝,放入extraContext Map對象裡。
•接著檢查 上一個請求中是否有可用的值堆棧,如果有就放入extraContext 這個Map 對象裡,供本次請求使用 。
•ActionContext(com.opensymphony.xwork.ActionContext)是Action執行時的上下文,上下文 可以看作是一個容器(其實我們這裡的容器就是一個Map 而已),它存放的是Action 在執行時需要用到的對象。
• ServletActionContext ( com.opensymphony.webwork. ServletActionContext),這個類直接繼承了ActionContext,它提供了直接與JavaServlet 相關象訪問的功能。
•OgnlValueStack主要的功能是通過表達式語言來存取對象的屬性。
3.DefaultActionProxyFactory、DefaultActionProxy、DefaultActionInvocation
前戲終於做完了,Action 調用的三兄弟要登場進行最重要的操作了,就是下面這三句代碼,與Webwork 學習之路(五)請求跳轉前 xwork.xml 的讀取代碼有非常相似的寫法和設計:
ActionProxy proxy = ActionProxyFactory.getFactory().createActionProxy(namespace, actionName, extraContext); request.setAttribute("webwork.valueStack", proxy.getInvocation().getStack());
proxy.execute(); •通過由前面獲得的namespace、actionName、extraContext 創建調用代理 ActonProxy 實例,這裡也就是 DefaultActionProxy,之後調用 了 ActionProxy.execute 方法來執行我們邏輯Action.execute。
•ActionProxy是一個接口,ActionProxyFactory則是一個抽象類,默認情況下它們是通過 DefaultActionProxy和DefaultActionProxyFactory來完成操作的。
•在 ActionProxyFactory 中有一個靜態變量 factory ,它指向的是一個 DefaultActionProxyFactory 實例,代碼如下:
static ActionProxyFactory factory = new DefaultActionProxyFactory(); public static void setFactory(ActionProxyFactory factory){ factory = factory; } public static ActionProxyFactory getFactory(){ return factory; }
• DefaultActionProxyFactory 的 createActionProxy 方法返回了 DefaultActionProxy 實例。
public ActionProxy createActionProxy(String namespace, String actionName, Map extraContext)throws Exception { setupConfigIfActionIsCommand(namespace, actionName); return new DefaultActionProxy(namespace, actionName, extraContext, true); } •DefaultActionProxy的構造函數 protected DefaultActionProxy(String namespace, String actionName, Map extraContext, boolean executeResult) throws Exception{ if (LOG.isDebugEnabled()) { LOG.debug("Creating an DefaultActionProxy for namespace " + namespace + " and action name " + actionName); } this.actionName = actionName; this.namespace = namespace; this.executeResult = executeResult; this.extraContext = extraContext; this.config = ConfigurationManager.getConfiguration().getRuntimeConfiguration().getActionConfig(namespace, actionName); if (this.config == null) { String message; String message; if ((namespace != null) && (namespace.trim().length() > 0)) { message = LocalizedTextUtil.findDefaultText("xwork.exception.missing-package-action", Locale.getDefault(), new String[] { namespace, actionName }); } else { message = LocalizedTextUtil.findDefaultText("xwork.exception.missing-action", Locale.getDefault(), new String[] { actionName }); } throw new ConfigurationException(message); } prepare(); }
•將傳入的名稱空間、 Action 的名字等參數賦予本地變量,接著通過 ConfigurationManager 獲得當前請求的 Action 的配置信息[這裡在5中已經描述過]。接著調用自身的 prepare 方法創建一個 ActionInvocation 對象賦予自身變量 invocation。在之後的 execute 方法中通過操縱invocation 來實現我們自己寫的Action 的調用。
protected void prepare() throws Exception { this.invocation = ActionProxyFactory.getFactory().createActionInvocation(this, this.extraContext); }
以上所示是針對Webwork中Action 調用 的相關知識,希望對大家有所幫助。