SpringMVC 的工作机制

在一个工程中如果想要使用 SpringMVC的话，只需要两个步骤

1. 在web.xml中配置一个DispatcherServlet。需要配置一个org.springframework.web.servlet.DispatcherServlet的servlet。
2. 定义一个dispatcherServlet-servlet.xml配置文件。在这个配置文件里面我们只需要扩展一个路径映射关系，定义一个视图解析器，再定义一个业务逻辑的处理流程规则。

这样就可以搞定一个最基本的Spring MVC的应用了。

对于spring MVC框架中，有三个组件是用户必须定义和扩展的：

1. 定义URL映射规则：handlerMapping
2. 实现业务逻辑的handler实例对象：handlerAdapter
3. 渲染模版资源：ViewResolver

下面是传统的配置示例：

<!-- web.xml -->
<servlet>
 <servlet-name>countries</servlet-name>
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
 <servlet-name>countries</servlet-name>
 <url-pattern>*.htm</url-pattern>
</servlet-mapping

<!-- dispatcherServlet-servlet.xml -->
<!--  派遣器收到请求后,把不同的页面派遣到不同的控制器进行处理
Spring有两种MAPPING的机制,默认为BeanNameUrlHandlerMapping,在DispatcherServlet.properties文件中配置
我们这里采用的是SimpleUrlHandlerMapping. -->
<bean id="urlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
 <property name="mappings">
  <props>
   <prop key="/home.htm">countriesController</prop>
  </props>
 </property>
<!-- 在控制器处理前,我们可以将其拦截,进行一些特殊或通用处理;拦截器可以选用Spring已经实现的或我们自己实现的  -->
 <property name="interceptors">
  <list>
   <ref local="localeChangeInterceptor"/>
   <ref local="themeChangeInterceptor"/>
   <ref local="copyInterceptor"/>
  </list>
 </property>
</bean>

<bean id="countriesController" class="cn.jephon.demo.CountriesController" />

下面是用freemaker引擎的配置示例：

<!--web.xml 配置 spring 的DispatcherServlet-->
<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:conf/freemarker-servlet.xml</param-value>
        </init-param>
</servlet>

<!--freemarker-servlet在conf/freemarker-servlet.xml文件中的参数配置如下-->
<!-- freemark -->
    <bean id="freemarkerConfig"
        class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
        <property name="templateLoaderPath" value="/WEB-INF/ftl/" />
        <property name="defaultEncoding" value="UTF-8" />
    </bean>

    <bean id="viewResolver"
    class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
        <property name="cache" value="true" />
        <property name="prefix" value="" />
        <property name="suffix" value=".ftl" />
        <property name="exposeSpringMacroHelpers" value="true" />
        <property name="exposeRequestAttributes" value="true" />
        <property name="exposeSessionAttributes" value="true" />
        <property name="requestContextAttribute" value="request" />
        <property name="contentType" value="text/html; charset=utf-8" />
    </bean>

SpringMVC的入口是DispatchServlet，它的工作大致可以分为两个部分，一个是初始化，另外一个是请求处理。

DispatcherServlet初始化

//DispatcherServlet的初始化方法
@Override
public final void init() throws ServletException {
    if (logger.isDebugEnabled()) {
        logger.debug("Initializing servlet '" + getServletName() + "'");
    }

    // Set bean properties from init parameters.
    try {
        PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
        BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
        ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
        bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, this.environment));
　　　　 //只有HttpServletBean覆盖了此方法，
　　　　 //所以由HttpServletBean读取配置在ServletContext中的bean属性参数，即web.xml中的context-param，然后创建和设置这些bean属性
        initBeanWrapper(bw);
        bw.setPropertyValues(pvs, true);
    }
    catch (BeansException ex) {
        logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
        throw ex;
    }
//由FrameServlet执行此方法，调用FrameworkServlet的createWebApplicationContext方法，初始化spring容器。
　　//调用FrameworkServlet的onRefresh方法完成配置文件的加载，配置文件的加载是先查找servlet的init-param参数中设置的路径，如果没有，就会根据namespace+Servlet的名称来查找XML文件。
　　//Spring容器加载的时候会调用DispatcherServlet的initStrategies方法来初始化springMVC框架所需要的八个组件，
　　//这八个组件对应的八个bean对应都保存在DispatcherServlet类中。
　　initServletBean();

    if (logger.isDebugEnabled()) {
        logger.debug("Servlet '" + getServletName() + "' configured successfully");
    }
}
    protected void initStrategies(ApplicationContext context) {
        //初始化MultipartResolver，主要是处理文件上传服务。
        initMultipartResolver(context);
        //用于处理应用的国际化问题
        initLocaleResolver(context);
        //用于定义一个主题
        initThemeResolver(context);
        //用于定义用户设置的请求映射关系
        initHandlerMappings(context);
        //用于根据Handler的类型定义不同的处理规则
        initHandlerAdapters(context);
        //当Handler处理错误的时候，通过这个handler来做统一的处理
        initHandlerExceptionResolvers(context);
        //将指定的ViewName按照定义的RequestToViewNameTranslator替换成想要的格式。
        initRequestToViewNameTranslator(context);
        //用于将view解析成页面
        initViewResolvers(context);
        //用于映射flash管理的。
        initFlashMapManager(context);
    }

要做的8件事是如下。

1. initMultipartResolver：初始化MultipartResolver，用于处理文件上传服务，如果有文件上传，那么会将当前的HttpServletRequest包装成DefaultMultipartHttp ServletRequest，并且将每个上传的内容封装成CommonsMultipartFile对象。
2. initLocaleResolver：用于处理应用的国际化问题，通过解析请求的Locale和设置响应的Locale来控制应用中的字符编码问题。
3. initThemeResolver：用于定义一个主题，例如，可以根据用户的喜好来设置用户访问的页面的样式，可以将这个样式作为一个Theme Name保存，用于请求的Cookie中或者保存在服务端的Session中，以后每次请求根据这个Theme Name来返回特定的内容。
4. initHandlerMappings：用于定义用户设置的请求映射关系，例如，前面示例中的SimpleUrlHandlerMapping把用于用户请求的URL映射成一个个Handler实例。HandlerMapping必须定义，如果没有定义，将获取DispatcherServlet.properties文件中默认的两个HandlerMapping，分别是BeanNameUrlHandlerMapping和DefaultAnnotationHandlerMapping。
5. initHandlerAdapters：用于根据Handler的类型定义不同的处理规则，例如，定义SimpleControllerHandlerAdapter处理所有Controller的实例对象，在HandlerMapping中将URL映射成一个Controller实例，那么Spring MVC在解析时SimpleController HandlerAdapter就会调用这个Controller实例。同样HandlerAdapters也必须定义，如果没有定义，将获取DispatcherServlet.properties文件中默认的四个Handler Adapters，分别是HttpRequestHandlerAdapter、SimpleControllerHandlerAdapter、ThrowawayControllerHandlerAdapter和AnnotationMethodHandlerAdapter。
6. initHandlerExceptionResolvers：当Handler处理出错时，通过这个Handler来统一做处理，默认的实现类是SimpleMappingExceptionResolver，将错误日志记录在log文件中，并且转到默认的错误页面。
7. initRequestToViewNameTranslator：将指定的ViewName按照定义的RequestToVie wNameTranslator替换成想要的格式，如加上前缀或者后缀等。
8. initViewResolvers：用于将View解析成页面，在ViewResolvers中可以设置多个解析策略，如可以根据JSP来解析，或者按照Velocity模板解析。默认的解析策略是InternalResourceViewResolver，按照JSP页面来解析。

请求处理

上面的是springMVC的工作原理图：

1、客户端发出一个http请求给web服务器，web服务器对http请求进行解析，如果匹配DispatcherServlet的请求映射路径（在web.xml中指定），web容器将请求转交给DispatcherServlet.

2、DipatcherServlet接收到这个请求之后将根据请求的信息（包括URL、Http方法、请求报文头和请求参数Cookie等）以及HandlerMapping的配置找到处理请求的处理器（Handler）。

3-4、DispatcherServlet根据HandlerMapping找到对应的Handler,将处理权交给Handler（Handler将具体的处理进行封装），再由具体的HandlerAdapter对Handler进行具体的调用。

5、Handler对数据处理完成以后将返回一个ModelAndView()对象给DispatcherServlet。

6、Handler返回的ModelAndView()只是一个逻辑视图并不是一个正式的视图，DispatcherSevlet通过ViewResolver将逻辑视图转化为真正的视图View。

7、Dispatcher通过model解析出ModelAndView()中的参数进行解析最终展现出完整的view并返回给客户端。

Control

HandlerMapping初始化：

将URL与Handler的对应关系保存在HandlerMapping集合中，并将所有的interceptors对象保存在adaptedInterceptors数组中，等请求到来的时候执行所有的adaptedIntercoptors数组中的interceptor对象。所有的interceptor必须实现HandlerInterceptor接口。

HandlerAdapter初始化：

Spring MVC中提供了如下三个典型的简单HandlerAdapter实现类。

1. SimpleServletHandlerAdapter：可以继承HttpRequestHandler接口，所有的Handler可以实现其void handleRequest(HttpServletRequest request, HttpServletResponse response)方法，这个方法没有返回值。
2. SimpleControllerHandlerAdapter：可以继承Controller接口，所有的Handler可以实现其public ModelAndView handle(HttpServletRequest request, HttpServletRes ponse response, Object handler)方法，该方法会返回ModelAndView对象，用于后续的模板渲染。
3. SimpleServletHandlerAdapter：可以直接继承Servlet接口，可以将一个Servlet作为一个Handler来处理这个请求。

Spring MVC的HandlerAdapter机制可让Handler的实现更加灵活，不需要和其他框架那样只能和某个Handler接口绑定起来。

对于handlerAdapter的初始化没有什么特别之处，只是简单的创建一个handlerAdapter对象，将这个对象保存在DispatcherServlet的HandlerAdapters集合中。当Spring MVC将某个URL对应到某个Handler时候，在handlerAdapters集合中查询那个handlerAdapter对象supports这个Handler，handlerAdapter对象将会被返回，然后调用这个handlerAdapter接口对应的方法。如果这个handlerAdapter对象是SimpleControllerHandlerAdapter，将调用Controller接口的public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)方法。

Control的调用逻辑：

整个Spring MVC的调用是从DispatcherServlet的doService方法开始的，在doService方法中会将ApplicationContext、localeResolver、themeResolver等对象添加到request中便于在后面使用，接着就调用doDispatch方法，这个方法是主要的处理用户请求的地方。

对于control的处理关键就是：DispatcherServlet的handlerMappings集合中根据请求的URL匹配每一个handlerMapping对象中的某个handler,匹配成功之后将会返回这个handler的处理连接handlerExecutionChain对象。而这个handlerExecutionChain对象中将会包含用户自定义的多个handlerInterceptor对象。

    protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
        for (HandlerMapping hm : this.handlerMappings) {
            if (logger.isTraceEnabled()) {
                logger.trace(
                        "Testing handler map [" + hm + "] in DispatcherServlet with name '" + getServletName() + "'");
            }
            HandlerExecutionChain handler = hm.getHandler(request);
            if (handler != null) {
                return handler;
            }
        }
        return null;
    }

对于handlerInterceptor接口中定义的三个方法中，preHandler和postHandler分别在handler的执行前和执行后执行，afterCompletion在view渲染完成、在DispatcherServlet返回之前执行。当preHandler返回false时，当前的请求将在执行完afterCompletion后直接返回,handler也将不会执行。

在类HandlerExecutionChain中的getHandler()方法是返回object对象的；这里的handler是没有类型的，handler的类型是由handlerAdapter决定的。dispatcherServlet会根据handlerAdapters集合中第一个支持该handler对象的HandlerAdapter对象。接下来去执行handler对象的相应方法了，如果该handler对象的相应方法返回一个ModelAndView对象(SampleControllerHandlerAdapter)接下来就是去执行View渲染了。

Model

如果handler返回了ModelAndView对象，那么说明Handler需要传一个Model实例给view去渲染模版。除了渲染页面需要model实例，在业务逻辑层通常也有Model实例。

ModelAndView对象是连接业务逻辑层与view展示层的桥梁，对spring MVC来说它也是连接Handler与view的桥梁。ModelAndView对象顾名思义会持有一个ModelMap对象和一个View对象或者View的名称(譬如hello.vm模板名字)。ModelMap对象就是执行模版渲染时候所需要的变量对应的实例，如jsp的通过request.getAttribute(String)获取的JSTL标签名对应的对象。velocity中context.get(String)获取$foo对应的变量实例。

public class ModelAndView {

/** View instance or view name String */
    private Object view;

    /** Model Map */
    private ModelMap model;

    /** Indicates whether or not this instance has been cleared with a call to {@link #clear()} */
    private boolean cleared = false;

.....

}

ModelMap其实也是一个Map,Handler中将模版中需要的对象存在这个Map中，然后传递到view对应的ViewResolver中。

不同的ViewResolver会对这个Map中的对象有不同的处理方式；

• velocity中将这个Map保存到VelocityContext中。
• freemarker模板引擎来说将ModelMap包装成freemarker.template. TemplateHash Model
• JSP中将每一个ModelMap中的元素分别设置到request.setAttribute(modelName,modelValue);

View

在spring MVC中，view模块需要两个组件来支持：RequestToViewNameTranslator和ViewResolver

public interface RequestToViewNameTranslator {
    String getViewName(HttpServletRequest request) throws Exception;
}
public interface ViewResolver {
    View resolveViewName(String viewName, Locale locale) throws Exception;
 }

RequestToViewNameTranslator：主要支持用户自定义对viewName的解析，如将请求的ViewName加上前缀或者后缀，或者替换成特定的字符串等。

ViewResolver：主要是根据用户请求的viewName创建适合的模版引擎来渲染最终的页面，ViewResolver会根据viewName创建一个view对象，调用view对象的Void render方法渲染出页面。

public interface View {
void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception;
}

UrlBasedViewResolver类实现了AbstractCachingViewResolver抽象类，通过设置ViewClass来创建View对象。如果使用FreeMarkerViewResolver类，会将ViewClass设置为FreeMarkerView.class；使用VelocityViewResolver类，会将ViewClass设置为VelocityView.class。InternalResourceViewResolver类可以通过注入的方式设置ViewClass属性来初始化自定义的View对象。由于AbstractCachingViewResolver抽象类也继承了WebApplicationObjectSupport，所以所有的AbstractCachingViewResolver子类可以通过覆盖initApplicationContext方法在Spring MVC框架启动时完成初始化工作。如FreeMarkerViewResolver和VelocityViewResolver就是在启动调用setViewClass方法时设置ViewClass属性的。JSP的ViewResolver对应的是InternalResourceViewResolver类，当调用resolveViewName方法时会调用createView方法，将ViewClass属性对应的InternalResourceView类实例化。最后调用InternalResourceView的render方法渲染出JSP页面。

Spring MVC解析View的逻辑：

• dispatcherServlet调用getDefaultViewName（）方法；
• 调用RequestToViewNameTranslator的getViewName方法；
• 调用LocaleResolver接口的resolveLocale方法；
• 调用ViewResolver接口的resolveViewName方法，返回view对象
• 调用render方法渲染出页面

JSP的ViewResolver对应的是InternalResourceViewResolver类，当调用resolveViewName方法时会调用createView方法，将ViewClass属性对应的InternalResourceView类实例化。最后调用InternalResourceView的render方法渲染出JSP页面。

总的时序图