Struts2源碼分析--請求處理

原創 _HongYan_ 2019-02-22 20:33

1. Struts2架構圖

        請求首先通過Filter chain，Filter主要包括ActionContextCleanUp，它主要清理當前線程的ActionContext和Dispatcher；FilterDispatcher主要通過AcionMapper來決定需要調用哪個Action。
        ActionMapper取得了ActionMapping後，在Dispatcher的serviceAction方法裏創建ActionProxy，ActionProxy創建ActionInvocation，然後ActionInvocation調用Interceptors，執行Action本身，創建Result並返回，當然，如果要在返回之前做些什麼，可以實現PreResultListener。

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中實現，不知道其它還有什麼方式？

4. Struts2(2.1.2)部分源碼閱讀
    從org.apache.struts2.dispatcher.FilterDispatcher開始
 

Java代碼 複製代碼 收藏代碼
  1. //創建Dispatcher，此類是一個Delegate，它是真正完成根據url解析，讀取對應Action的地方   
  2. public void init(FilterConfig filterConfig) throws ServletException {   
  3.     try {   
  4.         this.filterConfig = filterConfig;   
  5.   
  6.         initLogging();   
  7.   
  8.         dispatcher = createDispatcher(filterConfig);   
  9.         dispatcher.init();   
  10.         dispatcher.getContainer().inject(this);   
  11.         //讀取初始參數pakages，調用parse()，解析成類似/org/apache/struts2/static,/template的數組   
  12.         String param = filterConfig.getInitParameter("packages");   
  13.         String packages = "org.apache.struts2.static template org.apache.struts2.interceptor.debugging";   
  14.         if (param != null) {   
  15.             packages = param + " " + packages;   
  16.         }   
  17.         this.pathPrefixes = parse(packages);   
  18.     } finally {   
  19.         ActionContext.setContext(null);   
  20.     }   
  21. }  


     順着流程我們看Disptcher的init方法。init方法裏就是初始讀取一些配置文件等，先看init_DefaultProperties，主要是讀取properties配置文件。
 

Java代碼 複製代碼 收藏代碼
  1. private void init_DefaultProperties() {   
  2.     configurationManager.addConfigurationProvider(new DefaultPropertiesProvider());   
  3. }  


    打開DefaultPropertiesProvider
 

Java代碼 複製代碼 收藏代碼
  1. public void register(ContainerBuilder builder, LocatableProperties props)   
  2.          throws ConfigurationException {   
  3.         
  4.      Settings defaultSettings = null;   
  5.      try {   
  6.          defaultSettings = new PropertiesSettings("org/apache/struts2/default");   
  7.      } catch (Exception e) {   
  8.          throw new ConfigurationException("Could not find or error in org/apache/struts2/default.properties", e);   
  9.      }   
  10.         
  11.      loadSettings(props, defaultSettings);   
  12.  }   
  13.   
  14.  //PropertiesSettings   
  15.  //讀取org/apache/struts2/default.properties的配置信息，如果項目中需要覆蓋，可以在classpath裏的struts.properties裏覆寫   
  16.  public PropertiesSettings(String name) {   
  17.         
  18.      URL settingsUrl = ClassLoaderUtils.getResource(name + ".properties", getClass());   
  19.         
  20.      if (settingsUrl == null) {   
  21.          LOG.debug(name + ".properties missing");   
  22.          settings = new LocatableProperties();   
  23.          return;   
  24.      }   
  25.         
  26.      settings = new LocatableProperties(new LocationImpl(null, settingsUrl.toString()));   
  27.   
  28.      // Load settings   
  29.      InputStream in = null;   
  30.      try {   
  31.          in = settingsUrl.openStream();   
  32.          settings.load(in);   
  33.      } catch (IOException e) {   
  34.          throw new StrutsException("Could not load " + name + ".properties:" + e, e);   
  35.      } finally {   
  36.          if(in != null) {   
  37.              try {   
  38.                  in.close();   
  39.              } catch(IOException io) {   
  40.                  LOG.warn("Unable to close input stream", io);   
  41.              }   
  42.          }   
  43.      }   
  44.  }  


    再來看init_TraditionalXmlConfigurations方法，這個是讀取struts-default.xml和Struts.xml的方法。
 

Java代碼 複製代碼 收藏代碼
  1. private void init_TraditionalXmlConfigurations() {   
  2.     //首先讀取web.xml中的config初始參數值   
  3.     //如果沒有配置就使用默認的"struts-default.xml,struts-plugin.xml,struts.xml"，   
  4.     //這兒就可以看出爲什麼默認的配置文件必須取名爲這三個名稱了   
  5.     //如果不想使用默認的名稱，直接在web.xml中配置config初始參數即可   
  6.     String configPaths = initParams.get("config");   
  7.     if (configPaths == null) {   
  8.         configPaths = DEFAULT_CONFIGURATION_PATHS;   
  9.     }   
  10.     String[] files = configPaths.split("\\s*[,]\\s*");   
  11.     //依次解析配置文件，xwork.xml單獨解析   
  12.     for (String file : files) {   
  13.         if (file.endsWith(".xml")) {   
  14.             if ("xwork.xml".equals(file)) {   
  15.                 configurationManager.addConfigurationProvider(new XmlConfigurationProvider(file, false));   
  16.             } else {   
  17.                 configurationManager.addConfigurationProvider(new StrutsXmlConfigurationProvider(file, false, servletContext));   
  18.             }   
  19.         } else {   
  20.             throw new IllegalArgumentException("Invalid configuration file name");   
  21.         }   
  22.     }   
  23. }  


    對於其它配置文件只用StrutsXmlConfigurationProvider，此類繼承XmlConfigurationProvider，而XmlConfigurationProvider又實現ConfigurationProvider接口。類XmlConfigurationProvider負責配置文件的讀取和解析，addAction()方法負責讀取<action>標籤，並將數據保存在ActionConfig中；addResultTypes()方法負責將<result-type>標籤轉化爲ResultTypeConfig對象；loadInterceptors()方法負責將<interceptor>標籤轉化爲InterceptorConfi對象；loadInterceptorStack()方法負責將<interceptor-ref>標籤轉化爲InterceptorStackConfig對象；loadInterceptorStacks()方法負責將<interceptor-stack>標籤轉化成InterceptorStackConfig對象。而上面的方法最終會被addPackage()方法調用，將所讀取到的數據彙集到PackageConfig對象中。來看XmlConfigurationProvider的源代碼，詳細的我自己也就大體瀏覽了一下，各位可以自己研讀。
 

Java代碼 複製代碼 收藏代碼
  1. protected PackageConfig addPackage(Element packageElement) throws ConfigurationException {   
  2.     PackageConfig.Builder newPackage = buildPackageContext(packageElement);   
  3.   
  4.     if (newPackage.isNeedsRefresh()) {   
  5.         return newPackage.build();   
  6.     }   
  7.     .   
  8.   
  9.     addResultTypes(newPackage, packageElement);   
  10.     loadInterceptors(newPackage, packageElement);   
  11.     loadDefaultInterceptorRef(newPackage, packageElement);   
  12.     loadDefaultCla***ef(newPackage, packageElement);   
  13.     loadGlobalResults(newPackage, packageElement);   
  14.     loadGobalExceptionMappings(newPackage, packageElement);   
  15.     NodeList actionList = packageElement.getElementsByTagName("action");   
  16.   
  17.     for (int i = 0; i < actionList.getLength(); i++) {   
  18.         Element actionElement = (Element) actionList.item(i);   
  19.         addAction(actionElement, newPackage);   
  20.     }   
  21.     loadDefaultActionRef(newPackage, packageElement);   
  22.     PackageConfig cfg = newPackage.build();   
  23.     configuration.addPackageConfig(cfg.getName(), cfg);   
  24.     return cfg;   
  25. }  


    這兒發現一個配置上的小技巧，我的xwork2.0.*是沒有的，但是看源碼是看到xwork2.1.*是可以的。繼續看XmlConfigurationProvider的源代碼：
 

Java代碼 複製代碼 收藏代碼
  1. private List loadConfigurationFiles(String fileName, Element includeElement) {   
  2.     List<Document> docs = new ArrayList<Document>();   
  3.     if (!includedFileNames.contains(fileName)) {   
  4.                
  5.             Element rootElement = doc.getDocumentElement();   
  6.             NodeList children = rootElement.getChildNodes();   
  7.             int childSize = children.getLength();   
  8.   
  9.             for (int i = 0; i < childSize; i++) {   
  10.                 Node childNode = children.item(i);   
  11.   
  12.                 if (childNode instanceof Element) {   
  13.                     Element child = (Element) childNode;   
  14.   
  15.                     final String nodeName = child.getNodeName();   
  16.                     //解析每個action配置是，對於include文件可以使用通配符*來進行配置   
  17.                     //如Struts.xml中可配置成<include file="actions_*.xml"/>   
  18.                     if (nodeName.equals("include")) {   
  19.                         String includeFileName = child.getAttribute("file");   
  20.                         if(includeFileName.indexOf('*') != -1 ) {   
  21.                             ClassPathFinder wildcardFinder = new ClassPathFinder();   
  22.                             wildcardFinder.setPattern(includeFileName);   
  23.                             Vector<String> wildcardMatches = wildcardFinder.findMatches();   
  24.                             for (String match : wildcardMatches) {   
  25.                                 docs.addAll(loadConfigurationFiles(match, child));   
  26.                             }   
  27.                         }   
  28.                         else {   
  29.                                
  30.                             docs.addAll(loadConfigurationFiles(includeFileName, child));       
  31.                         }       
  32.                 }   
  33.             }   
  34.             }   
  35.             docs.add(doc);   
  36.             loadedFileUrls.add(url.toString());   
  37.         }   
  38.     }   
  39.     return docs;   
  40. }  
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

Linux基本操作命令

wbzjacky 2019-02-24 13:12:38

444句英語

wbzjacky 2019-02-24 13:12:37

真實的模擬***綜合實驗

wbzjacky 2019-02-24 13:12:37

三層交換機的HSRP、vlan、端口聚合

wbzjacky 2019-02-24 13:12:37

HSRP和二層交換機的端口聚合、vlan

wbzjacky 2019-02-24 13:12:37

路遇一個“乞討者“

楊木藝 2019-02-24 14:19:35

如果同事暗中傷害你，應該怎麼辦？

這個饅頭有餡 2019-02-24 13:59:08

職場中，抱怨越多的員工，越被領導瞧不起！

這個饅頭有餡 2019-02-24 13:59:08

老程序員被裁，應屆生卻能月薪 1.3 萬？這你能忍？

前端高達 2019-02-24 13:48:04

遇到到處蹭吃卻從不請客吃飯的主怎麼辦？

樑軍年 2019-02-24 13:26:35

高標準機房綜合配線安裝

wbzjacky 2019-02-24 13:12:38

IPsec ***實驗

wbzjacky 2019-02-24 13:12:37

網絡系統集成

wbzjacky 2019-02-24 13:12:37

CISCO路由AAA的Easy ***

wbzjacky 2019-02-24 13:12:37

CISCO訪問控制列表 企業網絡管理的必殺技

wbzjacky 2019-02-24 13:12:37