1. 程式人生 > >struts2核心工作流程與原理

struts2核心工作流程與原理

1. Struts2架構圖
這是Struts2官方站點提供的Struts 2 的整體結構。


2. Struts2部分類介紹
這部分從Struts2參考文件中翻譯就可以了。
ActionMapper
        ActionMapper其實是HttpServletRequest和Action呼叫請求的一個對映,它遮蔽了Action對於Request等java Servlet類的依賴。Struts2中它的預設實現類是DefaultActionMapper,ActionMapper很大的用處可以根據自己的需要來設計url格式,它自己也有Restful的實現,具體可以參考文件的docs\actionmapper.html。
ActionProxy&ActionInvocation
        Action的一個代理,由ActionProxyFactory建立,它本身不包括Action例項,預設實現DefaultActionProxy是由ActionInvocation持有Action例項。ActionProxy作用是如何取得Action,無論是本地還是遠端。而ActionInvocation的作用是如何執行Action,攔截器的功能就是在ActionInvocation中實現的。
ConfigurationProvider&Configuration
        ConfigurationProvider就是Struts2中配置檔案的解析器,Struts2中的配置檔案主要是尤其實現類XmlConfigurationProvider及其子類StrutsXmlConfigurationProvider來解析。

3. Struts2請求流程

1、客戶端傳送請求
2、請求先通過ActionContextCleanUp-->FilterDispatcher
3、FilterDispatcher通過ActionMapper來決定這個Request需要呼叫哪個Action
4、如果ActionMapper決定呼叫某個Action,FilterDispatcher把請求的處理交給ActionProxy,這兒已經轉到它的Delegate--Dispatcher來執行
5、ActionProxy根據ActionMapping和ConfigurationManager找到需要呼叫的Action類
6、ActionProxy建立一個ActionInvocation的例項
7、ActionInvocation呼叫真正的Action,當然這涉及到相關攔截器的呼叫
8、Action執行完畢,ActionInvocation建立Result並返回,當然,如果要在返回之前做些什麼,可以實現PreResultListener。新增PreResultListener可以在Interceptor中實現。


另一個版本:大同小異~
一個請求在Struts2框架中的處理大概分為以下幾個步驟:
1.
客戶端提起一個(HttpServletRequest)請求,如上文在瀏覽器中輸入”http://localhost:8080/TestMvc/add.action”就是提起一個(HttpServletRequest)請求。
2.請求被提交到一系列(主要是三層)的過濾器(Filter),如(ActionContextCleanUp、其他過濾器(SiteMesh等)、 FilterDispatcher)。注意這裡是有順序的,先ActionContextCleanUp,再其他過濾器(SiteMesh等)、最後到FilterDispatcher。
3.FilterDispatcher是控制器的核心,就是mvc中c控制層的核心。下面粗略的分析下我理解的FilterDispatcher工作流程和原理:FilterDispatcher進行初始化並啟用核心doFilter

其程式碼如下:
Java程式碼
  1. publicvoid doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException ...{   
  2.         HttpServletRequest request = (HttpServletRequest) req;   
  3.         HttpServletResponse response = (HttpServletResponse) res;   
  4.         ServletContext servletContext = filterConfig.getServletContext();   
  5.         // 在這裡處理了HttpServletRequest和HttpServletResponse。 
  6.         DispatcherUtils du = DispatcherUtils.getInstance();   
  7.         du.prepare(request, response);//正如這個方法名字一樣進行locale、encoding以及特殊request parameters設定 
  8.         try ...{   
  9.             request = du.wrapRequest(request, servletContext);//對request進行包裝 
  10.         } catch (IOException e) ...{   
  11.             String message = "Could not wrap servlet request with MultipartRequestWrapper!";   
  12.             LOG.error(message, e);   
  13.             thrownew ServletException(message, e);   
  14.         }   
  15.                 ActionMapperIF mapper = ActionMapperFactory.getMapper();//得到action的mapper 
  16.         ActionMapping mapping = mapper.getMapping(request);// 得到action 的 mapping 
  17.         if (mapping == null) ...{   
  18.             // there is no action in this request, should we look for a static resource? 
  19.             String resourcePath = RequestUtils.getServletPath(request);   
  20.             if ("".equals(resourcePath) && null != request.getPathInfo()) ...{   
  21.                 resourcePath = request.getPathInfo();   
  22.             }   
  23.             if ("true".equals(Configuration.get(WebWorkConstants.WEBWORK_SERVE_STATIC_CONTENT))    
  24.                     && resourcePath.startsWith("/webwork")) ...{   
  25.                 String name = resourcePath.substring("/webwork".length());   
  26.                 findStaticResource(name, response);   
  27.             } else ...{   
  28.                 // this is a normal request, let it pass through 
  29.                 chain.doFilter(request, response);   
  30.             }   
  31.             // WW did its job here 
  32.             return;   
  33.         }   
  34.         Object o = null;   
  35.         try ...{   
  36.             //setupContainer(request); 
  37.             o = beforeActionInvocation(request, servletContext);   
  38.            //整個框架最最核心的方法,下面分析 
  39.             du.serviceAction(request, response, servletContext, mapping);   
  40.         } finally ...{   
  41.             afterActionInvocation(request, servletContext, o);   
  42.             ActionContext.setContext(null);   
  43.         }   
  44.     }   
  45. du.serviceAction(request, response, servletContext, mapping);   
  46. //這個方法詢問ActionMapper是否需要呼叫某個Action來處理這個(request)請求,如果ActionMapper決定需要呼叫某個Action,FilterDispatcher把請求的處理交給ActionProxy 
  47. publicvoid serviceAction(HttpServletRequest request, HttpServletResponse response, String namespace, String actionName, Map requestMap, Map parameterMap, Map sessionMap, Map applicationMap) ...{    
  48.         HashMap extraContext = createContextMap(requestMap, parameterMap, sessionMap, applicationMap, request, response, getServletConfig());  //例項化Map請求 ,詢問ActionMapper是否需要呼叫某個Action來處理這個(request)請求 
  49.         extraContext.put(SERVLET_DISPATCHER, this);    
  50.         OgnlValueStack stack = (OgnlValueStack) request.getAttribute(ServletActionContext.WEBWORK_VALUESTACK_KEY);    
  51.         if (stack != null) ...{    
  52.             extraContext.put(ActionContext.VALUE_STACK,new OgnlValueStack(stack));    
  53.         }    
  54.         try ...{    
  55.             ActionProxy proxy = ActionProxyFactory.getFactory().createActionProxy(namespace, actionName, extraContext);    
  56. //這裡actionName是通過兩道getActionName解析出來的, FilterDispatcher把請求的處理交給ActionProxy,下面是ServletDispatcher的 TODO:  
  57.             request.setAttribute(ServletActionContext.WEBWORK_VALUESTACK_KEY, proxy.getInvocation().getStack());    
  58.             proxy.execute();    
  59.            //通過代理模式執行ActionProxy 
  60.             if (stack != null)...{    
  61.                 request.setAttribute(ServletActionContext.WEBWORK_VALUESTACK_KEY,stack);    
  62.             }    
  63.         } catch (ConfigurationException e) ...{    
  64.             log.error("Could not find action", e);    
  65.             sendError(request, response, HttpServletResponse.SC_NOT_FOUND, e);    
  66.         } catch (Exception e) ...{    
  67.             log.error("Could not execute action", e);    
  68.             sendError(request, response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e);    
  69.         }    
  70. }    



4.FilterDispatcher詢問ActionMapper是否需要呼叫某個Action來處理這個(request)請求,如果ActionMapper決定需要呼叫某個Action,FilterDispatcher把請求的處理交給ActionProxy。
5.ActionProxy通過Configuration Manager(struts.xml)詢問框架的配置檔案,找到需要呼叫的Action類.
如上文的struts.xml配置

Java程式碼
  1. <?xml version="1.0" encoding="GBK"?>   
  2.  <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN""http://struts.apache.org/dtds/struts-2.0.dtd">   
  3.  <struts>   
  4.      <include file="struts-default.xml"/>   
  5.      <package name="struts2"extends="struts-default">   
  6.          <action name="add"
  7.              class="edisundong.AddAction" >   
  8.              <result>add.jsp</result>   
  9.          </action>       
  10.      </package>   
  11.  </struts>   

如果提交請求的是add.action,那麼找到的Action類就是edisundong.AddAction。
6.ActionProxy建立一個ActionInvocation的例項,同時ActionInvocation通過代理模式呼叫Action。但在呼叫之前ActionInvocation會根據配置載入Action相關的所有Interceptor。(Interceptor是struts2另一個核心級的概念)

下面我們來看看ActionInvocation是如何工作的:

ActionInvocation 是Xworks 中Action 排程的核心。而對Interceptor 的排程,也正是由ActionInvocation負責。ActionInvocation 是一個介面, 而DefaultActionInvocation 則是Webwork 對ActionInvocation的預設實現。

Interceptor 的排程流程大致如下:
1. ActionInvocation初始化時,根據配置,載入Action相關的所有Interceptor。
2. 通過ActionInvocation.invoke方法呼叫Action實現時,執行Interceptor。

Interceptor將很多功能從我們的Action中獨立出來,大量減少了我們Action的程式碼,獨立出來的行為具有很好的重用性。XWork、WebWork的許多功能都是有Interceptor實現,可以在配置檔案中組裝Action用到的Interceptor,它會按照你指定的順序,在Action執行前後執行。
那麼什麼是攔截器。
攔截器就是AOP(Aspect-Oriented Programming)的一種實現。(AOP是指用於在某個方法或欄位被訪問之前,進行攔截然後在之前或之後加入某些操作。)
攔截器的例子這裡就不展開了。
struts-default.xml檔案摘取的內容:
Java程式碼
  1. < interceptor name ="alias"class ="com.opensymphony.xwork2.interceptor.AliasInterceptor" />    
  2. < interceptor name ="autowiring"class ="com.opensymphony.xwork2.spring.interceptor.ActionAutowiringInterceptor" />    
  3. < interceptor name ="chain"class ="com.opensymphony.xwork2.interceptor.ChainingInterceptor" />    
  4. < interceptor name ="conversionError"class ="org.apache.struts2.interceptor.StrutsConversionErrorInterceptor" />    
  5. < interceptor name ="createSession"class ="org.apache.struts2.interceptor.CreateSessionInterceptor" />    
  6. < interceptor name ="debugging"class ="org.apache.struts2.interceptor.debugging.DebuggingInterceptor" />    
  7. < interceptor name ="external-ref"class ="com.opensymphony.xwork2.interceptor.ExternalReferencesInterceptor" />    
  8. < interceptor name ="execAndWait"class ="org.apache.struts2.interceptor.ExecuteAndWaitInterceptor" />    
  9. < interceptor name ="exception"class ="com.opensymphony.xwork2.interceptor.ExceptionMappingInterceptor" />    
  10. < interceptor name ="fileUpload"class ="org.apache.struts2.interceptor.FileUploadInterceptor" />    
  11. < interceptor name ="i18n"class ="com.opensymphony.xwork2.interceptor.I18nInterceptor" />    
  12. < interceptor name ="logger"class ="com.opensymphony.xwork2.interceptor.LoggingInterceptor" />    
  13. < interceptor name ="model-driven"class ="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor" />    
  14. < interceptor name ="scoped-model-driven"class ="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor" />    
  15. < interceptor name ="params"class ="com.opensymphony.xwork2.interceptor.ParametersInterceptor" />    
  16. < interceptor name ="prepare"class ="com.opensymphony.xwork2.interceptor.PrepareInterceptor" />    
  17. < interceptor name ="static-params"class ="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor" />    
  18. < interceptor name ="scope"class ="org.apache.struts2.interceptor.ScopeInterceptor" />    
  19. < interceptor name ="servlet-config"class ="org.apache.struts2.interceptor.ServletConfigInterceptor" />    
  20. < interceptor name ="sessionAutowiring"class ="org.apache.struts2.spring.interceptor.SessionContextAutowiringInterceptor" />    
  21. < interceptor name ="timer"class ="com.opensymphony.xwork2.interceptor.TimerInterceptor" />    
  22. < interceptor name ="token"class ="org.apache.struts2.interceptor.TokenInterceptor" />    
  23. < interceptor name ="token-session"class ="org.apache.struts2.interceptor.TokenSessionStoreInterceptor" />    
  24. < interceptor name ="validation"class ="com.opensymphony.xwork2.validator.ValidationInterceptor" />    
  25. < interceptor name ="workflow"class ="com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor" />    
  26. < interceptor name ="store"class ="org.apache.struts2.interceptor.MessageStoreInterceptor" />    
  27. < interceptor name ="checkbox"class ="org.apache.struts2.interceptor.CheckboxInterceptor" />    
  28. < interceptor name ="profiling"class ="org.apache.struts2.interceptor.ProfilingActivationInterceptor" />   



7.一旦Action執行完畢,ActionInvocation負責根據struts.xml中的配置找到對應的返回結果。如上文中將結構返回“add.jsp”,但大部分時候都是返回另外一個action,那麼流程又得走一遍………