Struts2源码阅读(五)_FilterDispatcher核心控制器

Dispatcher已经在之前讲过，这就好办了。FilterDispatcher是Struts2的核心控制器，首先看一下init()方法。

1. public void init(FilterConfig filterConfig) throws ServletException { 2. try { 3. this.filterConfig = filterConfig; 4. initLogging(); 5. //创建dispatcher,前面都已经讲过啰 6. dispatcher = createDispatcher(filterConfig); 7. dispatcher.init(); 8. //注入将FilterDispatcher中的变量通过container注入,如下面的staticResourceLoader 9. dispatcher.getContainer().inject(this); 10. //StaticContentLoader在BeanSelectionProvider中已经被注入了依赖关系:DefaultStaticContentLoader 11. //可以在struts-default.xml中的<bean>可以找到 12. staticResourceLoader.setHostConfig(new FilterHostConfig(filterConfig)); 13. } finally { 14. ActionContext.setContext(null); 15. } 16. }

 

1. //下面来看DefaultStaticContentLoader的setHostConfig 2. public void setHostConfig(HostConfig filterConfig) { 3. //读取初始参数pakages，调用parse()，解析成类似/org/apache/struts2/static,/template的数组 4. String param = filterConfig.getInitParameter("packages"); 5. //"org.apache.struts2.static template org.apache.struts2.interceptor.debugging static" 6. String packages = getAdditionalPackages(); 7. if (param != null) { 8. packages = param + " " + packages; 9. } 10. this.pathPrefixes = parse(packages); 11. initLogging(filterConfig); 12. }

 

现在回去doFilter的方法,每当有一个Request,都会调用这些Filters的doFilter方法

1. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException { 2. 3. HttpServletRequest request = (HttpServletRequest) req; 4. HttpServletResponse response = (HttpServletResponse) res; 5. ServletContext servletContext = getServletContext(); 6. 7. String timerKey = "FilterDispatcher_doFilter: "; 8. try { 9. 10. // FIXME: this should be refactored better to not duplicate work with the action invocation 11. //先看看ValueStackFactory所注入的实现类OgnlValueStackFactory 12. //new OgnlValueStack 13. ValueStack stack = dispatcher.getContainer().getInstance(ValueStackFactory.class).createValueStack(); 14. ActionContext ctx = new ActionContext(stack.getContext()); 15. ActionContext.setContext(ctx); 16. 17. UtilTimerStack.push(timerKey); 18. 19. //如果是multipart/form-data就用MultiPartRequestWrapper进行包装 20. //MultiPartRequestWrapper是StrutsRequestWrapper的子类，两者都是HttpServletRequest实现 21. //此时在MultiPartRequestWrapper中就会把Files给解析出来,用于文件上传 22. //所有request都会StrutsRequestWrapper进行包装,StrutsRequestWrapper是可以访问ValueStack 23. //下面是参见Dispatcher的wrapRequest 24. // String content_type = request.getContentType(); 25. //if(content_type!= null&&content_type.indexOf("multipart/form-data")!=-1){ 26. //MultiPartRequest multi =getContainer().getInstance(MultiPartRequest.class); 27. //request =new MultiPartRequestWrapper(multi,request,getSaveDir(servletContext)); 28. //} else { 29. // request = new StrutsRequestWrapper(request); 30. // } 31. 32. request = prepareDispatcherAndWrapRequest(request, response); 33. ActionMapping mapping; 34. try { 35. //根据url取得对应的Action的配置信息 36. //看一下注入的DefaultActionMapper的getMapping()方法.Action的配置信息存储在 ActionMapping对象中 37. mapping = actionMapper.getMapping(request, dispatcher.getConfigurationManager()); 38. } catch (Exception ex) { 39. log.error("error getting ActionMapping", ex); 40. dispatcher.sendError(request, response, servletContext, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, ex); 41. return; 42. } 43. 44. //如果找不到对应的action配置，则直接返回。比如你输入***.jsp等等 45. //这儿有个例外，就是如果path是以“/struts”开头，则到初始参数packages配置的包路径去查找对应的静态资源并输出到页面流中，当然.class文件除外。如果再没有则跳转到404 46. if (mapping == null) { 47. // there is no action in this request, should we look for a static resource? 48. String resourcePath = RequestUtils.getServletPath(request); 49. 50. if ("".equals(resourcePath) && null != request.getPathInfo()) { 51. resourcePath = request.getPathInfo(); 52. } 53. 54. if (staticResourceLoader.canHandle(resourcePath)) { 55. // 在 DefaultStaticContentLoader 中:return serveStatic && (resourcePath.startsWith("/struts") || resourcePath.startsWith("/static")); 56. staticResourceLoader.findStaticResource(resourcePath, request, response); 57. } else { 58. // this is a normal request, let it pass through 59. chain.doFilter(request, response); 60. } 61. // The framework did its job here 62. return; 63. } 64. //正式开始Action的方法 65. dispatcher.serviceAction(request, response, servletContext, mapping); 66. 67. } finally { 68. try { 69. ActionContextCleanUp.cleanUp(req); 70. } finally { 71. UtilTimerStack.pop(timerKey); 72. } 73. } 74. }

 

1. //下面是ActionMapper接口的实现类 DefaultActionMapper的getMapping()方法的源代码: 2. public ActionMapping getMapping(HttpServletRequest request, 3. ConfigurationManager configManager) { 4. ActionMapping mapping = new ActionMapping(); 5. String uri = getUri(request);//得到请求路径的URI，如：testAtcion.action或testAction.do 6. 7. 8. int indexOfSemicolon = uri.indexOf(";");//修正url的带;jsessionid 时找不到而且的bug 9. uri = (indexOfSemicolon > -1) ? uri.substring(0, indexOfSemicolon) : uri; 10. 11. uri = dropExtension(uri, mapping);//删除扩展名，默认扩展名为action 12. if (uri == null) { 13. return null; 14. } 15. 16. parseNameAndNamespace(uri, mapping, configManager);//匹配Action的name和namespace 17. 18. handleSpecialParameters(request, mapping);//去掉重复参数 19. 20. //如果Action的name没有解析出来，直接返回 21. 　　　　if (mapping.getName() == null) { 22. 　　　　　　returnnull; 23. 　　　　} 24. 　　　 //下面处理形如testAction!method格式的请求路径 25. 　　　　if (allowDynamicMethodCalls) { 26. 　　　　　　// handle "name!method" convention. 27. 　　　　　　String name = mapping.getName(); 28. 　　　　　　int exclamation = name.lastIndexOf("!");//!是Action名称和方法名的分隔符 29. 　　　　　　if (exclamation != -1) { 30. 　　　　　　　　mapping.setName(name.substring(0, exclamation));//提取左边为name 31. 　　　　　　　　mapping.setMethod(name.substring(exclamation + 1));//提取右边的method 32. 　　　　　　} 33. 　　　　} 34. 35. return mapping; 36. }

 

从代码中看出，getMapping()方法返回ActionMapping类型的对象，该对象包含三个参数：Action的name、namespace和要调用的方法method。
　 　如果getMapping()方法返回ActionMapping对象为null，则FilterDispatcher认为用户请求不是Action， 自然另当别论，FilterDispatcher会做一件非常有意思的事：如果请求以/struts开头，会自动查找在web.xml文件中配置的 packages初始化参数，就像下面这样(注意粗斜体部分)：

# <filter> # <filter-name>struts2</filter-name> # <filter-class> # org.apache.struts2.dispatcher.FilterDispatcher # </filter-class> # <init-param> # <param-name>packages</param-name> # <param-value>com.lizanhong.action</param-value> # </init-param> # lt;/filter>

 

　　FilterDispatcher会将com.lizanhong.action包下的文件当作静态资源处理，即直接在页面上显示文件内容，不过会忽 略扩展名为class的文件。比如在com.lizanhong.action包下有一个aaa.txt的文本文件，其内容为“中华人民共和国”，访问 http://localhost:8081/Struts2Demo/struts/aaa.txt 时会输出txt中的内容
   FilterDispatcher.findStaticResource()方法

1. protectedvoid findStaticResource(String name, HttpServletRequest request, HttpServletResponse response) throws IOException { 2. 　　if (!name.endsWith(".class")) {//忽略class文件 3. 　　　 //遍历packages参数 4. 　　　　for (String pathPrefix : pathPrefixes) { 5. 　　　　　　InputStream is = findInputStream(name, pathPrefix);//读取请求文件流 6. 　　　　　　if (is != null) { 7. 　　　　　　　　... 8. 　　　　　　　　// set the content-type header 9. 　　　　　　　　String contentType = getContentType(name);//读取内容类型 10. 　　　　　　　　if (contentType != null) { 11. 　　　　　　　　　　response.setContentType(contentType);//重新设置内容类型 12. 　　　　　　　　} 13. 　　　　　　　... 14. 　　　　　　　　try { 15. 　　　　　　　　 //将读取到的文件流以每次复制4096个字节的方式循环输出 16. 　　　　　　　　　　copy(is, response.getOutputStream()); 17. 　　　　　　　　} finally { 18. 　　　　　　　　　　is.close(); 19. 　　　　　　　　} 20. 　　　　　　　　return; 21. 　　　　　　} 22. 　　　　} 23. 　　} 24. }

 

如果用户请求的资源不是以/struts开头——可能是.jsp文件，也可能是.html文件，则通过过滤器链继续往下传送，直到到达请求的资源为止。
如 果getMapping()方法返回有效的ActionMapping对象，则被认为正在请求某个Action，将调用 Dispatcher.serviceAction(request, response, servletContext, mapping)方法，该方法是处理Action的关键所在。
下面就来看serviceAction,这又回到全局变量dispatcher中了

1. //Load Action class for mapping and invoke the appropriate Action method, or go directly to the Result. 2. public void serviceAction(HttpServletRequest request, HttpServletResponse response, ServletContext context, 3. ActionMapping mapping) throws ServletException { 4. //createContextMap方法主要把Application、Session、Request的key value值拷贝到Map中 5. Map<String, Object> extraContext = createContextMap(request, response, mapping, context); 6. 7. // If there was a previous value stack, then create a new copy and pass it in to be used by the new Action 8. ValueStack stack = (ValueStack) request.getAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY); 9. boolean nullStack = stack == null; 10. if (nullStack) { 11. ActionContext ctx = ActionContext.getContext(); 12. if (ctx != null) { 13. stack = ctx.getValueStack(); 14. } 15. } 16. if (stack != null) { 17. extraContext.put(ActionContext.VALUE_STACK, valueStackFactory.createValueStack(stack)); 18. } 19. 20. String timerKey = "Handling request from Dispatcher"; 21. try { 22. UtilTimerStack.push(timerKey); 23. String namespace = mapping.getNamespace(); 24. String name = mapping.getName(); 25. String method = mapping.getMethod(); 26. 27. Configuration config = configurationManager.getConfiguration(); 28. //创建一个Action的代理对象，ActionProxyFactory是创建ActionProxy的工厂 29. //参考实现类:DefaultActionProxy和DefaultActionProxyFactory 30. ActionProxy proxy = config.getContainer().getInstance(ActionProxyFactory.class).createActionProxy( 31. namespace, name, method, extraContext, true, false); 32. 33. request.setAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY, proxy.getInvocation().getStack()); 34. 35. // if the ActionMapping says to go straight to a result, do it! 36. //如果是Result,则直接转向,关于Result,ActionProxy,ActionInvocation下一讲中再分析 37. if (mapping.getResult() != null) { 38. Result result = mapping.getResult(); 39. result.execute(proxy.getInvocation()); 40. } else { 41. //执行Action 42. proxy.execute(); 43. } 44. 45. // If there was a previous value stack then set it back onto the request 46. if (!nullStack) { 47. request.setAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY, stack); 48. } 49. } catch (ConfigurationException e) { 50. // WW-2874 Only log error if in devMode 51. if(devMode) { 52. LOG.error("Could not find action or result", e); 53. } 54. else { 55. LOG.warn("Could not find action or result", e); 56. } 57. sendError(request, response, context, HttpServletResponse.SC_NOT_FOUND, e); 58. } catch (Exception e) { 59. sendError(request, response, context, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e); 60. } finally { 61. UtilTimerStack.pop(timerKey); 62. } 63. }

 

http://qidaoxp.javaeye.com/blog/501088