为什么要使用WebMvcConfigurer？

WebMvcConfigurer是一个接口，提供很多自定义的拦截器，例如跨域设置、类型转化器等等。可以说此接口为开发者提前想到了很多拦截层面的需求，方便开发者自由选择使用。由于Spring5.0废弃了WebMvcConfigurerAdapter，所以WebMvcConfigurer继承了WebMvcConfigurerAdapter大部分内容。

WebMvcConfigurer方法介绍


由于内容太多，只展示3个关键的接口，用的比较少的，只是阐述下含义，不再详解，用的更少的，就不看了，毕竟十多个方法呢...


1.configurePathMatch(PathMatchConfigurer configurer)

这个用到的比较少，这个是和访问路径有关的。举个例子，比如说PathMatchConfigurer 有个配置是setUseTrailingSlashMatch(),如果设置为true的话（默认为true），后面加个斜杠并不影响路径访问，例如“/user”等同于“/user/"。我们在开发中很少在访问路径上搞事情，所以这个方法如果有需要的请自行研究吧。

2.configureContentNegotiation(ContentNegotiationConfigurer configurer)

这个东西直译叫做内容协商机制，主要是方便一个请求路径返回多个数据格式。ContentNegotiationConfigurer这个配置里面你会看到MediaType，里面有众多的格式。此方法不在多赘述。

3.configureAsyncSupport(AsyncSupportConfigurer configurer)

顾名思义，这是处理异步请求的。只能设置两个值，一个超时时间（毫秒，Tomcat下默认是10000毫秒，即10秒），还有一个是AsyncTaskExecutor，异步任务执行器。

4.configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

这个接口可以实现静态文件可以像Servlet一样被访问。

5.addFormatters(FormatterRegistry registry)

增加转化器或者格式化器。这边不仅可以把时间转化成你需要时区或者样式。还可以自定义转化器和你数据库做交互，比如传进来userId，经过转化可以拿到user对象。

6.addInterceptors(InterceptorRegistry registry)

盼望着，盼望着，你一个常用的方法来了。这个方法可以自定义写拦截器，并指定拦截路径。来，咱们写一个拦截器。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle,ok,假设给你一个true，运行去吧");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle,ok,看看我什么时候运行的。");
    }
    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion,ok,看完不点个赞再走吗？");
    }
}


然后配置一下：

@Configuration
public class MyConfigurer implements WebMvcConfigurer {
    @Bean
    public MyInterceptor getMyInterceptor(){
        return  new MyInterceptor();
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(this.getMyInterceptor())
        .addPathPatterns("/abc","/configurePathMatch");
    }
}


可以看出addPathPatterns()里面可以尝试添加多个路径，或者写成”/**“，包含所有路径都需要尝试拦截一下。

测试一下，输出：

preHandle,ok,假设给你一个true，运行去吧
===》执行业务逻辑===》
postHandle,ok,看看我什么时候运行的。
afterCompletion,ok,看完不点个赞再走吗？


7.addResourceHandlers(ResourceHandlerRegistry registry)

自定义资源映射。这个东西也比较常用，业务场景就是自己的服务器作为文件服务器，不利用第三方的图床，就需要一个虚拟路径映射到我们服务器的地址。值得一提的是，如果你的项目是war包启动，一般都是再Tomcat中配置一下（配置方法请百度）；如果是jar包启动（SpringBoot经常用这种方式启动），就可以用到这个方法了。例如：

 public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/my/**")
    .addResourceLocations("file:E:/my/");
    super.addResourceHandlers(registry);
}


真实路径，wndows当服务器的情况下，前面一定要加上一个file:。

8.addCorsMappings(CorsRegistry registry)

这个是设置跨域问题的，几乎是每个后台服务器都需要配置的东西。我曾写过一篇文章，专门讲跨域问题和SpringBoot怎么配置的，请查询：
https://juejin.im/post/5cfe6367f265da1b9163887f

9.addViewControllers(ViewControllerRegistry registry)

这个方法可以实现，一个路径自动跳转到一个页面。不过现在多为前后端分离的项目，是不是可以把跳转路由的问题直接扔给前端。

后面还有七个：configureViewResolvers、addArgumentResolvers、addReturnValueHandlers、configureMessageConverters、extendMessageConverters、configureHandlerExceptionResolvers、extendHandlerExceptionResolvers。是在用的太少了，就不再看了。

小结

本篇先大概知道下这些都是什么方法，最重要的是知道了WebMvcConfigurer为我们再拦截层做了一些通用拦截器，方便开发者使用。当然也可以自己实现拦截器。最常用的是还是6、7、8。其他的以后有机会研究好了再更新。

WebMvcConfigurer：拦截器的注册类

HandlerInterceptorAdapter：拦截组件

拦截组件HandlerInterceptorAdapter可以有多个，需要注册到WebMvcConfigurer里面，在WebMvcConfigurer里面拦截器是按顺序执行的。

@SpringBootConfiguration

public class InterceptorConfig implements WebMvcConfigurer {

/** 拦截器配置，与业务相关，有着强烈的前后依赖顺序

     请不要在datasourceInterceptor这个拦截器之后再添加，这个拦截器preHandler是进入业务代码最后一个拦截器

    @Override

public void addInterceptors(InterceptorRegistry registry){

WebMvcConfigurer.super.addInterceptors(registry);

registry.addInterceptor(loggerInterceptor());

registry.addInterceptor(authenticateInterceptor());

registry.addInterceptor(datasourceInterceptor());

}

//日志拦截

@Bean("loggerInterceptor")

public LoggerInterceptor loggerInterceptor(){

LoggerInterceptor   interceptor = new  LoggerInterceptor ();

return interceptor;

}

//认证拦截，安全校验相关的拦截操作

@Bean("authenticateInterceptor")

public AuthenticateInterceptor authenticateInteceptor(){

AuthenticateInterceptor interceptor =new AuthenticateInterceptor();

return interceptor;

}

}

------------------------------------------------------------------------------------------------------------

public class AuthenticateInterceptor implements HandlerInterceptor {

//无需拦截的url

private HashSet<String>  set =new HashSet<>();

public AuthenticateInterceptor (){

set .add("/test/login.do");

.......

}

@Override

public boolean preHandle(HttpServletRequest request,HttpServletResponse response,Object handler) throw Exception{

//具体拦截业务

}

}

WebMvcConfigurer 接口

Spring 的 WebMvcConfigurer 接口提供了很多方法让我们来定制 Spring MVC 的配置。这个接口还是非常常用的，可以对 Spring 的很多配置和行为进行定制。下面对一些常用的方法进行解释：

public interface WebMvcConfigurer {

	/**
	 * 匹配路由请求规则
	 */
	default void configurePathMatch(PathMatchConfigurer configurer) {
	}

	/**
	 * 注册自定义的 Formatter 和 Convert
	 */
	default void addFormatters(FormatterRegistry registry) {
	}

	/**
	 * 添加静态资源处理器
	 */
	default void addResourceHandlers(ResourceHandlerRegistry registry) {
	}

    /**
     * 配置消息转换器
     */
    default void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
	}

	/**
	 * 添加自定义视图控制器
	 */
	default void addViewControllers(ViewControllerRegistry registry) {
	}

	/**
	 * 添加自定义方法参数处理器
	 */
	default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
	}
}

springboot WebMvcConfigurer与HandlerInterceptorAdapter使用
简介
WebMvcConfigurer：拦截器的注册类
HandlerInterceptorAdapter：拦截组件

拦截组件HandlerInterceptorAdapter可以有多个，需要注册到WebMvcConfigurer里面，在WebMvcConfigurer里面拦截器是按顺序执行的。

在Spring Boot 2.0后都是靠重写WebMvcConfigurer的方法来添加自定义拦截器，消息转换器等。
在SpringBoot2.0及Spring 5.0前,该类WebMvcConfigurerAdapter被标记为@Deprecated，已被废弃。

WebMvcConfigurer的作用




修饰符和类型
方法
描述




default void
addArgumentResolvers(java.util.List resolvers)
添加解析器以支持自定义控制器方法参数类型。


default void
addCorsMappings(CorsRegistry registry)
配置跨源请求处理。


default void
addFormatters(FormatterRegistry registry)
添加Converters和Formatters除了默认注册的那些。


default void
addInterceptors(InterceptorRegistry registry)
添加Spring MVC生命周期拦截器，用于控制器方法调用的预处理和后处理。


default void
addResourceHandlers(ResourceHandlerRegistry registry)
添加处理程序以提供静态资源，例如来自Web应用程序根目录下的特定位置的图像，js和css文件，类路径等。


default void
addReturnValueHandlers(java.util.List handlers)
添加处理程序以支持自定义控制器方法返回值类型。


default void
addViewControllers(ViewControllerRegistry registry)
配置预配置了响应状态代码的简单自动控制器和/或视图以呈现响应主体。


default void
configureAsyncSupport(AsyncSupportConfigurer configurer)
配置异步请求处理选项。


default void
configureContentNegotiation(ContentNegotiationConfigurer configurer)
配置内容协商选项。


default void
configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)
配置处理程序以通过转发到Servlet容器的“默认”servlet来委派未处理的请求。


default void
configureHandlerExceptionResolvers(java.util.List resolvers)
配置异常解析器。


default void
configureMessageConverters(java.util.List<HttpMessageConverter<?>> converters)
配置HttpMessageConverters用于读取或写入请求或响应的正文。


default void
configurePathMatch(PathMatchConfigurer configurer)
帮助配置HandlerMappings路径匹配选项，例如尾部斜杠匹配，后缀注册，路径匹配器和路径助手。


default void
configureViewResolvers(ViewResolverRegistry registry)
配置视图解析器以将从控制器返回的基于字符串的视图名称转换为具体View 实现以执行渲染。


default void
extendHandlerExceptionResolvers(java.util.List resolvers)
扩展或修改默认配置的异常解析器列表。


default void
extendMessageConverters(java.util.List<HttpMessageConverter<?>> converters)
用于在配置转换器列表后扩展或修改转换器列表的挂钩。


default MessageCodesResolver
getMessageCodesResolver()
提供MessageCodesResolver用于根据数据绑定和验证错误代码构建消息代码的自定义。


default Validator
getValidator()
提供自定义Validator而不是默认创建的自定义。


准备工作
1.创建一个WebMvcConfig类
package com.honghh.bootfirst.config;


import com.honghh.bootfirst.interceptor.AccessSignAuthInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

/**
 * MVC配置
 *
 * @author honghh
 * @date 2018/8/7 23:01
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Resource
    private AccessSignAuthInterceptor accessSignAuthInterceptor;

    /**
     * Description :
     * Group :
     * <p>
     * 实现自定义拦截器只需要3步
     * 1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。
     * 2、创建一个Java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。
     * 3、实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）。
     *
     * @param registry
     * @author honghh
     * @date 2019/3/22 0022 10:08
     * @author honghh
     * @date 2018/8/13 13:56
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        InterceptorRegistration registration = registry.addInterceptor(accessSignAuthInterceptor);
        // 拦截配置
        registration.addPathPatterns("/api/**");
        // 排除配置
        registration.excludePathPatterns("/api/word");
    }
}


2.创建一个ApiController
package com.honghh.bootfirst.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * ClassName: ApiController
 * Description:
 *
 * @author honghh
 * @date 2019/03/22 9:36
 */
@RestController
@RequestMapping("api")
public class ApiController {

    @RequestMapping("hello")
    public String hello() {
        return "Hello Spring Boot!";
    }

    @RequestMapping("word")
    public String word() {
        return "Hello word!";
    }
}


3.定义一个AccessSignAuthInterceptor类
package com.honghh.bootfirst.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * description:
 *
 * @author: hh
 * @date: 2018/8/13 11:03
 */
@Slf4j
@Component
public class AccessSignAuthInterceptor extends HandlerInterceptorAdapter {

    /**
     * 只有返回true才会继续向下执行，返回false取消当前请求
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     * @author honghh
     * @date 2018/8/13 13:58
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("preHandle:请求前调用");
        String url = request.getRequestURI();
        log.info("请求url:{}",url);
        //返回 false 则请求中断
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {
        log.info("postHandle:请求后调用");
    }

    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        log.info("afterCompletion:请求调用完成后回调方法，即在视图渲染完成后回调");
    }
}


4.启动项目分别对api/hello,api/word发起请求

该项目是基于上一节 十、springboot注解式AOP（@Aspect）统一日志管理 实现。主要添加了以上几个类，获取源码增加上即可。
代码获取
https://gitee.com/honghh/boot-demo.git  [boot-aspect]
参考文献
https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html