Spring MVC 初体验

初探Spring MVC 请求处理流程

Spring MVC 相对于前面的章节算是比较简单的，我们首先引用《Spring in Action》上的一张图来了解Spring MVC 的核心组件和大致处理流程：

image.png

①、DispatcherServlet 是SpringMVC 中的前端控制器(Front Controller),负责接收Request 并将Request 转发给对应的处理组件。
② 、HanlerMapping 是SpringMVC 中完成url 到Controller 映射的组件。DispatcherServlet 接收Request, 然后从HandlerMapping 查找处理Request 的Controller。
③、Controller 处理Request,并返回ModelAndView 对象,Controller 是SpringMVC中负责处理Request 的组件(类似于Struts2 中的Action),ModelAndView 是封装结果视图的组件。
④、⑤、⑥视图解析器解析ModelAndView 对象并返回对应的视图给客户端。

Spring MVC 九大组件

HandlerMappings

HandlerMapping 是用来查找Handler 的，也就是处理器，具体的表现形式可以是类也可以是方法。比如，标注了@RequestMapping 的每个method 都可以看成是一个Handler，由Handler 来负责实际的请求处理。HandlerMapping 在请求到达之后，它的作用便是找到请求相应的处理器Handler 和Interceptors。

HandlerAdapters

从名字上看，这是一个适配器。因为Spring MVC 中Handler 可以是任意形式的，只要能够处理请求便行, 但是把请求交给Servlet 的时候，由于Servlet 的方法结构都是如doService(HttpServletRequest req, HttpServletResponse resp) 这样的形式，让固定的Servlet 处理方法调用Handler 来进行处理，这一步工作便是HandlerAdapter 要做的事。

HandlerExceptionResolvers

从这个组件的名字上看，这个就是用来处理Handler 过程中产生的异常情况的组件。具体来说，此组件的作用是根据异常设置ModelAndView, 之后再交给render()方法进行渲染，而render() 便将ModelAndView 渲染成页面。不过有一点，HandlerExceptionResolver 只是用于解析对请求做处理阶段产生的异常，而渲染阶段的异常则不归他管了，这也是Spring MVC 组件设计的一大原则分工明确互不干涉。

ViewResolvers

视图解析器，相信大家对这个应该都很熟悉了。因为通常在SpringMVC 的配置文件中，都会配上一个该接口的实现类来进行视图的解析。这个组件的主要作用，便是将String类型的视图名和Locale 解析为View 类型的视图。这个接口只有一个resolveViewName()方法。从方法的定义就可以看出，Controller 层返回的String 类型的视图名viewName，最终会在这里被解析成为View。View 是用来渲染页面的，也就是说，它会将程序返回的参数和数据填入模板中，最终生成html 文件。ViewResolver 在这个过程中，主要做两件大事，即，ViewResolver 会找到渲染所用的模板（使用什么模板来渲染？）和所用的技术（其实也就是视图的类型，如JSP 啊还是其他什么Blabla 的）填入参数。默认情况下，Spring MVC 会为我们自动配置一个InternalResourceViewResolver，这个是针对JSP 类型视图的。

RequestToViewNameTranslator

这个组件的作用，在于从Request 中获取viewName. 因为ViewResolver 是根据ViewName 查找View, 但有的Handler 处理完成之后，没有设置View 也没有设置ViewName，便要通过这个组件来从Request 中查找viewName。

LocaleResolver

在上面我们有看到ViewResolver 的resolveViewName()方法，需要两个参数。那么第二个参数Locale 是从哪来的呢，这就是LocaleResolver 要做的事了。LocaleResolver用于从request 中解析出Locale, 在中国大陆地区，Locale 当然就会是zh-CN 之类，用来表示一个区域。这个类也是i18n 的基础。

ThemeResolver

从名字便可看出，这个类是用来解析主题的。主题，就是样式，图片以及它们所形成的显示效果的集合。Spring MVC 中一套主题对应一个properties 文件，里面存放着跟当前主题相关的所有资源，如图片，css 样式等。创建主题非常简单，只需准备好资源，然后新建一个"主题名.properties" 并将资源设置进去，放在classpath 下，便可以在页面中使用了。Spring MVC 中跟主题有关的类有ThemeResolver, ThemeSource 和Theme。ThemeResolver 负责从request 中解析出主题名， ThemeSource 则根据主题名找到具体的主题，其抽象也就是Theme, 通过Theme 来获取主题和具体的资源。

MultipartResolver

其实这是一个大家很熟悉的组件，MultipartResolver 用于处理上传请求，通过将普通的Request 包装成MultipartHttpServletRequest 来实现。MultipartHttpServletRequest可以通过getFile() 直接获得文件，如果是多个文件上传，还可以通过调用getFileMap得到Map<FileName, File> 这样的结构。MultipartResolver 的作用就是用来封装普通的request，使其拥有处理文件上传的功能。

FlashMapManager

说到FlashMapManager，就得先提一下FlashMap。
FlashMap 用于重定向Redirect 时的参数数据传递，比如，在处理用户订单提交时，为了避免重复提交，可以处理完post 请求后redirect 到一个get 请求，这个get 请求可以用来显示订单详情之类的信息。这样做虽然可以规避用户刷新重新提交表单的问题，但是在这个页面上要显示订单的信息，那这些数据从哪里去获取呢，因为redirect 重定向是没有传递参数这一功能的，如果不想把参数写进url(其实也不推荐这么做，url 有长度限制不说，把参数都直接暴露，感觉也不安全)，那么就可以通过flashMap 来传递。只需要在redirect 之前，将要传递的数据写入request （可以通过ServletRequestAttributes.getRequest() 获得）的属性OUTPUT_FLASH_MAP_ATTRIBUTE 中，这样在redirect 之后的handler 中Spring 就会自动将其设置到Model 中，在显示订单信息的页面上，就可以直接从Model 中取得数据了。而FlashMapManager 就是用来管理FlashMap 的。

Spring MVC 源码分析

根据上面分析的Spring MVC 工作机制，从三个部分来分析Spring MVC 的源代码。
其一，ApplicationContext 初始化时用Map 保存所有url 和Controller 类的对应关系；
其二，根据请求url 找到对应的Controller，并从Controller 中找到处理请求的方法;
其三，Request 参数绑定到方法的形参，执行方法处理请求，并返回结果视图。

初始化阶段

我们首先找到DispatcherServlet 这个类，必然是寻找init()方法。然后，我们发现其init方法其实在父类HttpServletBean 中，其源码如下：

    public final void init() throws ServletException {
        if (logger.isDebugEnabled()) {
            logger.debug("Initializing servlet '" + getServletName() + "'");
        }
        // Set bean properties from init parameters.
        PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(),
                this.requiredProperties);
        if (!pvs.isEmpty()) {
            try {
                //定位资源
                BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
                //加载配置信息
                ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
                bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader,
                        getEnvironment()));
                initBeanWrapper(bw);
                bw.setPropertyValues(pvs, true);
            } catch (BeansException ex) {
                if (logger.isErrorEnabled()) {
                    logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
                }
                throw ex;
            }
        }
        // Let subclasses do whatever initialization they like.
        initServletBean();
        if (logger.isDebugEnabled()) {
            logger.debug("Servlet '" + getServletName() + "' configured successfully");
        }
    }

我们看到在这段代码中，又调用了一个重要的initServletBean() 方法。进入initServletBean()方法看到以下源码：

    protected final void initServletBean() throws ServletException {
        getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
        if (this.logger.isInfoEnabled()) {
            this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
        }
        long startTime = System.currentTimeMillis();
        try {
            this.webApplicationContext = initWebApplicationContext();
            initFrameworkServlet();
        } catch (ServletException ex) {
            this.logger.error("Context initialization failed", ex);
            throw ex;
        } catch (RuntimeException ex) {
            this.logger.error("Context initialization failed", ex);
            throw ex;
        }
        if (this.logger.isInfoEnabled()) {
            long elapsedTime = System.currentTimeMillis() - startTime;
            this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
                    elapsedTime + " ms");
        }
    }

这段代码中最主要的逻辑就是初始化IOC 容器，最终会调用refresh()方法，前面的章节中对IOC 容器的初始化细节我们已经详细掌握，在此我们不再赘述。我们看到上面的代码中，IOC 容器初始化之后，最后有调用了onRefresh()方法。这个方法最终是在DisptcherServlet 中实现，来看源码：

    @Override
    protected void onRefresh(ApplicationContext context) {
        initStrategies(context);
    }

    /**
     * Initialize the strategy objects that this servlet uses.
     * <p>May be overridden in subclasses in order to initialize further strategy objects.
     */
    //初始化策略
    protected void initStrategies(ApplicationContext context) {
        //多文件上传的组件
        initMultipartResolver(context);
        //初始化本地语言环境
        initLocaleResolver(context);
        //初始化模板处理器
        initThemeResolver(context);
        //handlerMapping
        initHandlerMappings(context);
        //初始化参数适配器
        initHandlerAdapters(context);
        //初始化异常拦截器
        initHandlerExceptionResolvers(context);
        //初始化视图预处理器
        initRequestToViewNameTranslator(context);
        //初始化视图转换器
        initViewResolvers(context);
        //FlashMap 管理器
        initFlashMapManager(context);
    }

九、Spring MVC运行时序图