4.2.1 Spring相关 - SpringBoot---WebMvcConfigurer详解 - 《java》

1 简介
2 接口、常用方法

1 简介

WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。基于java-based方式的spring mvc配置，需要创建一个配置类并实现WebMvcConfigurer 接口；
在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器，消息转换器等。SpringBoot 2.0 后，该类被标记为@Deprecated（弃用）。官方推荐直接实现WebMvcConfigurer或者直接继承WebMvcConfigurationSupport，方式一实现WebMvcConfigurer接口（推荐），方式二继承WebMvcConfigurationSupport类，具体实现可看这篇文章。https://blog.csdn.net/fmwind/article/details/82832758
推荐方式一！

2 接口、常用方法

接口方法就不截图了；看一下常用的：

 /* 2.1 拦截器配置 */
void addInterceptors(InterceptorRegistry var1);
/* 2.2 视图跳转控制器 */
void addViewControllers(ViewControllerRegistry registry);
/**
    2.3  *静态资源处理
**/
void addResourceHandlers(ResourceHandlerRegistry registry);
/* 2.4  默认静态资源处理器 */
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);
/**
   2.5  这里配置视图解析器  (这个自己基本用不到了，前后分离了)
 **/
void configureViewResolvers(ViewResolverRegistry registry);
/* 2.6 配置内容裁决的一些选项*/  （这个可以进一步自己搞一下）
void configureContentNegotiation(ContentNegotiationConfigurer configurer);
/** 2.7 解决跨域问题 **/
public void addCorsMappings(CorsRegistry registry) ;
/** 2.8 信息转换器*/  （）
void configureMessageConverters(List<HttpMessageConverter<?>> converters)；

2.1. 拦截器 addInterceptors

addInterceptor：需要一个实现HandlerInterceptor接口的拦截器实例
addPathPatterns：用于设置拦截器的过滤路径规则；addPathPatterns(“/**”)对所有请求都拦截
excludePathPatterns：用于设置不需要拦截的过滤规则

拦截器主要用途：进行用户登录状态的拦截，日志的拦截等 ```java //注册拦截器配置 @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyInterceptor()) //注册一个自定一的拦截器

  .addPathPatterns("/**")     // 拦截所有请求
  .excludePathPatterns(  // 添加不拦截的路径    这里也可以在【preHandler报错那里加上 instanceof 关键字进行判断。】
  "/login",
  "/",
  "/user/login"
  /*
  springboot2之后开始拦截静态资源了， 如果我们进行了 mvc的 addResourceHandlers()配置，那么如果访问这些静态资源的时候， 本拦截器方法中的handler形参 其实是一个ResourceHttpRequestHandler，
          如果强转成HandlerMethod 是要报错的(就会抛出【java.lang.ClassCastException: org.springframework.web.servlet.resource.ResourceHttpRequestHandler cannot be cast to org.springframework.web.method.HandlerMethod】错误)；
          解决办法有两个；
          1 在拦截器那里排除静态资源的请求路径，也就是静态资源的访问不会被拦截到，也就走不到拦截器方法，也就没有强转什么事情了  （一劳永逸，推荐）
          2 拦截器配置不做调整，但是在拦截器方法上添加一个代码，判断一下handler instanceof 什么类型的；如果是heanlderMethod就继续执行，
              如果是ResourceHttpRequestHandler类型 就跳过（return true），跳过拦截器的方法；
          方式2有个缺点：如果没添加一个拦截器的话，都得想着添加这个东西（不是很推荐）
  */
  ,"/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**"   // 这里是排除swagger的拦截
  ,"/doc.html/**","/swagger-ui.html/**","/docs.html/**","/document.html/**"   //这里是排除 swagger 别的ui的拦截
  ,"/**/*.css","/**/*.js"  //排除静态资源

);

}

<a name="LrIU7"></a>
### 2.2. 页面跳转    addViewControllers
以前写SpringMVC的时候，如果需要访问一个页面，必须要写Controller类，然后再写一个方法跳转到页面，感觉好麻烦，其实重写WebMvcConfigurer中的addViewControllers方法即可达到效果了
```java
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/toLogin").setViewName("login");
    }

值的指出的是，在这里重写addViewControllers方法，并不会覆盖WebMvcAutoConfiguration（Springboot自动配置）中的addViewControllers（在此方法(springboot自动配置)中，Spring Boot将“/”映射至index.html），这也就意味着自己的配置和Spring Boot的自动配置同时有效，这也是我们推荐添加自己的MVC配置的方式。

2.3. 静态资源 addResourceHandlers

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

注：如果继承WebMvcConfigurationSupport类实现配置时必须要重写该方法，具体见其它文章

@Configuration
public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {
    /**
     * 配置静态访问资源
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/my/**").addResourceLocations("classpath:/my/");
        //下面是将swagger的静态资源配置   不配置的话，请求不到
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("docs.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("document.html").addResourceLocations("classpath:/META-INF/resources/");

    }
}

2.4. 默认静态资源处理器 configureDefaultServletHandling

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

此时会注册一个默认的Handler：DefaultServletHttpRequestHandler，这个Handler也是用来处理静态文件的，它会尝试映射/。当DispatcherServelt映射/时（/ 和/ 是有区别的），并且没有找到合适的Handler来处理请求时，就会交给DefaultServletHttpRequestHandler 来处理。注意：这里的静态资源是放置在web根目录下，而非WEB-INF 下。
可能这里的描述有点不好懂（我自己也这么觉得），所以简单举个例子，例如：在webroot目录下有一个图片：1.png 我们知道Servelt规范中web根目录（webroot）下的文件可以直接访问的，但是由于DispatcherServlet配置了映射路径是：/ ，它几乎把所有的请求都拦截了，从而导致1.png 访问不到，这时注册一个DefaultServletHttpRequestHandler 就可以解决这个问题。其实可以理解为DispatcherServlet破坏了Servlet的一个特性（根目录下的文件可以直接访问），DefaultServletHttpRequestHandler是帮助回归这个特性的。

2.5 试图解析器 configureViewResolvers

前后分离的项目这个就是非必要的了

这个方法是用来配置视图解析器的，该方法的参数ViewResolverRegistry 是一个注册器，用来注册你想自定义的视图解析器等。ViewResolverRegistry 常用的几个方法：https://blog.csdn.net/fmwind/article/details/81235401

/**
 * 配置请求视图映射
 * @return
 */
@Bean
public InternalResourceViewResolver resourceViewResolver()
{
    InternalResourceViewResolver internalResourceViewResolver = new InternalResourceViewResolver();
    //请求视图文件的前缀地址
    internalResourceViewResolver.setPrefix("/WEB-INF/jsp/");
    //请求视图文件的后缀
    internalResourceViewResolver.setSuffix(".jsp");
    return internalResourceViewResolver;
}

/**
 * 视图配置
 * @param registry
 */
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
    super.configureViewResolvers(registry);
    registry.viewResolver(resourceViewResolver());
    /*registry.jsp("/WEB-INF/jsp/",".jsp");*/
}

2.6. 配置内容决裁的一些参数 configureContentNegotiation

2.7. 跨域 addCorsMappings

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

2.8. 信息转换器 configureMessageConverters / extendMessageConverters

对比：

configureMessageConverters 覆盖springboot 2.x的默认配置
extendMessageConverters 拓展springboot 2.x的默认配置（推荐）


/**
* 消息内容转换配置
 * 配置fastJson返回json转换
 * @param converters
 */
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> 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);

}

在SpringMVC中，可以使用@RequestBody和@ResponseBody两个注解，分别完成请求报文到对象和对象到响应报文的转换，底层这种灵活的消息转换机制就是利用HttpMessageConverter来实现的，Spring内置了很多HttpMessageConverter，比如MappingJackson2HttpMessageConverter，StringHttpMessageConverter等，下面我们来自定义自己的消息转换器来满足自己特定的需求，有两种方式：1、使用spring或者第三方提供的现成的HttpMessageConverter，2、自己重写一个HttpMessageConverter。

实例：配置使用fastJson插件返回json数据

在springboot项目里当我们在控制器类上加上@RestController注解或者其内的方法上加入@ResponseBody注解后，默认会使用jackson插件来返回json数据，下面我们利用fastjson为我们提供的FastJsonHttpMessageConverter来返回json数据。

首先要引入fastjson的依赖：

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.31</version>
</dependency>

接下来通过实现WebMvcConfigurer接口来配置FastJsonHttpMessageConverter，springboot2.0版本以后推荐使用这种方式来进行web配置，这样不会覆盖掉springboot的一些默认配置。配置类如下: ```java package com.example.demo;

import java.util.List;

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.alibaba.fastjson.serializer.SerializerFeature; import com.alibaba.fastjson.support.config.FastJsonConfig; import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;

@Configuration public class MyWebmvcConfiguration implements WebMvcConfigurer{

/**

springboot2.0版本以后推荐使用这种方式来进行web配置【extendMessageConverters()】;这样不会覆盖掉springboot的一些默认配置。如果用configureMessageConverters的话，可能会覆盖

fastJson配置实体调用setSerializerFeatures方法可以配置多个过滤方式，常用的如下：
  1、WriteNullListAsEmpty  ：List字段如果为null,输出为[],而非null
  2、WriteNullStringAsEmpty ： 字符类型字段如果为null,输出为"",而非null
  3、DisableCircularReferenceDetect ：消除对同一对象循环引用的问题，默认为false（如果不配置有可能会进入死循环）
  4、WriteNullBooleanAsFalse：Boolean字段如果为null,输出为false,而非null
  5、WriteMapNullValue：是否输出值为null的字段,默认为false。
*/
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    FastJsonHttpMessageConverter fjc = new FastJsonHttpMessageConverter();
    FastJsonConfig fj = new FastJsonConfig();
    fj.setSerializerFeatures(SerializerFeature.DisableCircularReferenceDetect);
    fjc.setFastJsonConfig(fj);
    converters.add(fjc);  //这里添加的就是第三方提供的现成的HttpMessageConverter   
    converters.add(converter());  //这里就是自定义的HttpMessageConverter (信息转换器)
}

@Bean
public MyMessageConverter converter() {
    return new MyMessageConverter();
}

}

 3. 自定义的信息转换器  （用处非常少）
```java
package com.example.demo;

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;

//继承AbstractHttpMessageConverter来实现一个自己的消息转换器
public class MyMessageConverter extends AbstractHttpMessageConverter<UserEntity> {


    public MyMessageConverter() {
        // 新建一个我们自定义的媒体类型application/xxx-junlin
        super(new MediaType("application", "xxx-junlin", Charset.forName("UTF-8")));
    }

    @Override
    protected boolean supports(Class<?> clazz) {
        // 表明只处理UserEntity类型的参数。
        return UserEntity.class.isAssignableFrom(clazz);
    }

    /**
     * 重写readlntenal 方法，处理请求的数据。代码表明我们处理由“-”隔开的数据，并转成 UserEntity类型的对象。
     */
    @Override
    protected UserEntity readInternal(Class<? extends UserEntity> clazz,
            HttpInputMessage inputMessage) throws IOException,
            HttpMessageNotReadableException {
        String temp = StreamUtils.copyToString(inputMessage.getBody(), Charset.forName("UTF-8"));
        String[] tempArr = temp.split("-");

        return new UserEntity(tempArr[0],tempArr[1]);
    }

    /**
     * 重写writeInternal ，处理如何输出数据到response。
     */
    @Override
    protected void writeInternal(UserEntity userEntity,
            HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException {
        String out = "hello: " + userEntity.getName() + "-" + userEntity.getAddress();
        outputMessage.getBody().write(out.getBytes());
    }
}

SpringBoot---WebMvcConfigurer详解