Struts1核心类之RequestProcessor详解

Struts框架只允许应用中存在一个ActionServlet类,但是可以存在多个客户化的RequestProcessor类,每个子应用模块都可以有单独的RequestProcessor类, 

 

ActionServlet主要负责初始化,以及介绍请求并找到合适的RequestRrocessor,之后真正干活的是RequestProecssor和Action. 

在ActionServlet的doGet/doPost中会调用process方法而最终会调用RequestProcessor类的process方法.而在process又调用了17个 processXXX其它方法来完成工作。下面介绍这个方法. 

 

public void process(HttpServletRequest request,
                        HttpServletResponse response)
        throws IOException, ServletException {

        /* 
			如果HTTP请求方式为post,并且contentType为”multipart/form-data”开头,标准的HttpServletRequest对象将被重新包装,以方便处理”multipart”类型的HTTP请求.
			如果请求方式为get,或正congtentType属性不是”mulitipart”,就直接返回原始的HttpServletRequest对象. 
		*/
        request = processMultipart(request);

        /*
			获得请求的URI的路径,这一信息可用于选择合适的Struts Action组件. 
		*/
        String path = processPath(request, response);
        if (path == null) {
            return;
        }
        
        if (log.isDebugEnabled()) {
            log.debug("Processing a '" + request.getMethod() +
                      "' for path '" + path + "'");
        }

        //当ControllerConfig对象的locale属性为true,将读取用户请求中包含的Locale信息,然后把Locale实例保存在session范围内. 
        processLocale(request, response);

        //读取ControllerConfig对象的conttentType属性,然后调用response.setContentType(contentType)方法,设置响应结果的文档类型和字符
        processContent(request, response);

		/*
			读取ControllerConfig对象的nocache属性,如果nocache属性为true,在响应结果中将加入特定的头参数:Pragma,Cache-Control和Expires, 
			防止页面被存储在客户的浏览器的缓存中.
	  */
        processNoCache(request, response);

       //该方法不执行任何操作.直接返回true.子类可以覆盖这个方法. 执行客户化的预处理请求操作. 
        if (!processPreprocess(request, response)) {
            return;
        }
        
		//从session中获取ActionMessages对象
        this.processCachedMessages(request, response);

        // 寻找和用户请求的URI匹配的ActionMapping,如果不存在这样的ActionMapping,则向用户返回恰当的错误信息
        ActionMapping mapping = processMapping(request, response, path);
        if (mapping == null) {
            return;
        }

        /*
		  先判断是否为Action配置了安全角色,如果配置了安全角色,就调用isUserInRole()方法判断当前用户是否具备必需的角色,
		  如果不具备,就结束请求处理流程.,向用户返回恰当的错误消息. 
		*/
        if (!processRoles(request, response, mapping)) {
            return;
        }

         /*
			先判断是否为ActionMapping配置了ActionForm,如果配置了ActionForm,就先从ActionForm的存在范围内（request或session）寻找改ActionForm实例,
			如果不存在,就创建一个实例,接下来把它保存在合适的范围内,保存时使用的属性key为ActionMapping的name属性。 
		*/
        ActionForm form = processActionForm(request, response, mapping);

		//如果为ActionMapping配置了ActionForm，就先调用ActionForm的reset（）方法，再把请求中的表单数据组装到ActionForm中。 
        processPopulate(request, response, form, mapping);

		/*
			如果为ActionMapping配置了ActionForm，并且ActionMapping的validate属性为true，就调用ActionForm的validate（）方法，
			如果validate方法返回的ActionErrors对象中包含ActionMessage对象，说明表单验证失败。
			就把ActionErrors对象放在request范围内，再把请求转发到ActionMapping的input属性指定的Web组件。
			如果ActionForm的validate方法执行表单验证成功，就继续执行下面的处理流程。 
		*/
        if (!processValidate(request, response, form, mapping)) {
            return;
        }

		//判断是否在ActionMapping中配置了forward属性。如果配置了这个属性，就调用RequestDispatcher的forward方法，请求处理流程结束。否则进行下一步。 
        if (!processForward(request, response, mapping)) {
            return;
        }
        
		//判断是否在ActionMapping中配置了include属性。如果配置了这个属性，就调用RequestDispatcher的include方法，请求处理流程结束。否则进行下一步。 
        if (!processInclude(request, response, mapping)) {
            return;
        }

        // 先判断是否在Action缓存中存在这个Action实例，如果没有就新建一个Action实例，把它放在Action缓存中。可以看出Action也是只有一个实例在运行的。 
        Action action = processActionCreate(request, response, mapping);
        if (action == null) {
            return;
        }

        //该方法调用Action实例的execute方法，该方法位于try/catch中，以及捕获异常。
        ActionForward forward =
            processActionPerform(request, response,
                                 action, form, mapping);

        //把你的Action的excute方法返回的ActionFoward对象作为参数传给它，processActionForward对象包的请求转发信息来执行请求转发或重定向。 
        processForwardConfig(request, response, forward);

    }

 

在RequestProcessor类的process方法中，会访问ControllerConfig、ActionMappig和ActionForward实例的属性，ControllerConfig类和struts配置文件的<controlle>r元素对应，ActionMapping类和<action>元素对应，ActionForward和<forward>元素对应，process方法通过访问这三个类实例的属性来获得相关的配置信息。

 

补充下一下调用RequestUtils的方法：

RequestUtils.applicationInstance(java.lang.String className)：通过类名返回一个类实例-------processActionCreate方法中用到。

 

RequestUtils.createActionForm(HttpServletRequest request,ActionMapping mapping,ModulConfig modulConfig,ActionServlet servlet):

先从request或者session中查找ActionForm，如果存在的话就直接返回，否则就创建它的实例，把它存在request或者session范围内，在把它返回。------processActionForm方法中用到

 

RequestUtils.populate(Object obj,HttpServletRequest request):

把Http请求的参数值封装到指定的JavaBean中，请求的参数名和JavaBean的属性名相匹配，当ActionServlet把用户输入的标单数据封装到ActionForm 时，就调用它。-------processPopulate方法中用到。

 

扩展RequestProcessor只需两步即可。

1). 继承RequestProcessor，实现自定义的processXXXXX()处理方法。例如xxxRequestProcessor

2). 在struts-config.xml文件中配置xxxRequestProcessor。用户重写了RequestProcessor ，但Struts 并不知道，必须配置才可以。下面是配置本示例：

 

<controller>  
 <set-property property="processorClass" value="packagename.xxxRequestProcessor" />  
 <set-property property="contentType" value="text/html; charset=utf-8" />  
 <set-property property="nocache" value="true"/>  
</controller>