SpringBoot中的WebMvcConfigurer学习

一、自我介绍

WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xnl配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。基于java-based方式的spring mvc配置，需要创建一个配置类并实现WebMvcConfigurer接口；

二、特殊要点

在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器，消息转换器等。

在Spring Boot 2.0后该类被标记为@Deprecated弃用了。

官方推荐两种方式：方式一、直接实现WebMvcConfigurer。方式二、直接继承WebMvcConfiguretionSupport类，推荐方式一。

因为方式二可能存在导致自动配置失效，在Spring Boot的自定义配置类继承WebMvcConfigurationSupport后，发现自动配置的静态资源路径（classpath:/META/resources/，classpath:/resources/，classpath:/static/，classpath:/public/）不生效。

首先看一下自动配置类的定义：

这是因为在Spring Boot的web自动配置类WebMvcAutoConfiguration上有条注解 @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，这个注解的意思是在项目类路径中缺少WebMvcConfigurationSupport类型的bean时该自动配置类才会生效，所以继承WebMvcConfigurationSupport后需要自己重写相应的方法。

如果想要使用自动配置生效，又要按自己的需要重写某些方法，比如增加viewController，则可以自己的配置类可以继承WenMvcConfigurerAdapter这个类，不过在Spring 5.0版本后这个类就被丢弃了，虽然可以用，但是毕竟过时了。

说了一堆，其实就是推荐直接使用方式一的方式。

三、打开我看看有啥

public interface WebMvcConfigurer {

    void configurePathMatch(PathMatchConfigurer var1);
 
    /* 配置内容裁决的一些选项*/
    void configureContentNegotiation(ContentNegotiationConfigurer var1);
 
    void configureAsyncSupport(AsyncSupportConfigurer var1);

    /* 默认静态资源处理器 */ 
    void configureDefaultServletHandling(DefaultServletHandlerConfigurer var1);
 
    void addFormatters(FormatterRegistry var1);
 
    /* 拦截器配置 */
    void addInterceptors(InterceptorRegistry var1);
 
    /* 静态资源处理 */
    void addResourceHandlers(ResourceHandlerRegistry var1);
 
    /* 解决跨域问题 */
    void addCorsMappings(CorsRegistry var1);
     
    /* 视图跳转控制器 */
    void addViewControllers(ViewControllerRegistry var1);
    
    /* 这里配置视图解析器 */
    void configureViewResolvers(ViewResolverRegistry var1);
 
    void addArgumentResolvers(List var1);
 
    void addReturnValueHandlers(List var1);
 
    void configureMessageConverters(List> var1);
 
    void extendMessageConverters(List> var1);
 
    void configureHandlerExceptionResolvers(List var1);
 
    void extendHandlerExceptionResolvers(List var1);
 
    Validator getValidator();
 
    MessageCodesResolver getMessageCodesResolver();
}

比较常用的方法：

1、addInterceptors：拦截器

addInterceptor：需要一个实现HandlerInterceptor接口的拦截器实例

addPathPatterns：用于设置拦截器的过滤路径规则，addPathPatterns("/**")对所有请求都拦截

excludePathPatterns：用于设置不需要拦截的过滤规则

拦截器主要用途：进行用户登陆状态的拦截，日志的拦截等

2、addViewControllers：页面跳转

之前写SpringMVC的时候，如果需要访问一个页面，必须要写Controller类，然后再写一个方法跳转到页面，感觉好麻烦，其实重写WebMvcConfigurer中的addViewControllers方法即可达到效果了

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/toLogin").setViewName("login");
    }

值得说明的是，在这里重写addViewController方法，并不会覆盖WebMvcAutoConfiguration（Spring Boot自动配置）中的addViewControllers（在此方法中，Spring Boot将"/"映射至index.html），这也就意味着自己的配置和Spring Boot的自动配置同事有效，这也是我们推荐田间自己的MVC配置的方式。

3、addResourceHandlers：静态资源

比如，我们想自定义静态资源映射目录的话，只需重写addResourceHandlers方法即可

注意：如果继承WebMvcConfigurationSupport类实现配置时必须要重写该方法

addResourceHandler：指的是对外暴露的访问路径

addResourceLocations：指的是内部文件放置的目录

@Configuration
public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {
    /**
     * 配置静态访问资源
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/my/**").addResourceLocations("classpath:/my/");
    }
}

4、configureDefaultServletHandling：默认静态资源处理器

@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
        configurer.enable("defaultServletName");
}

此时会注册一个默认的Handler：DefaultServerHttpRequestHandler，这个Handler也会用来处理静态文件的，它会尝试映射/。当DispatcherServlet映射/时，并且没有找到合适的Handler来处理请求时，就会交给DefaultServletHttpRequestHandler来处理。注意：这里的静态资源是放置在web根目录下，而非WEB_INF下。

举例：在webroot目录下有一个图片pdm.jpg，我们知道Servelt规范中web根目录webroot下的文件可以直接访问的，但是由于DispatcherServlet配置了映射路径是：/，它几乎把所有的请求都拦截了，从而导致pdm.jpg访问不到，这时注册一个DefaultServletHttpRequestHandler就可以解决这个问题，其实可以理解为DispatchServlet破坏了Servler的一个特性（就是根目录下的文件可以直接访问）DefaultServletHttpRequestHandler是帮助回归这个特性的。

5、configureViewResolvers：视图解析器

这个方法是用来配置视图解析器的，该方法的参数ViewResolverRegistry是一个注册器，用来注册你想自定义的驶入解析器等，ViewResolverRegistry常用的几个方法：

１)．enableContentNegotiation()

/** 启用内容裁决视图解析器*/
public void enableContentNegotiation(View... defaultViews) {
    initContentNegotiatingViewResolver(defaultViews);
}

该方法会创建一个内容裁决解析器ContentNegotiatingViewResolver ，该解析器不进行具体视图的解析，而是管理你注册的所有视图解析器，所有的视图会先经过它进行解析，然后由它来决定具体使用哪个解析器进行解析。具体的映射规则是根据请求的media types来决定的。
        2). 　UrlBasedViewResolverRegistration()

 public UrlBasedViewResolverRegistration jsp(String prefix, String suffix) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix(prefix);
        resolver.setSuffix(suffix);
        this.viewResolvers.add(resolver);
        return new UrlBasedViewResolverRegistration(resolver);
    }

该方法会注册一个内部资源视图解析器InternalResourceViewResolver 显然访问的所有jsp都是它进行解析的。该方法参数用来指定路径的前缀和文件后缀，如：　　

registry.jsp("/WEB-INF/jsp/", ".jsp");
　对于以上配置，假如返回的视图名称是example，它会返回/WEB-INF/jsp/example.jsp给前端，找不到则报404。　　

        3). 　beanName()

public void beanName() {
        BeanNameViewResolver resolver = new BeanNameViewResolver();
        this.viewResolvers.add(resolver);
    }

该方法会注册一个BeanNameViewResolver 视图解析器，这个解析器是干嘛的呢？它主要是将视图名称解析成对应的bean。什么意思呢？假如返回的视图名称是example，它会到spring容器中找有没有一个叫example的bean，并且这个bean是View.class类型的？如果有，返回这个bean。　　

        4). 　viewResolver()

 public void viewResolver(ViewResolver viewResolver) {
        if (viewResolver instanceof ContentNegotiatingViewResolver) {
            throw new BeanInitializationException(
                    "addViewResolver cannot be used to configure a ContentNegotiatingViewResolver. Please use the method enableContentNegotiation instead.");
        }
        this.viewResolvers.add(viewResolver);
    }

这个方法想必看名字就知道了，它就是用来注册各种各样的视图解析器的，包括自己定义的。

6、configureContentNegotiation：配置内容裁决的一些参数

上面我们讲了configureViewResolvers 方法，假如在该方法中我们启用了内容裁决解析器，那么configureContentNegotiation(ContentNegotiationConfigurer configurer) 这个方法是专门用来配置内容裁决的一些参数的。这个比较简单，我们直接通过一个例子看：

 public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
       /* 是否通过请求Url的扩展名来决定media type */
        configurer.favorPathExtension(true)  
                 /* 不检查Accept请求头 */
                .ignoreAcceptHeader(true)
                .parameterName("mediaType")
                 /* 设置默认的media yype */
                .defaultContentType(MediaType.TEXT_HTML)
                 /* 请求以.html结尾的会被当成MediaType.TEXT_HTML*/
                .mediaType("html", MediaType.TEXT_HTML)
                /* 请求以.json结尾的会被当成MediaType.APPLICATION_JSON*/
                .mediaType("json", MediaType.APPLICATION_JSON);
    }

7、addCorsMappings：跨域

@Override
public void addCorsMappings(CorsRegistry registry) {
    super.addCorsMappings(registry);
    registry.addMapping("/cors/**")
            .allowedHeaders("*")
            .allowedMethods("POST","GET")
            .allowedOrigins("*");
}

8、configureMessageConverters：信息转换器

 
/**
* 消息内容转换配置
 * 配置fastJson返回json转换
 * @param converters
 */
@Override
public void configureMessageConverters(List> converters) {
    //调用父类的配置
    super.configureMessageConverters(converters);
    //创建fastJson消息转换器
    FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
    //创建配置类
    FastJsonConfig fastJsonConfig = new FastJsonConfig();
    //修改配置返回内容的过滤
    fastJsonConfig.setSerializerFeatures(
            SerializerFeature.DisableCircularReferenceDetect,
            SerializerFeature.WriteMapNullValue,
            SerializerFeature.WriteNullStringAsEmpty
    );
    fastConverter.setFastJsonConfig(fastJsonConfig);
    //将fastjson添加到视图消息转换器列表内
    converters.add(fastConverter);
 
}

9、addArgumentResolvers：参数解析器