@Configuration
@EnableCaching
public class CommonConfig implements WebMvcConfigurer {
    //theme
    /**
     * ResourceBundleThemeSource
     * @return themeSource
     */
    @Bean
    public ThemeSource themeSource() {
        ResourceBundleThemeSource themeSource = new ResourceBundleThemeSource();
        themeSource.setBasenamePrefix("themes.style_");
        return themeSource;
    }
    /**
     * SessionThemeResolver
     * @return themeResolver
     */
    @Bean
    public SessionThemeResolver sessionThemeResolver() {
        SessionThemeResolver themeResolver = new SessionThemeResolver();
        themeResolver.setDefaultThemeName("default");
        return themeResolver;
    }
    /**
     * CookieThemeResolver
     * @return resolver
     */
    @Bean
    public CookieThemeResolver themeResolver(){
        CookieThemeResolver resolver = new CookieThemeResolver();
        resolver.setCookieMaxAge(31536000);
        resolver.setDefaultThemeName("default");
        return resolver;
    }
    /**
     * ThemeChangeInterceptor
     * @return ThemeChangeInterceptor
     */
    @Bean
    public ThemeChangeInterceptor themeChangeInterceptor(){
        return new ThemeChangeInterceptor();
    }

    //message
    /**
     * MessageSource
     * @return MessageSource
     */
    @Bean
    public MessageSource messageSource() {
        System.out.println("CacheConfiguration.messageSource()");
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        //must be this style
        messageSource.setBasename("classpath:language/Language");
        return messageSource;
    }
    /**
     * SessionLocaleResolver
     * @return SessionLocaleResolver
     */
    @Bean(name="localeResolver")
    public SessionLocaleResolver sessionLocaleResolver() {
        System.out.println("CacheConfiguration.sessionLocaleResolver()");
        return new SessionLocaleResolver();
    }
    /**
     * LocaleChangeInterceptor
     * @return LocaleChangeInterceptor
     */
    @Bean
    public LocaleChangeInterceptor localeChangeInterceptor(){
        System.out.println("LocaleChangeInterceptor");
        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
        lci.setParamName("lang");
        return lci;
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(themeChangeInterceptor());
        registry.addInterceptor(localeChangeInterceptor());
    }
}

为什么要使用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。其他的以后有机会研究好了再更新。

前言
 
公司的“僵尸项目”（好几年没维护和升级），昨天突然诈尸，出现了一个问题，需要解决，打开代码时，发现项目中用到的WebMvcConfigurerAdapter过期，需要用WebMvcConfigurer来做替换，今天就趁着说一下关于WebMvcConfigurer的两种配置方式。
 
WebMvcConfigurer介绍
 
WebMvcConfigurer是一个接口，提供很多自定义的拦截器，例如跨域设置、类型转化器等等。可以说此接口为开发者提前想到了很多拦截层面的需求，方便开发者自由选择使用。由于Spring5.0废弃了WebMvcConfigurerAdapter，所以WebMvcConfigurer继承了WebMvcConfigurerAdapter大部分内容。
 
WebMvcConfigurer的两种配置方式
 
1.JavaBean配置WebMvcConfigurer
 
采用JavaBean方式我们只需要添加一个web相关配置的类型，并且配置@Configuration注解，将该配置类托管给Spring IOC完成配置，示例代码如下：
 
**
 * @author damokelisijian866
 * @create 2020/8/11 22:16
 * @desc web配置
 */
@Configuration
public class WebJavaBeanConfiguration {
    /**
     * 日志拦截器
     */
    @Autowired
    private LogInterceptor logInterceptor;

    /**
     * 实例化WebMvcConfigurer接口
     *
     * @return
     */
    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            /**
             * 添加拦截器
             * @param registry
             */
            @Override
            public void addInterceptors(InterceptorRegistry registry) {
                registry.addInterceptor(logInterceptor).addPathPatterns("/**");
            }
        };
    }
}

 
我们通过@Bean注解的返回值来完成WebMvcConfigurer的配置实例化，在WebMvcConfigurer接口实例内调用addInterceptors方法完成添加拦截器配置，跟之前WebMvcConfigurerAdapter方式感觉没事区别，只不过是编码形式有一点变化。
 
测试拦截器
 
@Component
public class LogInterceptor implements HandlerInterceptor {
    /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(LogInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        logger.info("请求路径：{}", request.getRequestURI());
        return true;
    }
}

 
测试控制器
 
**
 * @author damokelisijian866
 * @create 2020/8/11 22:20
 * @desc web相关配置类
 */
@RestController
public class TestController {
    /**
     * 测试拦截地址
     * @return
     */
    @RequestMapping(value = "/index")
    public String index() {
        return "Success";
    }
}

 
2 实现类配置WebMvcConfigurer
 
我们创建一个名为WebConfiguration的配置类并且实现WebMvcConfigurer接口
 
**
 * @author damokelisijian866
 * @create 2020/8/11 22:25
 * @desc web相关配置类
 */
@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    /**
     * 日志拦截器
     */
    @Autowired
    private LogInterceptor logInterceptor;

    /**
     * 重写添加拦截器方法并添加配置拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(logInterceptor).addPathPatterns("/**");
    }
}

 
第二种方式有点我们之前使用的感觉，只不过之前是使用的WebMvcConfigurerAdapter抽象类，而现在我们直接使用WebMvcConfigurer接口。

 
WebMvcConfigurer
 
1. 简介
2. WebMvcconfigurer接口
3. WebMvcConfigurer接口详解
3.1 配置拦截器 addInterceptors(InterceptorRegistry registry)
3.2 页面跳转addViewControllers(ViewControllerRegistry registry)
3.3 配置自定义静态资源映射目录 addResourceHandlers(ResourceHandlerRegistry registry)
3.4 配置默认静态资源处理器 configureDefaultServletHanding(DefaultServletHandler
3.5 配置视图解析器 configureViewResolvers(ViewResolverRegistry registry)
3.5.1 配置请求视图映射
3.5.2 视图配置
   
3.6 配置内容协商的一些参数configureContentNegotiation(ContentNegotiationConfigurer configurer)
3.7 配置跨域 addCorsMappings(CorsRegistry registry)
3.8 配置信息转换器 configureMessageConverters(List
 


1. 简介
 
WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些 Handler、Interceptor、ViewResolver、MessageConverter。基于java-based方式的spring mvc配置，需要创建一个配置类(@Configuration注解标识) 并实现 WebMvcConfigurer 接口；
 
在SpringBoot 1.5版本都是靠重写 WebMvcConfigurerAdapter 的方式来添加自定义拦截器，消息转换器等。SpringBoot2.0 后，该类被标识为@Deprecated。官方推荐直接实现WebMvcConfigurer(推荐)或者直接继承WebMVCConfigurationSupport。
 
2. WebMvcconfigurer接口
 
public interface WebMvcConfigurer {
    default void configurePathMatch(PathMatchConfigurer configurer) {}

    default void configureContentNegotiation(ContentNegotiationConfigurer configurer) {}

    default void configureAsyncSupport(AsyncSupportConfigurer configurer) {}

    default void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {}

    default void addFormatters(FormatterRegistry registry) {}

    default void addInterceptors(InterceptorRegistry registry) {}

    default void addResourceHandlers(ResourceHandlerRegistry registry) {}

    default void addCorsMappings(CorsRegistry registry) {}

    default void addViewControllers(ViewControllerRegistry registry) {}

    default void configureViewResolvers(ViewResolverRegistry registry) {}

    default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {}

    default void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> handlers) {}

    default void configureMessageConverters(List<HttpMessageConverter<?>> converters) {}

    default void extendMessageConverters(List<HttpMessageConverter<?>> converters) {}

    default void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {}

    default void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {}

    @Nullable
    default Validator getValidator() { return null; }

    @Nullable
    default MessageCodesResolver getMessageCodesResolver() { return null; }
}
 
WebMvcConfigurer常用接口：
 1.addInterceptors：拦截器
 2.addViewControllers：页面跳转
 3. addResourceHandlers：静态资源
 4. configureDefaultServletHandling：默认静态资源处理器
 5. configureViewResolvers：视图解析器
 6. configureContentNegotiation：配置内容裁决的一些参数
 7. addCorsMappings：跨域
 8. configureMessageConverters：信息转换器
 
3. WebMvcConfigurer接口详解
 
3.1 配置拦截器 addInterceptors(InterceptorRegistry registry)
 
	// 登录拦截器：不拦截请求路径
	List<String> excludePathPatterns = new LinkedList<>();
	excludePathPatterns.add("/loginController.do");
	excludePathPatterns.add("/loginController!login.do");
	excludePathPatterns.add("/loginController!registerPage.do");
	excludePathPatterns.add("/loginController!register.do");
	registry.addInterceptor(loginInterceptor).addPathPatterns("/**").excludePathPatterns(excludePathPatterns);
 
①addInterceptor : 需要一个实现HandlerInterceptor接口的拦截器实例
 
public InterceptorRegistration addInterceptor(HandlerInterceptor interceptor) {
    InterceptorRegistration registration = new InterceptorRegistration(interceptor);
    this.registrations.add(registration);
    return registration;
}
 
②addPathPatterns: 用于设置拦截器的过滤路径规则；addPathPatterns(“/**”)对所有请求都拦截
 
public InterceptorRegistration addPathPatterns(String... patterns) {
    return this.addPathPatterns(Arrays.asList(patterns));
}
 
public InterceptorRegistration addPathPatterns(List<String> patterns) {
    this.includePatterns.addAll(patterns);
    return this;
}
 
③excludePathPatterns: 用于设置不需要拦截的过滤规则；excludePathPatterns("/emp/toLogin","/js/**","/css/**","/images/**")；
 
public InterceptorRegistration excludePathPatterns(String... patterns) {
    return this.excludePathPatterns(Arrays.asList(patterns));
}
 
public InterceptorRegistration excludePathPatterns(List<String> patterns) {
    this.excludePatterns.addAll(patterns);
    return this;
}
 
HandlerInterceptor接口：
 
public interface HandlerInterceptor {
	// 在请求处理之前进行调用(Controller方法调用之前)
	// 只有返回true才会继续向下执行，返回false取消当前请求。
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
	// 请求处理之后调用，但在视图被渲染之前
    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }
	// 在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行(主要用于进行资源清理工作)
    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}
 
3.2 页面跳转addViewControllers(ViewControllerRegistry registry)
 
以前写SpringMVC的时候，如果需要访问一个页面，必须要写Controller类，然后再写一个方法跳转到页面，感觉好麻烦，其实重写WebMvcConfigurer中的addViewControllers方法即可达到效果了
 
	@Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/toLogin").setViewName("login");
    }
 
注意：这里重写addViewControllers方法，并不会覆盖WebMvcAutoConfiguration(SpringBoot自动配置)中的addViewControllers(在此方法中，SpringBoot将”/”映射至index.html)，这也就意味着这里的配置和SpringBoot的自动配置同时有效。
 
3.3 配置自定义静态资源映射目录 addResourceHandlers(ResourceHandlerRegistry registry)
 
	@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/my/**").addResourceLocations("classpath:/my/");
    }
 
addResourceHandler：指的是对外暴露的访问路径
 
addResourceLocations：指的是内部文件存放的目录(真实路径，windows/linux当服务器的情况下，前面一定要加上一个file: 比如：file:E:/xxx/ )
 
值得一提的是，如果你的项目是war包启动，一般都是再Tomcat中配置一下；如果是jar包启动（SpringBoot经常用这种方式启动），就可以用到这个方法了。
 
3.4 配置默认静态资源处理器 configureDefaultServletHanding(DefaultServletHandler
 
Configurer configurer)
 
3.5 配置视图解析器 configureViewResolvers(ViewResolverRegistry registry)
 
该方法的参数ViewResolverRegistry是一个注册器，用来注册你想自定义的视图解析器等。
 
3.5.1 配置请求视图映射
 
@Bean
Public InternalResourceViewResolver internalResourceViewResolver() {
	InternalResourceViewResolver obj = new InternalResourceViewResolver();
	// 请求视图前缀
	obj.setPrefix(“/WEB-INF/jsp/”);
	// 请求视图后缀
	obj.setSuffix(“.jsp”);
	return obj;
}
 
3.5.2 视图配置
 
@Override
Public void configureViewResolvers(ViewResolverRegistry registry) {
	/*registry.jsp("/WEB-INF/jsp/",".jsp");*/
	registry.viewResolver(internalResourceViewResolver());
}
 
3.6 配置内容协商的一些参数configureContentNegotiation(ContentNegotiationConfigurer configurer)
 
内容协商: 在 HTTP 协议中，内容协商是这样一种机制，通过为同一 URI 指向的资源提供不同的展现形式，可以使用户代理选择与用户需求相适应的最佳匹配（例如，文档使用的自然语言，图片的格式，或者内容编码形式）。
 
 
@Override
    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);
}
 
上面代码说白了就是告诉系统什么类型用什么来标识。
 
3.7 配置跨域 addCorsMappings(CorsRegistry registry)
 
@Override
public void addCorsMappings(CorsRegistry registry) {
    registry.addMapping("/cors/**")
            .allowedHeaders("*")
            .allowedMethods("POST","GET")
            .allowedOrigins("*");
}
 
3.8 配置信息转换器 configureMessageConverters(List<HttpMessageConverter<?>> converters)
 
这个配置一般针对于Api接口服务程序，配置在请求返回时内容采用什么转换器进行转换，我们最常用到的就是fastJson的转换，配置如下所示：
 
/**
     * 消息内容转换配置
     * 配置fastJson返回json转换
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        /1.需要定义一个convert转换消息的对象;
        FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
        //2.添加fastJson的配置信息，比如：是否要格式化返回的json数据;
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullStringAsEmpty,
                SerializerFeature.DisableCircularReferenceDetect,
                SerializerFeature.WriteNullListAsEmpty,
                SerializerFeature.WriteDateUseDateFormat);
        //3处理中文乱码问题
        List<MediaType> fastMediaTypes = new ArrayList<>();
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        //4.在convert中添加配置信息.
        fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
        fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
        //5.将convert添加到converters当中.
        converters.add(fastJsonHttpMessageConverter);
}
 
内容转换都是针对面向接口进行编写的实现类，都必须implements HttpMessageConverter接口完成方法的实现。
 
3.9 配置异步请求处理 configureAsyncSupport(AsyncSupportConfigurer configurer)
 
处理异步请求。只能设置两个值，一个超时时间(毫秒,Tomcat下默认是10000毫秒，即10秒)，还有一个是AsyncTaskExecutor 异步任务执行器。
 
3.10 addFormatters(FormatterRegistry registry)
 
增加转换器或者格式化器。这边不仅可以把时间转化成你需要时区或者样式。还可以自定义转化器和你数据库做交互，比如传进来userId，经过转化可以拿到user对象。