学步园

首先是简单的例子：

package com.tb.struts2.sourceAnalysis.chap1;</p> <p>public class DirectAction {<br /> public String execute(){<br /> System.out.println("cross the street");<br /> return "success";<br /> }<br /> }

<?xml version="1.0" encoding="UTF-8" ?><br /> <!DOCTYPE struts PUBLIC<br /> "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"<br /> "http://struts.apache.org/dtds/struts-2.0.dtd"></p> <p><struts><br /> <constant name="struts.action.excludePattern" value="/beckham/.*"></constant></p> <p> <!-- 默认执行这个package --><br /> <package name="defaultfuck" namespace="/path" extends="struts-default"></p> <p> <action name="direct" class="com.tb.struts2.sourceAnalysis.chap1.DirectAction"><br /> <result name="success">/ok.jsp</result><br /> </action> </p> <p> </package></p> <p></struts></p> <p><?xml version="1.0" encoding="UTF-8"?><br /> <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"<br /> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br /> xsi:schemaLocation="http://java.sun.com/xml/ns/javaee<br /> http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"></p> <p> <filter><br /> <filter-name>struts2</filter-name><br /> <filter-class><br /> org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter<br /> </filter-class><br /> </filter></p> <p> <filter-mapping><br /> <filter-name>struts2</filter-name><br /> <url-pattern>/*</url-pattern><br /> </filter-mapping></p> <p> <welcome-file-list><br /> <welcome-file>index.jsp</welcome-file><br /> </welcome-file-list><br /> </web-app>

******************************

 1. 根据filter的url匹配模式过滤请求过来的每个地址，进入到StrutsPrepareAndExecuteFilter类的doFilter方法。

public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {<br /> HttpServletRequest request = (HttpServletRequest) req;<br /> HttpServletResponse response = (HttpServletResponse) res;</p> <p> try {<br /> /* 设置编码国际化信息 */<br /> prepare.setEncodingAndLocale(request, response);<br /> /* 为每个action设置对应的上下文环境 */<br /> prepare.createActionContext(request, response);<br /> /* 保证分发器dispatcher的线程安全，使用了ThreadLocal */<br /> prepare.assignDispatcherToThread();<br /> /* 在配置文件中声明了要struts2不去处理哪些路径<br /> * 例如这样<constant name="struts.action.excludePattern" value="/beckham/.*"></constant><br /> * 意思是struts2将不负责处理这样的路径<br /> */<br /> if ( excludedPatterns != null && prepare.isUrlExcluded(request, excludedPatterns)) {<br /> chain.doFilter(request, response);<br /> } else {<br /> request = prepare.wrapRequest(request);<br /> /*<br /> * 取得对应的请求在struts2配置文件中的对应信息<br /> * 比如命名空间， action名称。 参数， 调用方法名称，后缀名等等。<br /> */<br /> ActionMapping mapping = prepare.findActionMapping(request, response, true);<br /> if (mapping == null) {<br /> /*<br /> * 这里有个问题，如果web.XML中配置成这样<url-pattern>/*</url-pattern> 那么其实所有的连接都会匹配<br /> * 哪怕是简单的<a href="a.jsp" mce_href="a.jsp">aaa</a>, 有一定效率的影响啊。<br /> */<br /> boolean handled = execute.executeStaticResourceRequest(request, response);<br /> if (!handled) {<br /> /* struts2不处理，直接交给后面的filter或者直接映射 */<br /> chain.doFilter(request, response);<br /> }<br /> } else {<br /> /* 一般的action都经过这里，进行下一步，重要！！！！ */<br /> execute.executeAction(request, response, mapping);<br /> }<br /> }<br /> } finally {<br /> /* 页面跳转完成，对请求信息进行清理。对应的action上下文环境清空，threadLocal清空。 */<br /> prepare.cleanupRequest(request);<br /> }<br /> }<br />

    2. execute.executeAction(request, response, mapping);方法带路到了Dispatcher类。

public void serviceAction(HttpServletRequest request, HttpServletResponse response, ServletContext context,<br /> ActionMapping mapping) throws ServletException {</p> <p> /* 把所有的程序属性和servlet属性合并起来装到一个大的HashMap里边 */<br /> Map<String, Object> extraContext = createContextMap(request, response, mapping, context);<br /> /* 试着获取对应的值栈，如果没有获取到，则创建一个新的值栈 */<br /> ValueStack stack = (ValueStack) request.getAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY);<br /> boolean nullStack = stack == null;<br /> if (nullStack) {<br /> ActionContext ctx = ActionContext.getContext();<br /> if (ctx != null) {<br /> stack = ctx.getValueStack();<br /> }<br /> }<br /> if (stack != null) {<br /> extraContext.put(ActionContext.VALUE_STACK, valueStackFactory.createValueStack(stack));<br /> }</p> <p> String timerKey = "Handling request from Dispatcher";<br /> try {<br /> UtilTimerStack.push(timerKey);<br /> /* 从命名空间获得对应的命名空间，action名称，方法名称 */<br /> String namespace = mapping.getNamespace();<br /> String name = mapping.getName();<br /> String method = mapping.getMethod();</p> <p> Configuration config = configurationManager.getConfiguration();<br /> /* 这一步想当关键！！！！重要！！！！获得对应的action代理 标注1 */<br /> ActionProxy proxy = config.getContainer().getInstance(ActionProxyFactory.class).createActionProxy(<br /> namespace, name, method, extraContext, true, false);</p> <p> request.setAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY, proxy.getInvocation().getStack());</p> <p> // if the ActionMapping says to go straight to a result, do it!<br /> if (mapping.getResult() != null) {<br /> Result result = mapping.getResult();<br /> result.execute(proxy.getInvocation());<br /> } else {<br /> /* 一般简单的页面跳转会走到这一步，获得代理，去调用execute执行，这个方法也很重要 标注2 */<br /> proxy.execute();<br /> }</p> <p> // If there was a previous value stack then set it back onto the request<br /> if (!nullStack) {<br /> request.setAttribute(ServletActionContext.STRUTS_VALUESTACK_KEY, stack);<br /> }<br /> } catch (ConfigurationException e) {<br /> // WW-2874 Only log error if in devMode<br /> if(devMode) {<br /> LOG.error("Could not find action or result", e);<br /> }<br /> else {<br /> LOG.warn("Could not find action or result", e);<br /> }<br /> sendError(request, response, context, HttpServletResponse.SC_NOT_FOUND, e);<br /> } catch (Exception e) {<br /> sendError(request, response, context, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e);<br /> } finally {<br /> UtilTimerStack.pop(timerKey);<br /> }<br /> }

    OK，这个方法很重要，有2个标注点。
    标注1：

public ActionProxy createActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext) {<br /> /* 简单的初始化action代理类 */<br /> StrutsActionProxy proxy = new StrutsActionProxy(inv, namespace, actionName, methodName, executeResult, cleanupContext);<br /> /* 注入对应信息，主要用来处理@Inject标签 */<br /> container.inject(proxy);<br /> /* 代理类的准备，确认要调用action的哪个方法，实例化action，并准备好需要的拦截器等 */<br /> proxy.prepare();<br /> /* 返回代理类 */<br /> return proxy;<br /> }<br />

这个prepare方法也很重要。

protected void prepare() {<br /> String profileKey = "create DefaultActionProxy: ";<br /> try {<br /> UtilTimerStack.push(profileKey);<br /> /* 得到对应的ActionConfig，在struts.xml对应的请求的action段信息 */<br /> config = configuration.getRuntimeConfiguration().getActionConfig(namespace, actionName);</p> <p> if (config == null && unknownHandlerManager.hasUnknownHandlers()) {<br /> config = unknownHandlerManager.handleUnknownAction(namespace, actionName);<br /> }<br /> if (config == null) {<br /> String message;</p> <p> if ((namespace != null) && (namespace.trim().length() > 0)) {<br /> message = LocalizedTextUtil.findDefaultText(XWorkMessages.MISSING_PACKAGE_ACTION_EXCEPTION, Locale.getDefault(), new String[]{<br /> namespace, actionName<br /> });<br /> } else {<br /> message = LocalizedTextUtil.findDefaultText(XWorkMessages.MISSING_ACTION_EXCEPTION, Locale.getDefault(), new String[]{<br /> actionName<br /> });<br /> }<br /> throw new ConfigurationException(message);<br /> }</p> <p> /* 这里解析了应该去调用哪个方法。如果没有指定，则默认去调用execute方法， 记住，这里只是指定方法，并不是调用，真正的action还没有实例化 */<br /> resolveMethod();</p> <p> if (!config.isAllowedMethod(method)) {<br /> throw new ConfigurationException("Invalid method: "+method+" for action "+actionName);<br /> }</p> <p> /* 涉及到另一个类DefaultActionInvocation，负责对代理类进行调用，处理 */<br /> invocation.init(this); </p> <p> } finally {<br /> UtilTimerStack.pop(profileKey);<br /> }<br /> }

    来看init方法：

public void init(ActionProxy proxy) {<br /> this.proxy = proxy;<br /> /* 那个很大的Map，添加了几个属性，合并后的map */<br /> Map<String, Object> contextMap = createContextMap();</p> <p> // 获得对应的action环境<br /> ActionContext actionContext = ActionContext.getContext();</p> <p> if (actionContext != null) {<br /> actionContext.setActionInvocation(this);<br /> }<br /> /* 实例化action！！ */<br /> createAction(contextMap);</p> <p> if (pushAction) {<br /> stack.push(action);<br /> contextMap.put("action", action);<br /> }</p> <p> /* 设置 ActionContext */<br /> invocationContext = new ActionContext(contextMap);<br /> invocationContext.setName(proxy.getActionName());</p> <p> /* 拦截器的信息处理 */<br /> List<InterceptorMapping> interceptorList = new ArrayList<InterceptorMapping>(proxy.getConfig().getInterceptors());<br /> interceptors = interceptorList.iterator();<br /> }

    标注2 ， 代理类的execute执行然后到了DefaultActionInvokcation 的 invoke方法

public String invoke() throws Exception {<br /> String profileKey = "invoke: ";<br /> try {<br /> UtilTimerStack.push(profileKey);</p> <p> if (executed) {<br /> throw new IllegalStateException("Action has already executed");<br /> }</p> <p> if (interceptors.hasNext()) {<br /> final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();<br /> String interceptorMsg = "interceptor: " + interceptor.getName();<br /> UtilTimerStack.push(interceptorMsg);<br /> try {<br /> /* 这块理解的不是很透彻，incerpet返回的是intercept.invoke（），所以看起来是if语句，其实做了循环，遍历完了所有的拦截器 */<br /> resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);<br /> }<br /> finally {<br /> UtilTimerStack.pop(interceptorMsg);<br /> }<br /> } else {<br /> /* 这个else最终还是会被执行到，当遍历完所有的拦截器后 */<br /> resultCode = invokeActionOnly();<br /> }</p> <p> // this is needed because the result will be executed, then control will return to the Interceptor, which will<br /> // return above and flow through again<br /> if (!executed) {<br /> if (preResultListeners != null) {<br /> for (Object preResultListener : preResultListeners) {<br /> PreResultListener listener = (PreResultListener) preResultListener;</p> <p> String _profileKey = "preResultListener: ";<br /> try {<br /> UtilTimerStack.push(_profileKey);<br /> listener.beforeResult(this, resultCode);<br /> }<br /> finally {<br /> UtilTimerStack.pop(_profileKey);<br /> }<br /> }<br /> }</p> <p> // 处理结果，去向那个页面！<br /> if (proxy.getExecuteResult()) {<br /> executeResult();<br /> }</p> <p> executed = true;<br /> }</p> <p> return resultCode;<br /> }<br /> finally {<br /> UtilTimerStack.pop(profileKey);<br /> }<br /> }

    同个类下的invokeActionOnly方法经过一次中转到了invokeAction方法

protected String invokeAction(Object action, ActionConfig actionConfig) throws Exception {<br /> /* 获得要执行的方法名称 */<br /> String methodName = proxy.getMethod();</p> <p> if (LOG.isDebugEnabled()) {<br /> LOG.debug("Executing action method = " + actionConfig.getMethodName());<br /> }</p> <p> String timerKey = "invokeAction: " + proxy.getActionName();<br /> try {<br /> UtilTimerStack.push(timerKey);</p> <p> boolean methodCalled = false;<br /> Object methodResult = null;<br /> Method method = null;<br /> try {<br /> /* 反射获得对应的要执行的Method类 */<br /> method = getAction().getClass().getMethod(methodName, EMPTY_CLASS_ARRAY);<br /> } catch (NoSuchMethodException e) {<br /> // hmm -- OK, try doXxx instead<br /> try {<br /> String altMethodName = "do" + methodName.substring(0, 1).toUpperCase() + methodName.substring(1);<br /> method = getAction().getClass().getMethod(altMethodName, EMPTY_CLASS_ARRAY);<br /> } catch (NoSuchMethodException e1) {<br /> // well, give the unknown handler a shot<br /> if (unknownHandlerManager.hasUnknownHandlers()) {<br /> try {<br /> methodResult = unknownHandlerManager.handleUnknownMethod(action, methodName);<br /> methodCalled = true;<br /> } catch (NoSuchMethodException e2) {<br /> // throw the original one<br /> throw e;<br /> }<br /> } else {<br /> throw e;<br /> }<br /> }<br /> }<br /> if (!methodCalled) {<br /> /* 执行action中的方法！ */<br /> methodResult = method.invoke(action, new Object[0]);<br /> }</p> <p> /* 如果是Result的子类，则对应的处理，一般都是JSP，且methodResult这个值一般会是SUCCESS,ERROR,INPUT什么的。所有转else */<br /> if (methodResult instanceof Result) {<br /> this.explicitResult = (Result) methodResult;</p> <p> // Wire the result automatically<br /> container.inject(explicitResult);<br /> return null;<br /> } else {<br /> /* 返回 */<br /> return (String) methodResult;<br /> }<br /> } catch (NoSuchMethodException e) {<br /> throw new IllegalArgumentException("The " + methodName + "() is not defined in action " + getAction().getClass() + "");<br /> } catch (InvocationTargetException e) {<br /> // We try to return the source exception.<br /> Throwable t = e.getTargetException();</p> <p> if (actionEventListener != null) {<br /> String result = actionEventListener.handleException(t, getStack());<br /> if (result != null) {<br /> return result;<br /> }<br /> }<br /> if (t instanceof Exception) {<br /> throw (Exception) t;<br /> } else {<br /> throw e;<br /> }<br /> } finally {<br /> UtilTimerStack.pop(timerKey);<br /> }<br /> }

一切都处理就绪，剩下的就是对于对应的页面进行跳转。通过多次调用到ServletDispatcherResult类，这个类主要负责基本的页面跳转

/**<br /> * finalLocation要跳转的地址 比如/ok.jsp<br /> */<br /> public void doExecute(String finalLocation, ActionInvocation invocation) throws Exception {<br /> if (LOG.isDebugEnabled()) {<br /> LOG.debug("Forwarding to location " + finalLocation);<br /> }</p> <p> PageContext pageContext = ServletActionContext.getPageContext();</p> <p> if (pageContext != null) {<br /> pageContext.include(finalLocation);<br /> } else {<br /> HttpServletRequest request = ServletActionContext.getRequest();<br /> HttpServletResponse response = ServletActionContext.getResponse();<br /> /* 给他想了个名字 叫 请求分发器，也就是根据页面他负责把页面的路径拿来然后给你请求的页面 */<br /> RequestDispatcher dispatcher = request.getRequestDispatcher(finalLocation);</p> <p> /* 在有参数的情况下的处理方式，暂时第一个helloworld没带例子 以后再说 */<br /> if (invocation != null && finalLocation != null && finalLocation.length() > 0<br /> && finalLocation.indexOf("?") > 0) {<br /> String queryString = finalLocation.substring(finalLocation.indexOf("?") + 1);<br /> Map parameters = (Map) invocation.getInvocationContext().getContextMap().get("parameters");<br /> Map queryParams = UrlHelper.parseQueryString(queryString, true);<br /> if (queryParams != null && !queryParams.isEmpty())<br /> parameters.putAll(queryParams);<br /> }</p> <p> // 如果请求的页面不存在， 页面到404 你懂的<br /> if (dispatcher == null) {<br /> response.sendError(404, "result '" + finalLocation + "' not found");</p> <p> return;<br /> }</p> <p> /* 分发页面， 该去哪儿你去哪儿 */<br /> if (!response.isCommitted() && (request.getAttribute("javax.servlet.include.servlet_path") == null)) {<br /> request.setAttribute("struts.view_uri", finalLocation);<br /> request.setAttribute("struts.request_uri", request.getRequestURI());</p> <p> dispatcher.forward(request, response);<br /> } else {<br /> dispatcher.include(request, response);<br /> }<br /> }<br /> }

==============================================================

   简略为如下流程：
    --------------------------------------------------------
    初始化信息
    过滤器
             值栈处理
             获得Action代理
                        初始化代理类(StrutsActionProxy)
                        注入信息（@Inject 如果有）
                        准备信息
                                   指定调用action中哪个方法
                                   实例化action
             执行代理
                        拦截器执行
                        执行action中已经指定好的方法
                        页面跳转
    清空环境
    ------------------------------------------------------
    到此一个页面的简单的跳转的过程就OVER了，暂时没涉及到过多的东西。在看代码时候发现2个问题，经常看到struts2的作者频繁取出action上下文环境或者又放进去。。。这块不是很明白。
    还有对于将信息放在Map和request频繁取出读取的问题，这块也值得探究。不足之处肯定很多，欢迎各位指出，小弟感激不尽。共同学习。