SpringMVC中的九大组件的理解和源码

缺乏、安全感 2022-05-08 00:24 255阅读 0赞

SpringMVC中的Servlet一共有三个层次，分别是HttpServletBean、FrameworkServlet和 DispatcherServlet。

HttpServletBean直接继承自java的HttpServlet，其作用是将Servlet中配置的参数设置到相应的属性；

FrameworkServlet初始化了WebApplicationContext；

DispatcherServlet初始化了自身的9个组件。

protected void onRefresh(ApplicationContext context) {
        this.initStrategies(context);
    }
    
    protected void initStrategies(ApplicationContext context) {
        this.initMultipartResolver(context);
        this.initLocaleResolver(context);
        this.initThemeResolver(context);
        this.initHandlerMappings(context);
        this.initHandlerAdapters(context);
        this.initHandlerExceptionResolvers(context);
        this.initRequestToViewNameTranslator(context);
        this.initViewResolvers(context);
        this.initFlashMapManager(context);
    }

上面代码中的 `onRefresh`方法就是 `DispatcherServlet`的入口方法。在 `onRefresh`中又通过调用 `initStrategies`方法来将各个组件的初始化逻辑进行整合。

在 `initStrategies`方法中又通过调用组件各自的初始化方法来完成具体的初始化工作。从这个地方其实就可以清楚的看出SpringMVC中的9个组件名称了。

【1. HandlerMapping】

是用来查找Handler的。在SpringMVC中会有很多请求，每个请求都需要一个Handler处理，具体接收到一个请求之后使用哪个Handler进行处理呢？这就是HandlerMapping需要做的事。对于 `HandlerMapping`来说，其作用就是根据 `request`找到相应的处理器 `Handler`和 `Intecepter`拦截器

【2. HandlerAdapter】

从名字上看，它就是一个适配器。因为SpringMVC中的Handler可以是任意的形式，只要能处理请求就ok，但是Servlet需要的处理方法的结构却是固定的，都是以request和response为参数的方法。如何让固定的Servlet处理方法调用灵活的Handler来进行处理呢？这就是HandlerAdapter要做的事情。

小结：Handler是用来干活的工具；HandlerMapping用于根据需要干的活找到相应的工具；HandlerAdapter是使用工具干活的人。

public interface HandlerAdapter {
        boolean supports(Object var1);
        ModelAndView handle(HttpServletRequest var1, HttpServletResponse var2, Object var3) throws Exception;
        long getLastModified(HttpServletRequest var1, Object var2);
    }

是不是一目了然了，在 `HandlerAdapter`接口中提供了 `handle`这样一个方法，参数中Object handler第三个参数其实就是一个处理器，那我们就知道了， `handle`方法就是使用 `handler`来处理逻辑的。处理之后返回一个 `ModelAndView`

【3. HandlerExceptionResolver】

其它组件都是用来干活的。在干活的过程中难免会出现问题，出问题后怎么办呢？这就需要有一个专门的角色对异常情况进行处理，在SpringMVC中就是HandlerExceptionResolver。具体来说，此组件的作用是根据异常设置ModelAndView，之后再交给render方法进行渲染。

public interface HandlerExceptionResolver {
        ModelAndView resolveException(HttpServletRequest var1, HttpServletResponse var2, Object var3, Exception var4);
    }

在 `HandlerExceptionResolver`中也只有一个方法，这个方法就是从异常中解析出 `ModelAndView`

【4. ViewResolver】

ViewResolver用来将String类型的视图名和Locale解析为View类型的视图。View是用来渲染页面的，也就是将程序返回的参数填入模板里，生成html（也可能是其它类型）文件。这里就有两个关键问题：使用哪个模板？用什么技术（规则）填入参数？这其实是ViewResolver主要要做的工作，ViewResolver需要找到渲染所用的模板和所用的技术（也就是视图的类型）进行渲染，具体的渲染过程则交由不同的视图自己完成。

public interface ViewResolver {
        View resolveViewName(String viewName, Locale local) throws Exception;
    }

`View`实际上是用来渲染页面的，也就是说将程序返回的结果填入到具体的模板里面，生成具体的视图文件，比如：jsp，ftl，html等。

但是这里又会牵扯出两个问题：

*  用什么模板？
 *  参数怎么填入？

当然，这两个问题也就是本小节说的 `ViewResolver`  
需要解决的问题。大体分为两种：

### 针对单一视图类型的解析器 ###

*  InternalResourceViewResolver
 *  FreeMarkerViewResolver

上面两种是用的最多的两种， `InternalResourceViewResolver`用来解析jsp，而 `FreeMarkerViewResolver`则是针对FreeMarker。

### 针对同时解析多种类型视图的解析器 ###

*  BeanNameViewResolver
    
    需要同时使用视图名和对应的local来解析视图。它需要将每一个视图名和对应的视图类型配置到相应的properties文件中。
 *  XmlViewResolver
    
    XmlViewResolver和BeanNameViewResolver有点差不多，BeanNameViewResolver使用的是xml格式的配置文件。
 *  ResourceBundleViewResolver
    
    这个其实就是根据viewName从Spring容器中查找bean，再根据这个bean来找到对应的视图。

【5. RequestToViewNameTranslator】

ViewName是根据ViewName查找View，但有的Handler处理完后并没有设置View也没有设置ViewName，这时就需要从request获取ViewName了，如何从request中获取ViewName就是RequestToViewNameTranslator要做的事情了。RequestToViewNameTranslator在Spring MVC容器里只可以配置一个，所以所有request到ViewName的转换规则都要在一个Translator里面全部实现。

public interface RequestToViewNameTranslator {
        String getViewName(HttpServletRequest request) throws Exception;
    }

`RequestToViewNameTranslator`  
只有一个默认的实现类 `DefaultRequestToViewNameTranslator`。

在 `DefaultRequestToViewNameTranslator`  
具体实现了getViewName(HttpServletRequest request)方法：

public String getViewName(HttpServletRequest request) {
        String lookupPath = this.urlPathHelper.getLookupPathForRequest(request);
        return this.prefix + this.transformPath(lookupPath) + this.suffix;
    }

主要是委派给urlPathHelper帮助类得到请求的后缀名称，比如通过 请求路径比如/gl[mapper][]/login.do转换得到/login.do ；

【6. LocaleResolver】

解析视图需要两个参数：一是视图名，另一个是Locale。视图名是处理器返回的，Locale是从哪里来的？这就是LocaleResolver要做的事情。LocaleResolver用于从request解析出Locale，Locale就是zh-cn之类，表示一个区域，有了这个就可以对不同区域的用户显示不同的结果。SpringMVC主要有两个地方用到了Locale：一是ViewResolver视图解析的时候；二是用到国际化资源或者主题的时候。

public interface LocaleResolver {
        Locale resolveLocale(HttpServletRequest request);
    
        void setLocale(HttpServletRequest request, HttpServletResponse response, Locale local);
    }

【7. ThemeResolver】

用于解析主题。SpringMVC中一个主题对应一个properties文件，里面存放着跟当前主题相关的所有资源、如图片、css样式等。SpringMVC的主题也支持国际化，同一个主题不同区域也可以显示不同的风格。SpringMVC中跟主题相关的类有 ThemeResolver、ThemeSource和Theme。主题是通过一系列资源来具体体现的，要得到一个主题的资源，首先要得到资源的名称，这是ThemeResolver的工作。然后通过主题名称找到对应的主题（可以理解为一个配置）文件，这是ThemeSource的工作。最后从主题中获取资源就可以了。

public interface ThemeResolver {
        String resolveThemeName(HttpServletRequest request);
    
        void setThemeName(HttpServletRequest request, HttpServletResponse response, String themeName);
    }

【8. MultipartResolver】

用于处理上传请求。处理方法是将普通的request包装成MultipartHttpServletRequest，后者可以直接调用getFile方法获取File，如果上传多个文件，还可以调用getFileMap得到FileName->File结构的Map。此组件中一共有三个方法，作用分别是判断是不是上传请求，将request包装成MultipartHttpServletRequest、处理完后清理上传过程中产生的临时资源。

【9. FlashMapManager】

用来管理FlashMap的，FlashMap主要用在redirect中传递参数。

`retrieveAndUpdate`这个方法是用来恢复参数的，对于恢复过的和超时的参数将都会被[删除][Link 1]掉。

`saveOutputFlashMap`这个方法是用来保存参数的。

`FlashMapManager`的默认实现机制中参数的存储是放在session中的。我之前在一个项目中就有遇到过这种情况，对于一些我们不想暴露在url中的参数，在进行请求转发时，可以使用@RedirectAttributes将参数保存，然后在下一个处理器中获取到。

public interface FlashMapManager {
        FlashMap retrieveAndUpdate(HttpServletRequest request, HttpServletResponse response);
    
        void saveOutputFlashMap(FlashMap flashMap, HttpServletRequest request, HttpServletResponse response);
    }

[mapper]: http://www.liuhaihua.cn/archives/tag/mapper
[Link 1]: http://www.liuhaihua.cn/archives/tag/%E5%88%A0%E9%99%A4