WebMvcConfigurer 详解

共计 3736 个字符，预计需要花费 10 分钟才能阅读完成。

简介

WebMvcConfigurer 配置类其实是 Spring 内部的一种配置方式，采用 JavaBean 的形式来代替传统的 xml 配置文件形式进行针对框架个性化定制，可以自定义一些 Handler，Interceptor，ViewResolver，MessageConverter。

在 SpringBoot 1.5 版本都是靠重写 WebMvcConfigurerAdapter 的方法来添加自定义拦截器，消息转换器等。SpringBoot 2.0 后，该类被标记为@Deprecated（弃用）。

官方推荐直接实现 WebMvcConfigurer 或者直接继承 WebMvcConfigurationSupport，方式一实现 WebMvcConfigurer 接口（推荐），方式二继承 WebMvcConfigurationSupport 类。

接口方法

/**
 * 这里只介绍常用的方法
 */
public interface WebMvcConfigurer {
    // 拦截器配置
    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) ;
}

方法解释

1. addInterceptors(InterceptorRegistry var1)

该方法用于配置拦截器，拦截器可以在请求处理的前后进行预处理和后处理。可以用于实现日志记录、权限验证、防止重复提交等功能。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前进行拦截处理
        // 返回true表示继续处理请求，返回false表示中断请求处理
        return true;
    }
}

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
    }
}

2. addViewControllers(ViewControllerRegistry registry)

该方法用于配置视图跳转控制器，它可以简化一些只需要简单页面跳转而无需额外处理的场景。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/home").setViewName("home"); // 将访问路径/home映射到名为"home"的视图
        registry.addViewController("/login").setViewName("login");
    }
}

3. addResourceHandlers(ResourceHandlerRegistry registry)

该方法用于配置静态资源处理，可以指定静态资源的位置和映射规则，让 Spring MVC 能够正确处理静态资源的访问请求。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 将所有以/static/开头的请求映射到classpath下的static目录
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/");
    }
}

4. configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

该方法用于配置默认的静态资源处理器。当 DispatcherServlet 无法处理某些静态资源请求时，将会委托给默认的 Servlet 处理。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable(); // 开启默认的静态资源处理
    }
}

5. configureViewResolvers(ViewResolverRegistry registry)

该方法用于配置视图解析器，视图解析器用于将逻辑视图名解析为具体的视图。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        registry.jsp("/WEB-INF/views/", ".jsp"); // 使用JSP作为视图解析器，指定视图文件的位置和后缀
    }
}

6. configureContentNegotiation(ContentNegotiationConfigurer configurer)

该方法用于配置内容裁决选项，内容裁决指的是根据客户端请求的媒体类型（如Accept头部信息）来决定返回响应的数据格式。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorPathExtension(false) // 禁用URL扩展匹配
                  .favorParameter(true) // 启用请求参数匹配
                  .parameterName("format") // 设置请求参数名，默认为"format"
                  .ignoreAcceptHeader(true) // 忽略Accept头部信息
                  .defaultContentType(MediaType.APPLICATION_JSON); // 设置默认的内容类型
    }
}

7. addCorsMappings(CorsRegistry registry)

该方法用于配置解决跨域问题，允许跨域资源共享(CORS)请求。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/api/**") // 指定哪些路径支持跨域请求
                .allowedOrigins("http://domain1.com", "http://domain2.com") // 允许的来源域名
                .allowedMethods("GET", "POST", "PUT", "DELETE") // 允许的请求方法
                .allowedHeaders("header1", "header2", "header3") // 允许的请求头
                .allowCredentials(true); // 是否支持发送凭据，如cookies
    }
}

提醒：本文发布于396天前，文中所关联的信息可能已发生改变，请知悉！