您的位置: 首页  >  文章  >  struts 2

struts 2

分类: 文章 • 2022-12-03 00:28:28

1. Struts2架构图 
struts 2
        请求首先通过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代码 struts 2
  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. }  
Java代码  struts 2
  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代码 struts 2
  1. private void init_DefaultProperties() {   
  2.     configurationManager.addConfigurationProvider(new DefaultPropertiesProvider());   
  3. }  
Java代码  struts 2
  1. private void init_DefaultProperties() {  
  2.     configurationManager.addConfigurationProvider(new DefaultPropertiesProvider());  
  3. }  


    打开DefaultPropertiesProvider

Java代码 struts 2
  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.  }  
Java代码  struts 2
  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代码 struts 2
  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. }  
Java代码  struts 2
  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代码 struts 2
  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.     loadDefaultClassRef(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. }  
Java代码  struts 2
  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.     loadDefaultClassRef(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代码 struts 2
  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. }  

相关推荐