SpringBoot中的WebMvcConfigurer配置接口的详解_implements webmvcconfigurer-CSDN博客

1. 简介

2. WebMvcConfigurer接口

2.1 addInterceptors：拦截器配置

2.2 addViewControllers：页面跳转

2.3 addResourceHandlers：静态资源处理

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

2.5 configureViewResolvers：视图解析器

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

2.7 addCorsMappings：跨域

2.8 configureMessageConverters：信息转换器

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. WebMvcConfigurer接口

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<HandlerMethodArgumentResolver> var1);
 
    void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> var1);
 
    void configureMessageConverters(List<HttpMessageConverter<?>> var1);
 
    void extendMessageConverters(List<HttpMessageConverter<?>> var1);
 
    void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> var1);
 
    void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> var1);
 
    Validator getValidator();
 
    MessageCodesResolver getMessageCodesResolver();
}

常用的方法：

/* 拦截器配置 */
void addInterceptors(InterceptorRegistry var1);

/* 视图跳转控制器 */
void addViewControllers(ViewControllerRegistry registry);

/* 静态资源处理 */
void addResourceHandlers(ResourceHandlerRegistry registry);

/* 默认静态资源处理器 */
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);

/* 这里配置视图解析器 */
void configureViewResolvers(ViewResolverRegistry registry);

/* 配置内容裁决的一些选项*/
void configureContentNegotiation(ContentNegotiationConfigurer configurer);

/** 解决跨域问题 **/
public void addCorsMappings(CorsRegistry registry);

2.1 addInterceptors：拦截器配置

addInterceptor：需要一个实现 HandlerInterceptor 接口的拦截器实例。
addPathPatterns：用于设置拦截器的过滤路径规则；addPathPatterns("/**")对所有请求都拦截。
excludePathPatterns：用于设置不需要拦截的过滤规则。
拦截器主要用途：进行用户登录状态的拦截，日志的拦截等。

@Override
public void addInterceptors(InterceptorRegistry registry) {
    super.addInterceptors(registry);
    registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**").excludePathPatterns("/emp/toLogin","/emp/login","/js/**","/css/**","/images/**");
}

2.2 addViewControllers：页面跳转

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

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

值的指出的是，在这里重写 addViewControllers 方法，并不会覆盖 WebMvcAutoConfiguration（Springboot 自动配置）中的 addViewControllers（在此方法中，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/");
    }
}

addResoureHandler：指的是对外暴露的访问路径。
addResourceLocations：指的是内部文件放置的目录。

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) {
    registry.addMapping("/**")
            .allowedOrigins("*")  //浏览器允许所有的域访问 / 注意 * 不能满足带有cookie的访问,Origin 必须是全匹配
            .allowCredentials(true)   // 允许带cookie访问
            .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
            .allowedHeaders("token")
            .maxAge(3600);
}

如果还是不能解决问题，那你就需要想办法获取到请求的request和response对象处理一把，比如通过编写filter在response对象中添加响应头：

@Component
public class SessionInterceptor extends HandlerInterceptorAdapter {

    @Autowired
    RedisUtil redisUtil;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String origin = request.getHeader("Origin");
        if (StringUtils.hasText(origin)) { //跨域支持
            response.addHeader("Access-Control-Allow-Origin", origin);
        }
		//......
       return super.preHandle(request, response, handler);
    }
}

2.8 configureMessageConverters：信息转换器

 
/**
* 消息内容转换配置
 * 配置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);
 
}

参考文章：https://blog.csdn.net/fmwind/article/details/81235401

参考文章：https://blog.csdn.net/weixin_43453386/article/details/83623242

原文地址：https://blog.csdn.net/zhangpower1993/article/details/89016503