详细讲解:WebMvcConfigurer 接口

目录

一、它是什么?

二、为什么要用它?(核心价值)

[1. 不破坏 Spring Boot 自动配置](#1. 不破坏 Spring Boot 自动配置)

[2. 集中管理 MVC 配置](#2. 集中管理 MVC 配置)

[3. 代码优雅、符合 Spring 设计规范](#3. 代码优雅、符合 Spring 设计规范)

[三、最常用的 10 个方法(附实战代码)](#三、最常用的 10 个方法(附实战代码))

标准配置类模板

[1. 跨域配置(最常用)](#1. 跨域配置(最常用))

[2. 添加拦截器](#2. 添加拦截器)

[3. 静态资源映射(图片 / 文件访问)](#3. 静态资源映射(图片 / 文件访问))

[4. 直接路径映射到视图(无需写 Controller)](#4. 直接路径映射到视图(无需写 Controller))

[5. 自定义消息转换器(JSON 格式化、日期格式化)](#5. 自定义消息转换器(JSON 格式化、日期格式化))

[6. 格式化器(日期、数字格式化)](#6. 格式化器(日期、数字格式化))

[7. 路径匹配规则(如开启后缀匹配 *.do)](#7. 路径匹配规则(如开启后缀匹配 *.do))

[8. 自定义参数解析器](#8. 自定义参数解析器)

[9. 统一异常处理器(老方式,现在推荐 @RestControllerAdvice)](#9. 统一异常处理器(老方式,现在推荐 @RestControllerAdvice))

[10. 视图解析器配置](#10. 视图解析器配置)

[四、关键注意事项(面试 / 开发高频坑)](#四、关键注意事项(面试 / 开发高频坑))

[1. 千万不要加 @EnableWebMvc](#1. 千万不要加 @EnableWebMvc)

[2. 一个项目可以有多个 WebMvcConfigurer](#2. 一个项目可以有多个 WebMvcConfigurer)

[3. 执行顺序](#3. 执行顺序)

[4. 和 @ControllerAdvice / @RestControllerAdvice 区别](#4. 和 @ControllerAdvice / @RestControllerAdvice 区别)

[五、一张图总结 WebMvcConfigurer 作用](#五、一张图总结 WebMvcConfigurer 作用)

总结


WebMvcConfigurerSpring MVC 提供的核心配置接口 ,专门用来自定义 Spring MVC 的行为 ,是 Spring Boot/Web 项目中做 MVC 个性化配置的标准方案

简单说:你不想用 Spring 默认的 MVC 规则,想自己改,就用它!


一、它是什么?

  1. 全限定名

    复制代码
    org.springframework.web.servlet.config.annotation.WebMvcConfigurer
  2. 本质 一个Java 接口 ,里面定义了大量默认空实现的回调方法。

  3. 作用 用来定制化配置 Spring MVC ,不需要自己创建 DispatcherServlet、接管整个 MVC 配置。

  4. 使用方式

    • 新建配置类
    • 实现 WebMvcConfigurer
    • 重写需要的方法
    • 加上 @Configuration 注解

二、为什么要用它?(核心价值)

1. 不破坏 Spring Boot 自动配置

  • 实现 WebMvcConfigurer = 扩展配置
  • 继承 WebMvcConfigurationSupport = 全面接管,会覆盖自动配置(不推荐)

2. 集中管理 MVC 配置

包括:跨域、拦截器、视图控制器、静态资源、消息转换器、参数解析、格式化等。

3. 代码优雅、符合 Spring 设计规范

官方推荐的扩展方式。


三、最常用的 10 个方法(附实战代码)

下面是开发中99% 会用到 的方法,我直接给你可复制的完整配置类

标准配置类模板

复制代码
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.*;

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    // 下面放各种重写方法
}

1. 跨域配置(最常用)

复制代码
@Override
public void addCorsMappings(CorsRegistry registry) {
    registry.addMapping("/**")           // 对所有接口生效
            .allowedOrigins("*")         // 允许所有来源
            .allowedMethods("GET","POST","PUT","DELETE") // 允许的请求方法
            .allowCredentials(true)      // 允许携带Cookie
            .maxAge(3600);               // 预检有效期
}

2. 添加拦截器

复制代码
@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LoginInterceptor())
            .addPathPatterns("/**")          // 拦截所有请求
            .excludePathPatterns("/login","/static/**"); // 放行登录、静态资源
}

3. 静态资源映射(图片 / 文件访问)

复制代码
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 访问路径:http://localhost:8080/files/xxx.jpg
    registry.addResourceHandler("/files/**")
            .addResourceLocations("file:D:/upload/"); // 真实磁盘路径
}

4. 直接路径映射到视图(无需写 Controller)

复制代码
@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("/").setViewName("index");
    registry.addViewController("/login").setViewName("login");
}

5. 自定义消息转换器(JSON 格式化、日期格式化)

复制代码
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    // 常用:替换默认Jackson,自定义日期格式
    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
    converter.setObjectMapper(objectMapper);
    converters.add(converter);
}

6. 格式化器(日期、数字格式化)

复制代码
@Override
public void addFormatters(FormatterRegistry registry) {
    registry.addFormatter(new DateFormatter("yyyy-MM-dd"));
}

7. 路径匹配规则(如开启后缀匹配 *.do)

复制代码
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    // 开启后缀模式匹配,如 /user 等价于 /user.do
    configurer.setUseSuffixPatternMatch(true);
}

8. 自定义参数解析器

复制代码
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
    resolvers.add(new MyLoginUserArgumentResolver());
}

9. 统一异常处理器(老方式,现在推荐 @RestControllerAdvice)

复制代码
@Override
public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    // 自定义异常解析
}

10. 视图解析器配置

复制代码
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
    registry.jsp("/WEB-INF/views/", ".jsp");
}

四、关键注意事项(面试 / 开发高频坑)

1. 千万不要加 @EnableWebMvc

  • 加了 = 自动配置全部失效,完全自己接管 MVC
  • 不加 = 扩展配置,保留 Spring Boot 自动配置 ✅

2. 一个项目可以有多个 WebMvcConfigurer

Spring 会自动合并所有配置

3. 执行顺序

  • 可以用 @Order(1) 指定配置类执行顺序

4. 和 @ControllerAdvice / @RestControllerAdvice 区别

  • WebMvcConfigurer配置 MVC 规则
  • @RestControllerAdvice全局异常处理、全局数据绑定

五、一张图总结 WebMvcConfigurer 作用

复制代码
请求流程:
请求 → 跨域配置 → 拦截器 → 参数解析 → 消息转换器 → 控制器 → 响应
        ↑             ↑            ↑             ↑
      由 WebMvcConfigurer 统一配置

总结

  1. WebMvcConfigurer = Spring MVC 扩展配置神器
  2. 实现它 + 重写方法 = 自定义 MVC 行为
  3. 不加 @EnableWebMvc,否则自动配置失效
  4. 常用功能:跨域、拦截器、静态资源、JSON 格式化、视图映射
相关推荐
平头哥AI18 分钟前
Day 01 | go run 跑通第一个 Go 程序,go build 留下一个能拷走的 exe
开发语言·后端·golang
斑马13924 分钟前
Linux软件编程学习笔记(十二)——TCP并发服务器模型
java·服务器·网络
冬栈程序设计28 分钟前
Springboot宿舍管理系统【670099】 -附源码(开箱即用)
java·毕业设计·springboot·课程设计·程序设计·大作业
2601_9622845037 分钟前
北京Java全栈开发培训 Web前端开发 软件测试就业培训班
java·软件测试·web前端·全栈开发·就业培训
葡萄城技术团队1 小时前
工业数据可视化:使用活字格 AIcoding + Three.js 构建轻量化三维设备监控大屏
开发语言·javascript·信息可视化
qiaosaifei1 小时前
JAVA老项目中有大量的类名_编译时报找不到符号错误
java·开发语言
聪明蛋子哟1 小时前
MCP协议深度落地:如何用Python/Java双语言实现统一的工具调用网关?
java·开发语言·python
文子越来越强1 小时前
【双因子认证】拦截注解@MFACheck 接入指南(其他微服务如何用)
java
一晌小贪欢1 小时前
python-第27天:Python面向对象详解
开发语言·python·数据可视化·面向对象·python办公
ZGG0032 小时前
线程池详解:从 7 大参数到生产避坑
java·数据库·后端