SpringMvc 的 9 大组件

2021 年 05 月 27 日
6 min read

引子

在做盲盒的时候，用到了上传，而 springmvc 自带的实现 org.springframework.web.multipart.support.StandardServletMultipartResolver 无法满足上传需求，顾需要更换实现。

已知 springmvc 中的 org.springframework.web.multipart.MultipartResolver 接口有两种实现

org.springframework.web.multipart.support.StandardServletMultipartResolver
1. 使用 servlet3.0 进行的标准实现方式
org.springframework.web.multipart.commons.CommonsMultipartResolver
1. 使用 Apache 的 commons-fileupload 依赖进行实现

简单分析下上传流程：

先上示例代码

 protected HttpServletRequest checkMultipart(HttpServletRequest request) throws MultipartException {
   if (this.multipartResolver != null && this.multipartResolver.isMultipart(request)) {
       // ......
   }
   // If not returned before: return original request.
   return request;
 }

DispatcherServlet 接受到请求，首先会调用 checkMultipart 查看是否为文件上传类型的 request
如果 配置了解析器 且是一个有效的文件上传请求，则会去解析数据，否则直接返回 request。
如此，在系统中就必须配置一个 multipartResolver

那 spring 是如何获取对应的 MultipartResolver 接口实现，配置为自己的对应的 bean 呢？

SpringMvc 中那些固定名称的 Bean

在盲盒项目中，明明配置了一个基于 MultipartResolver 的实现，但是却没有生效，是为什么？

    @Bean
    public CommonsMultipartResolver commonsMultipartResolver() {
        CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
        commonsMultipartResolver.setDefaultEncoding("UTF-8");
        commonsMultipartResolver.setMaxUploadSize(1024000000);
        return commonsMultipartResolver;
    }

经过跟踪排查发现，是没有指定 bean name，只需要将注解改为 @Bean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) 即可生效

由此可以看见，在 DispatchServlet 中，定义了一些固定 Bean Name 的 bean，也就是说这些 bean 在同一个 springmvc 应用中唯一，且如果想让其生效，bean name 须指定为 DispatchServlet 中指定的 bean name。这些 bean 称之为 strategy objects。

MULTIPART_RESOLVER_BEAN_NAME = “multipartResolver”
LOCALE_RESOLVER_BEAN_NAME = “localeResolver”
THEME_RESOLVER_BEAN_NAME = “themeResolver”
HANDLER_MAPPING_BEAN_NAME = “handlerMapping”
HANDLER_ADAPTER_BEAN_NAME = “handlerAdapter”
HANDLER_EXCEPTION_RESOLVER_BEAN_NAME = “handlerExceptionResolver”
REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME = “viewNameTranslator”
VIEW_RESOLVER_BEAN_NAME = “viewResolver”
FLASH_MAP_MANAGER_BEAN_NAME = “flashMapManager”

依次来看一下

MULTIPART_RESOLVER_BEAN_NAME = “multipartResolver”

接口: org.springframework.web.multipart.MultipartResolver
实现:
1. org.springframework.web.multipart.support.StandardServletMultipartResolver
2. org.springframework.web.multipart.commons.CommonsMultipartResolver
默认: 无
功能: 主要负责文件上传解析用于处理上传请求。处理方法是将普通的request包装成MultipartHttpServletRequest，后者可以直接调用getFile方法获取File，如果上传多个文件，还可以调用getFileMap得到FileName->File结构的Map。此组件中一共有三个方法，作用分别是判断是不是上传请求，将request包装成MultipartHttpServletRequest、处理完后清理上传过程中产生的临时资源。

LOCALE_RESOLVER_BEAN_NAME = “localeResolver”

接口: org.springframework.web.servlet.LocaleResolver
实现:
1. org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
2. org.springframework.web.servlet.i18n.CookieLocaleResolver
3. org.springframework.web.servlet.i18n.FixedLocaleResolver
4. org.springframework.web.servlet.i18n.SessionLocaleResolver
默认: 有
功能: 本地化 i18n 资源文件处理解析视图需要两个参数：一是视图名，另一个是Locale。视图名是处理器返回的，Locale是从哪里来的？这就是LocaleResolver要做的事情。LocaleResolver用于从request解析出Locale，Locale就是zh-cn之类，表示一个区域，有了这个就可以对不同区域的用户显示不同的结果。SpringMVC主要有两个地方用到了Locale：一是ViewResolver视图解析的时候；二是用到国际化资源或者主题的时候。

THEME_RESOLVER_BEAN_NAME = “themeResolver”

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

HANDLER_MAPPING_BEAN_NAME = “handlerMapping”

接口: org.springframework.web.servlet.HandlerMapping
实现:
1. org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping
2. org.springframework.web.servlet.handler.PathPatternMatchableHandlerMapping
3. org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping
4. org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping
5. org.springframework.web.servlet.function.support.RouterFunctionMapping
6. org.springframework.web.servlet.handler.SimpleUrlHandlerMapping
默认: 有
扩展：查找系统中所有的接口实现，并排序加入集合；否则按照名称查找，作为唯一的实现；如果还未找到，取默认
功能: 负责将一个请求的 Uri，按照 handler mapping 进行逐层处理，从而抉择出唯一的 mapping，进行逻辑处理。是用来查找Handler的。在SpringMVC中会有很多请求，每个请求都需要一个Handler处理，具体接收到一个请求之后使用哪个Handler进行处理呢？这就是HandlerMapping需要做的事。

HANDLER_ADAPTER_BEAN_NAME = “handlerAdapter”

接口: org.springframework.web.servlet.HandlerAdapter
实现:
1. org.springframework.web.servlet.function.support.HandlerFunctionAdapter
2. org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
3. org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
4. org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter
5. org.springframework.web.servlet.handler.SimpleServletHandlerAdapter
默认: 有
扩展：查找系统中所有的接口实现，并排序加入集合；否则按照名称查找，作为唯一的实现；如果还未找到，取默认
功能: 通过前面获取到的Handler，执行处理逻辑。整个处理过程可以分为三步：解析参数、执行请求、处理返回值。从名字上看，它就是一个适配器。因为SpringMVC中的Handler可以是任意的形式，只要能处理请求就ok，但是Servlet需要的处理方法的结构却是固定的，都是以request和response为参数的方法。如何让固定的Servlet处理方法调用灵活的Handler来进行处理呢？这就是HandlerAdapter要做的事情。 Handler是用来干活的工具；HandlerMapping用于根据需要干的活找到相应的工具；HandlerAdapter是使用工具干活的人。

HANDLER_EXCEPTION_RESOLVER_BEAN_NAME = “handlerExceptionResolver”

接口: org.springframework.web.servlet.HandlerExceptionResolver
实现:
1. org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver
2. org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver
3. org.springframework.web.servlet.handler.HandlerExceptionResolverComposite
4. org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver
5. org.springframework.web.servlet.handler.SimpleMappingExceptionResolver
默认: 有
扩展：查找系统中所有的接口实现，并排序加入集合；否则按照名称查找，作为唯一的实现；如果还未找到，取默认
功能: mvc 全局异常处理其它组件都是用来干活的。在干活的过程中难免会出现问题，出问题后怎么办呢？这就需要有一个专门的角色对异常情况进行处理，在SpringMVC中就是HandlerExceptionResolver。具体来说，此组件的作用是根据异常设置ModelAndView，之后再交给render方法进行渲染。

REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME = “viewNameTranslator”

接口: org.springframework.web.servlet.RequestToViewNameTranslator
实现:
1. org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator
默认: 有
功能: 从 request 中获取 viewname 的解析器 ViewName是根据ViewName查找View，但有的Handler处理完后并没有设置View也没有设置ViewName，这时就需要从request获取ViewName了，如何从request中获取ViewName就是RequestToViewNameTranslator要做的事情了。RequestToViewNameTranslator在Spring MVC容器里只可以配置一个，所以所有request到ViewName的转换规则都要在一个Translator里面全部实现。

VIEW_RESOLVER_BEAN_NAME = “viewResolver”

接口: org.springframework.web.servlet.ViewResolver
实现:
1. org.springframework.web.servlet.view.BeanNameViewResolver
2. ……
默认: 有
扩展：查找系统中所有的接口实现，并排序加入集合；否则按照名称查找，作为唯一的实现；如果还未找到，取默认
功能: mvc 视图解析器 ViewResolver用来将String类型的视图名和Locale解析为View类型的视图。View是用来渲染页面的，也就是将程序返回的参数填入模板里，生成html（也可能是其它类型）文件。这里就有两个关键问题：使用哪个模板？用什么技术（规则）填入参数？这其实是ViewResolver主要要做的工作，ViewResolver需要找到渲染所用的模板和所用的技术（也就是视图的类型）进行渲染，具体的渲染过程则交由不同的视图自己完成。

FLASH_MAP_MANAGER_BEAN_NAME = “flashMapManager”

接口: org.springframework.web.servlet.FlashMapManager
实现:
1. org.springframework.web.servlet.support.SessionFlashMapManager
默认: 有
功能: redirect 的时候，进行数据保存和传递

默认实现

默认实现参考 spring-webmvc-5.3.6.jar!/org/springframework/web/servlet/DispatcherServlet.properties

该文件可以覆盖，spring 5.x.x 内置文件内容如下：

# Default implementation classes for DispatcherServlet's strategy interfaces.
# Used as fallback when no matching beans are found in the DispatcherServlet context.
# Not meant to be customized by application developers.

org.springframework.web.servlet.LocaleResolver=org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver

org.springframework.web.servlet.ThemeResolver=org.springframework.web.servlet.theme.FixedThemeResolver

org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,\
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping,\
org.springframework.web.servlet.function.support.RouterFunctionMapping

org.springframework.web.servlet.HandlerAdapter=org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter,\
org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter,\
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,\
org.springframework.web.servlet.function.support.HandlerFunctionAdapter


org.springframework.web.servlet.HandlerExceptionResolver=org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver,\
org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver,\
org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver

org.springframework.web.servlet.RequestToViewNameTranslator=org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResourceViewResolver

org.springframework.web.servlet.FlashMapManager=org.springframework.web.servlet.support.SessionFlashMapManager

总结一下

为什么过去就没有犯错呢？主要是过去代码中，spring 配置基本上使用 xml 形式，然后我们做的基本上都是 copy/paste，当换了一种开发方式，当不了解原理的情况下，就踩到了坑。

所以在用到别人的框架的时候，要尽量多思考为什么这么做，还有就是注释的必要性。

扩展一下

看一下 xml 形式的配置

    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <property name="maxUploadSize" value="10485760" />
    </bean>

描述文件中， id 在全局是唯一的，如果有重复，在解析过程中就会报错。

bean 描述文件中，还有一个属性叫做 name，可以使用 , 分割创建多个别名，当有重复别名会被覆盖

如果 id, name 都不指定，则使用 className 作为 bean name，如果定义了多个同类型的 bean，则会被命名为：

    com.jd.xxx.Bean
    com.jd.xxx.Bean#1
    com.jd.xxx.Bean#2
    ...