springMVC请求流程分析及基于注解配置

    Spring mvc是一个基于请求驱动的轻量级web mvc框架。前端控制器是DispatcherServlet;应用控制器其实拆为处理器映射器(Handler Mapping)进行处理器管理和视图解析器(View Resolver)进行视图管理;页面控制器/动作/处理器为Controller接口的实现(也可以是任何的POJO类);支持本地化(Locale)解析、主题(Theme)解析及文件上传等;提供了非常灵活的数据验证、格式化和数据绑定机制;提供了强大的约定大于配置的契约式编程支持。

Spring Web MVC处理请求的流程

···springMVC请求流程分析及基于注解配置_第1张图片

具体执行步骤如下:

  1. 首先用户发送请求————>前端控制器,前端控制器根据请求信息(如URL)来决定选择哪一个页面控制器进行处理并把请求委托给它;图中的1、2步骤;

  2. 页面控制器接收到请求后,进行功能处理,首先需要收集和绑定请求参数到一个对象,这个对象在Spring Web MVC中叫命令对象,并进行验证,然后将命令对象委托给业务对象进行处理;处理完毕后返回一个ModelAndView(模型数据和逻辑视图名);图中的3、4、5步骤;

  3.  前端控制器收回控制权,然后根据返回的逻辑视图名,选择相应的视图进行渲染,并把模型数据传入以便视图渲染;图中的步骤6、7;

  4. 前端控制器再次收回控制权,将响应返回给用户,图中的步骤8;至此整个结束。

Spring MVC架构

   springMVC请求流程分析及基于注解配置_第2张图片

架构图对应的DispatcherServlet核心代码如下:

//前端控制器分派方法
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
		HttpServletRequest processedRequest = request;
		HandlerExecutionChain mappedHandler = null;
		int interceptorIndex = -1;

		try {
			ModelAndView mv;
			boolean errorView = false;

			try {
                   //检查是否是请求是否是multipart(如文件上传),如果是将通过MultipartResolver解析
				processedRequest = checkMultipart(request);
                   //步骤2、请求到处理器(页面控制器)的映射,通过HandlerMapping进行映射
				mappedHandler = getHandler(processedRequest, false);
				if (mappedHandler == null || mappedHandler.getHandler() == null) {
					noHandlerFound(processedRequest, response);
					return;
				}
                   //步骤3、处理器适配,即将我们的处理器包装成相应的适配器(从而支持多种类型的处理器)
				HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

                  // 304 Not Modified缓存支持
			    //此处省略具体代码

				// 执行处理器相关的拦截器的预处理(HandlerInterceptor.preHandle)
				//此处省略具体代码

				// 步骤4、由适配器执行处理器(调用处理器相应功能处理方法)
				mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

				// Do we need view name translation?
				if (mv != null && !mv.hasView()) {
					mv.setViewName(getDefaultViewName(request));
				}

				// 执行处理器相关的拦截器的后处理(HandlerInterceptor.postHandle)
				//此处省略具体代码
			}
			catch (ModelAndViewDefiningException ex) {
				logger.debug("ModelAndViewDefiningException encountered", ex);
				mv = ex.getModelAndView();
			}
			catch (Exception ex) {
				Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
				mv = processHandlerException(processedRequest, response, handler, ex);
				errorView = (mv != null);
			}

			//步骤5 步骤6、解析视图并进行视图的渲染
//步骤5 由ViewResolver解析View(viewResolver.resolveViewName(viewName, locale))
//步骤6 视图在渲染时会把Model传入(view.render(mv.getModelInternal(), request, response);)
			if (mv != null && !mv.wasCleared()) {
				render(mv, processedRequest, response);
				if (errorView) {
					WebUtils.clearErrorRequestAttributes(request);
				}
			}
			else {
				if (logger.isDebugEnabled()) {
					logger.debug("Null ModelAndView returned to DispatcherServlet with name '" + getServletName() +
							"': assuming HandlerAdapter completed request handling");
				}
			}

			// 执行处理器相关的拦截器的完成后处理(HandlerInterceptor.afterCompletion)
			//此处省略具体代码


		catch (Exception ex) {
			// Trigger after-completion for thrown exception.
			triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, ex);
			throw ex;
		}
		catch (Error err) {
			ServletException ex = new NestedServletException("Handler processing failed", err);
			// Trigger after-completion for thrown exception.
			triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, ex);
			throw ex;
		}

		finally {
			// Clean up any resources used by a multipart request.
			if (processedRequest != request) {
				cleanupMultipart(processedRequest);
			}
		}
	}

核心架构的具体流程步骤如下:

  1.  首先用户发送请求——>DispatcherServlet,前端控制器收到请求后自己不进行处理,而是委托给其他的解析器进行处理,作为统一访问点,进行全局的流程控制;

  2. DispatcherServlet——>HandlerMapping, HandlerMapping将会把请求映射为HandlerExecutionChain对象(包含一个Handler处理器(页面控制器)对象、多个HandlerInterceptor拦截器)对象,通过这种策略模式,很容易添加新的映射策略;

  3. DispatcherServlet——>HandlerAdapter,HandlerAdapter将会把处理器包装为适配器,从而支持多种类型的处理器,即适配器设计模式的应用,从而很容易支持很多类型的处理器;

  4. HandlerAdapter——>处理器功能处理方法的调用,HandlerAdapter将会根据适配的结果调用真正的处理器的功能处理方法,完成功能处理;并返回一个ModelAndView对象(包含模型数据、逻辑视图名);

  5. ModelAndView的逻辑视图名——> ViewResolver, ViewResolver将把逻辑视图名解析为具体的View,通过这种策略模式,很容易更换其他视图技术;

  6. View——>渲染,View会根据传进来的Model模型数据进行渲染,此处的Model实际是一个Map数据结构,因此很容易支持其他视图技术;

  7. 返回控制权给DispatcherServlet,由DispatcherServlet返回响应给用户,到此一个流程结束。

 

此处我们只是讲了核心流程,没有考虑拦截器、本地解析、文件上传解析等。


DispatcherServlet:在web.xml进行配置,拦截请求到此前端控制器,然后控制器的doDispatch()处理请求。

HandlerMapping:前端控制器根据HandlerMapping处理请求信息到页面控制器(Controller)处理的映射。

HandlerAdapter:将会把处理器包装为适配器,从而支持多种类型的处理器,根据适配的结果调用真正的处理器的                                    功能处理方法,返回一ModelAndView对象(包含模型数据、逻辑视图名)。

ViewResolver:解析返回的逻辑视图名,以选择具体的视图进行渲染。

Controller:开发所需实现的控制器,调用业务对象处理相关业务功能,返回ModelAndView对象。

Spring3引入RESTful架构支持,基于注解的springmvc

通过@Controller和@RequestMapping注解定义处理器类,内部通过处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter来实现,配置<mvc:annotation-driven>即可。

@Controller:用于标识是处理器类;

@RequestMapping:请求到处理器功能方法的映射规则;

@RequestParam:请求参数到处理器功能处理方法的方法参数上的绑定;

@ModelAttribute:请求参数到命令对象的绑定;

@SessionAttributes:用于声明session级别存储的属性,放置在处理器类上,通常列出模型属性(如@ModelAttribute)对应的名称,则这些属性会透明的保存到session中;

@InitBinder:自定义数据绑定注册支持,用于将请求参数转换到命令对象属性的对应类型;

@CookieValue:cookie数据到处理器功能处理方法的方法参数上的绑定;

@RequestHeader:请求头(header)数据到处理器功能处理方法的方法参数上的绑定;

@RequestBody:请求的body体的绑定(通过HttpMessageConverter进行类型转换);

@ResponseBody:处理器功能处理方法的返回值作为响应体(通过HttpMessageConverter进行类型转换);

@ResponseStatus:定义处理器功能处理方法/异常处理器返回的状态码和原因;

@ExceptionHandler:注解式声明异常处理器;

@PathVariable:请求URI中的模板变量部分到处理器功能处理方法的方法参数上的绑定。

还有比如:

使用Spring 3开始的ConversionService进行类型转换(PropertyEditor依然有效),支持使用@NumberFormat 和 @DateTimeFormat来进行数字和日期的格式化;

HttpMessageConverter(Http输入/输出转换器,比如JSON、XML等的数据输出转换器);

ContentNegotiatingViewResolver,内容协商视图解析器,它还是视图解析器,只是它支持根据请求信息将同一模型数据以不同的视图方式展示(如json、xml、html等),RESTful架构风格中很重要的概念(同一资源,多种表现形式);

Spring 3 引入 一个  mvc XML的命名空间用于支持mvc配置,包括如:

<mvc:annotation-driven>:
      自动注册基于注解风格的处理器需要的DefaultAnnotationHandlerMapping、AnnotationMethodHandlerAdapter
      支持Spring3的ConversionService自动注册
      支持JSR-303验证框架的自动探测并注册(只需把JSR-303实现放置到classpath)
      自动注册相应的HttpMessageConverter(用于支持@RequestBody  和 @ResponseBody)(如XML输入输出转换器(只需将JAXP实现放置到classpath)、JSON输入输出转换器(只需将Jackson实现放置到classpath))等。
    <mvc:interceptors>:注册自定义的处理器拦截器;
    <mvc:view-controller>:和ParameterizableViewController类似,收到相应请求后直接选择相应的视图;
    <mvc:resources>:逻辑静态资源路径到物理静态资源路径的支持;
    <mvc:default-servlet-handler>:当在web.xml 中DispatcherServlet使用<url-pattern>/</url-pattern> 映射时,能映射静态资源(当Spring Web MVC框架没有处理请求对应的控制器时(如一些静态资源),转交给默认的Servlet来响应静态文件,否则报404找不到资源错误)。


示例:

Controller

@Controller
@RequestMapping("/base/classroom")
public class ClassroomController {
    
    private ClassroomService classroomService;
    
    private SeqService seqService;
    
    //@RequiresPermissions("/base/classroom/search_classroom")
    @RequestMapping(value="/search_classroom")
    public String searchClassroom(Model model){
        
        return "base/classroom/search_classroom";
    }
    
    //@RequiresPermissions("/base/classroom/search_classroom")
    @RequestMapping(value="/json_classroom")
    public @ResponseBody String jsonClassroom(Parameter parameter){
                      
        String[] beans = {"id","name","code","position","capacity","kind","school_name","school_id"};
        
        Pager<Map<String,Object>> classroomPage = this.classroomService.searchClassroom(parameter);
                
        return PropertyUtil.buildJson(classroomPage, beans);
    }
    
    //@RequiresPermissions("/base/classroom/search_classroom")
    @RequestMapping(value="/view_classroom/{id}")
    public String viewClassroom(Model model,@PathVariable Long id){
        
        Classroom classroom = this.classroomService.getClassroomById(id);
        
        model.addAttribute("classroom",classroom);
        
        return "base/classroom/view_classroom";
    }
    
    //@RequiresPermissions("/base/classroom/add_classroom")
    @RequestMapping(value="/add_classroom")
    public String addClassroom(Model model){
                      
        return "base/classroom/add_classroom";
    }
    
    //@RequiresPermissions("/base/classroom/add_classroom")
    @RequestMapping(value="/save_classroom")
    public @ResponseBody String saveClassroom(Classroom classroom,HttpServletRequest request){
        
        classroom.setId(this.seqService.getSequence(ClassroomService.SEQ_NAME));
        classroom.setEnabled(Constants.VALID);
        
        this.classroomService.saveClassroom(classroom);
                     
        return MessageResolver.getMessage(request,"manage_success");
    }
    
    //@RequiresPermissions("/base/classroom/edit_classroom")
    @RequestMapping(value="/edit_classroom/{id}")
    public String editClassroom(Model model,@PathVariable Long id){
        
        Classroom classroom = this.classroomService.getClassroomById(id);
        
        model.addAttribute("classroom",classroom);
                 
        return "base/classroom/edit_classroom";
    }
    
    //@RequiresPermissions("/base/classroom/edit_classroom")
    @RequestMapping(value="/update_classroom")
    public @ResponseBody String updateClassroom(Classroom classroom,HttpServletRequest request){
        
        this.classroomService.updateClassroom(classroom);
                      
        return MessageResolver.getMessage(request,"manage_success");
    }
    
    //@RequiresPermissions("/base/classroom/delete_classroom")
    @RequestMapping(value="/delete_classroom/{id}")
    public @ResponseBody String deleteClassroomById(@PathVariable Long id,HttpServletRequest request){
    
        try{
          this.classroomService.deleteClassroomById(id);
        }catch(DataAccessException e){
            return MessageResolver.getMessage(request,"manage_fail");
        }
        
        return MessageResolver.getMessage(request,"manage_success");
    }
    
    @Autowired
    public void setClassroomService(ClassroomService classroomService) {
        this.classroomService = classroomService;
    }
    
    @Autowired
    public void setSeqService(SeqService seqService) {
        this.seqService = seqService;
    }
}

spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">
  
  <bean id="messageSource" class="com.minyond.core.common.context.ReloadableResourceBundleMessageSource">
    <property name="cacheSeconds" value="-1"/>
    <property name="basenames">
      <list>
        <value>classpath*:i18n/*.properties</value>
      </list>
    </property>
  </bean>
  
	<!-- 自动扫描且只扫描@Controller -->
	<context:component-scan base-package="com.minyond.modules" use-default-filters="false">
		<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
		<context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice"/>
	</context:component-scan>
	
	<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager">
		<mvc:message-converters register-defaults="true">
			<!-- 将StringHttpMessageConverter的默认编码设为UTF-8 -->
			<bean class="org.springframework.http.converter.StringHttpMessageConverter">
		    <constructor-arg value="UTF-8" />
			</bean>
			<!-- 将Jackson2HttpMessageConverter的默认格式化输出设为true -->
			<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
        <property name="prettyPrint" value="true"/>
      </bean>
  	</mvc:message-converters>
	</mvc:annotation-driven>

  <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">  
    <property name="defaultEncoding" value="utf-8" />  
    <property name="maxUploadSize" value="52428800" />  
    <property name="maxInMemorySize" value="40960" />  
  </bean>  
    
	<!-- REST中根据URL后缀自动判定Content-Type及相应的View -->
	<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
	  <property name="mediaTypes" >
	    <value>
	      json=application/json
	      xml=application/xml
	    </value>
	  </property>
	</bean>
	
	<bean id="localeResolver" class="org.springframework.web.servlet.i18n.CookieLocaleResolver">
    <property name="cookieName" value="clientlanguage"/>
    <property name="cookieMaxAge" value="94608000"/>
    <property name="defaultLocale" value="zh" />  
  </bean>
  

  <context:property-placeholder ignore-resource-not-found="true"
      location="classpath*:/application.properties" />
      
	<bean id="freeMarkerConfigurer"
    class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
      <property name="templateLoaderPath" value="/WEB-INF/view/" />
      <property name="freemarkerVariables">
	      <map>
	        <entry key="schoolDirective" value-ref="schoolDirective"/>
	        <entry key="dictionaryDirective" value-ref="dictionaryDirective"/>
	        <entry key="gradeDirective" value-ref="gradeDirective"/>
	        <entry key="periodDirective" value-ref="periodDirective"/>
          <entry key="subjectDirective" value-ref="subjectDirective"/>
          <entry key="sideDirective" value-ref="sideDirective"/>
	        <entry key="permissionDirective" value-ref="permissionDirective"/>
	        <entry key="commonContext" value="${commonContext}"/>
	        <entry key="personalContext" value="${personalContext}"/>
	        <entry key="exportTemplatePath" value="${exportTemplatePath}"/>
	        <entry key="courseDirective" value-ref="courseDirective"/>
	        <entry key="publisherDirective" value-ref="publisherDirective"/>
	        <entry key="schoolTermDirective" value-ref="schoolTermDirective"/>
	      </map>
      </property>
      <property name="freemarkerSettings">
        <props>
          <prop key="template_update_delay">0</prop>                                              
          <prop key="defaultEncoding">UTF-8</prop>
          <prop key="url_escaping_charset">UTF-8</prop>
          <prop key="locale">zh_CN</prop>
          <prop key="boolean_format">true,false</prop>
          <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop>
          <prop key="date_format">yyyy-MM-dd</prop>
          <prop key="time_format">HH:mm:ss</prop>
          <prop key="number_format">0.######</prop>
          <prop key="whitespace_stripping">true</prop>
          <prop key="template_exception_handler">ignore</prop>
          <prop key="classic_compatible">true</prop>
          <prop key="auto_import">ftl/pony/index.ftl as ui,/ftl/spring.ftl as constant</prop>
        </props>
      </property>
  </bean>
  
  <!-- 针对freemarker的视图配置 -->
  <bean id="viewResolver"
    class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
      <property name="cache" value="true" />
      <property name="prefix" value="" />
      <property name="suffix" value=".html" />
      <property name="contentType" value="text/html;charset=UTF-8"></property>
      <property name="requestContextAttribute" value="rc" />
      <property name="exposeSpringMacroHelpers" value="true" />
      <property name="exposeRequestAttributes" value="true" />
      <property name="exposeSessionAttributes" value="true" />
  </bean>
	
	<!-- 容器默认的DefaultServletHandler处理 所有静态内容与无RequestMapping处理的URL-->
	<mvc:default-servlet-handler/>
	
	<!-- 定义无需Controller的url<->view直接映射
	<mvc:view-controller path="/" view-name="login"/>
	 -->
	 
	<!-- 支持 Shiro对Controller的方法级AOP安全控制  begin-->
  <bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" depends-on="lifecycleBeanPostProcessor">
    <property name="proxyTargetClass" value="true" />
  </bean>
  
  <bean class="org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor">
      <property name="securityManager" ref="securityManager"/>
  </bean>
  
	<!-- 将Controller抛出的异常转到特定View -->
	<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
		<property name="exceptionMappings">
			<props>
				<prop key="org.apache.shiro.authz.UnauthorizedException">error/403</prop>
				<prop key="java.lang.Throwable">error/500</prop>
      </props>  
		</property>  
  </bean> 
    
</beans>

web.xml

<servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath*:/spring/spring-mvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>


以上示例是系统中的部分代码,贴出来是为了加强对基于注解配置的RESTful应用的理解,并不具通用性。

spring3+mybatis3基于注解配置快速开发RESTful应用


你可能感兴趣的:(springMVC)