Struts2 工作原理

容器启动后，FilterDispatcher类被实例化，并调用它的init（FilterConfig filterConfig）方法。其中FilterConfig接口用于储存初始化信息。public interface FilterConfig{ public String getFilterName(); public String getInitParameter(String name); public Enumeration getInitParameterNames(); public ServletContext getServletContext(); }

在init方法中会初始化log信息，然后生成Dispatcher类的实例。

public void init(FilterConfig filterConfig) throws ServletException { try { this.filterConfig = filterConfig; initLogging(); dispatcher = createDispatcher(filterConfig); dispatcher.init(); dispatcher.getContainer().inject(this); staticResourceLoader.setHostConfig(new FilterHostConfig(filterConfig)); } finally { ActionContext.setContext(null); } }

其中createDisplatcher方法的定义如下：将filterConfig中的信息封装到一个Map中，作为Dispatcher类构造函数的参数。

protected Dispatcher createDispatcher(FilterConfig filterConfig) { Map<String, String> params = new HashMap<String, String>(); for (Enumeration e = filterConfig.getInitParameterNames(); e.hasMoreElements();) { String name = (String) e.nextElement(); String value = filterConfig.getInitParameter(name); params.put(name, value); } return new Dispatcher(filterConfig.getServletContext(), params); }

然后dispatcher初始化，主要是读取一些配置文件，

public void init() { if (configurationManager == null) { configurationManager = new ConfigurationManager(BeanSelectionProvider.DEFAULT_BEAN_NAME); } try { init_DefaultProperties(); // [1] init_TraditionalXmlConfigurations(); // [2] init_LegacyStrutsProperties(); // [3] init_CustomConfigurationProviders(); // [5] init_FilterInitParameters() ; // [6] init_AliasStandardObjects() ; // [7] Container container = init_PreloadConfiguration(); container.inject(this); init_CheckConfigurationReloading(container); init_CheckWebLogicWorkaround(container); if (!dispatcherListeners.isEmpty()) { for (DispatcherListener l : dispatcherListeners) { l.dispatcherInitialized(this); } } } catch (Exception ex) { if (LOG.isErrorEnabled()) LOG.error("Dispatcher initialization failed", ex); throw new StrutsException(ex); } }

init_DefaultProperties方法初始化properties配置：

private void init_DefaultProperties() { configurationManager.addConfigurationProvider(new DefaultPropertiesProvider()); }

接下来看DefaultPropertiesProvider类的register方法：

public void register(ContainerBuilder builder, LocatableProperties props) throws ConfigurationException { Settings defaultSettings = null; try { defaultSettings = new PropertiesSettings("org/apache/struts2/default"); } catch (Exception e) { throw new ConfigurationException("Could not find or error in org/apache/struts2/default.properties", e); } loadSettings(props, defaultSettings); }

PropertiesSettings类的构造函数：读取default.properties的内容。

public PropertiesSettings(String name) { URL settingsUrl = ClassLoaderUtils.getResource(name + ".properties", getClass()); if (settingsUrl == null) { LOG.debug(name + ".properties missing"); settings = new LocatableProperties(); return; } settings = new LocatableProperties(new LocationImpl(null, settingsUrl.toString())); // Load settings InputStream in = null; try { in = settingsUrl.openStream(); settings.load(in); } catch (IOException e) { throw new StrutsException("Could not load " + name + ".properties:" + e, e); } finally { if(in != null) { try { in.close(); } catch(IOException io) { LOG.warn("Unable to close input stream", io); } } } }
再来看init_TraditionalXmlConfigurations的方法实现。

首先读取web.xml中的config初始参数值，如果没有配置，默认读取“struts-default.xml,struts-plugin.xml,struts.xml”，

（private static final String DEFAULT_CONFIGURATION_PATHS = "struts-default.xml,struts-plugin.xml,struts.xml";）

所以默认的配置文件必须取名为这三个值，否则不被识别。当然可以添加自己的配置文件，并在web.xml中添加即可。

private void init_TraditionalXmlConfigurations() { String configPaths = initParams.get("config"); if (configPaths == null) { configPaths = DEFAULT_CONFIGURATION_PATHS; } String[] files = configPaths.split("//s*[,]//s*"); for (String file : files) { if (file.endsWith(".xml")) { if ("xwork.xml".equals(file)) { configurationManager.addConfigurationProvider(new XmlConfigurationProvider(file, false)); } else { configurationManager.addConfigurationProvider(new StrutsXmlConfigurationProvider(file, false, servletContext)); } } else { throw new IllegalArgumentException("Invalid configuration file name"); } } }

读取默认的配置文件是，如果不包含xwork.xml，就把StrutsXmlConfigurationrovider类加入ConfigurationProvider队列。

StrutsXmlConfigurationrovider类的构造函数实现：

public StrutsXmlConfigurationProvider(String filename, boolean errorIfMissing, ServletContext ctx) { super(filename, errorIfMissing); this.servletContext = ctx; this.filename = filename; reloadKey = "configurationReload-"+filename; Map<String,String> dtdMappings = new HashMap<String,String>(getDtdMappings()); dtdMappings.put("-//Apache Software Foundation//DTD Struts Configuration 2.0//EN", "struts-2.0.dtd"); dtdMappings.put("-//Apache Software Foundation//DTD Struts Configuration 2.1//EN", "struts-2.1.dtd"); dtdMappings.put("-//Apache Software Foundation//DTD Struts Configuration 2.1.7//EN", "struts-2.1.7.dtd"); setDtdMappings(dtdMappings); File file = new File(filename); if (file.getParent() != null) { this.baseDir = file.getParentFile(); } }

此类继承XmlConfigurationProvider，而XmlConfigurationProvider又实现ConfigurationProvider接口。

类XmlConfigurationProvider负责配置文件的读取和解析。addAction()方法负责读取<action>标签，并将数据保存在ActionConfig中；addResultTypes()方法负责将<result-type>标签转化为ResultTypeConfig对象；loadInterceptors()方法负责将<interceptor>标签转化为InterceptorConfi对象；loadInterceptorStack()方法负责将<interceptor-ref>标签转化为InterceptorStackConfig对象；loadInterceptorStacks()方法负责将<interceptor-stack>标签转化成InterceptorStackConfig对象。而上面的方法最终会被addPackage()方法调用，将所读取到的数据汇集到PackageConfig对象中，那么让我们看一下addPackage（）方法的内容：

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.}

而实际的读取xml的方法是loadConfigurationFiles（）方法：

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.}

接下来看init_LegacyStrutsProperties方法的实现。

private void init_LegacyStrutsProperties() { configurationManager.addConfigurationProvider(new LegacyPropertiesConfigurationProvider()); }

LegacyPropertiesConfigurationProvider类的register方法：

public void register(ContainerBuilder builder, LocatableProperties props) throws ConfigurationException { final Settings settings = Settings.getInstance(); loadSettings(props, settings); // Set default locale by lazily resolving the locale property as needed into a Locale object builder.factory(Locale.class, new Factory() { private Locale locale; public synchronized Object create(Context context) throws Exception { if (locale == null) { String loc = context.getContainer().getInstance(String.class, StrutsConstants.STRUTS_LOCALE);//STRUTS_LOCALE = "struts.locale"; if (loc != null) { StringTokenizer localeTokens = new StringTokenizer(loc, "_"); String lang = null; String country = null; if (localeTokens.hasMoreTokens()) { lang = localeTokens.nextToken(); } if (localeTokens.hasMoreTokens()) { country = localeTokens.nextToken(); } locale = new Locale(lang, country); } else { LOG.info("No locale define, substituting the default VM locale"); locale = Locale.getDefault(); } } return locale; } }); }

接下来看init_CustomConfigurationProviders方法：读取web.xml中configProviders初始参数的配置信息。（通常是自定义的Provider）

private void init_CustomConfigurationProviders() { String configProvs = initParams.get("configProviders"); if (configProvs != null) { String[] classes = configProvs.split("//s*[,]//s*"); for (String cname : classes) { try { Class cls = ClassLoaderUtils.loadClass(cname, this.getClass()); ConfigurationProvider prov = (ConfigurationProvider)cls.newInstance(); configurationManager.addConfigurationProvider(prov); } catch (InstantiationException e) { throw new ConfigurationException("Unable to instantiate provider: "+cname, e); } catch (IllegalAccessException e) { throw new ConfigurationException("Unable to access provider: "+cname, e); } catch (ClassNotFoundException e) { throw new ConfigurationException("Unable to locate provider class: "+cname, e); } } } }

剩下的方法与上面这几个类似，就不多赘述了。好了，到此，struts2.0的启动部分就完成了。