SpringBoot之MVC配置（WebMvcConfigurer详解）

偏执的太偏执、 2024-03-17 18:25 65阅读 0赞

### 一：基本介绍 ###

Spring MVC是一种常用的Java Web框架，它提供了一种基于MVC模式的开发方式，可以方便地实现Web应用程序。在Spring MVC中，WebMvcConfigurer是一种常用的配置方式，可以允许我们自定义Spring MVC的行为，比如添加拦截器、消息转换器等。在本文中，我们将介绍什么是WebMvcConfigurer，以及如何使用它来自定义Spring MVC的配置。可以看到WebMvcConfigurer是一个非常灵活和强大的工具，它可以让我们实现自己的业务需求并提高代码的可读性和可维护性。而且我们在Spring、SpringBoot都可以很简单的使用WebMvcConfigurer，**下面主要在SpringBoot中说明配置**。

#### 1：提示说明 ####

其实在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器，消息转换器等。但是到了SpringBoot 2.0之后，WebMvcConfigurerAdapter被标记为@Deprecated（弃用）。官方推荐直接实现WebMvcConfigurer或者直接继承WebMvcConfigurationSupport，这两种区别如下：（**[具体参考官方API：6.0.9][API_6.0.9]**）

![c1b208da1f20334fce3953396cd9caa9.gif][]

WebMvcConfigurer和WebMvcConfigurationSupport都是Spring MVC中的组件，它们都可以用于配置Spring MVC的一些特性。
    具体的区别如下：
        ①：实现方式不同：
            WebMvcConfigurer：
                是一个接口，它提供了多个回调方法，可以用于自定义Spring MVC的配置（如消息转换器、拦截器等）。我们在使用时只需要实现
                该接口，重写其中的方法即可。
            WebMvcConfigurationSupport：
                是一个抽象类，它也提供了多个回调方法，用于自定义Spring MVC的配置，但是需要继承该类并重写其中的方法。
        ②：作用不同：
            WebMvcConfigurer：
                主要用于添加或修改Spring MVC的配置，如添加拦截器，自定义消息转换器等。
            WebMvcConfigurationSupport：
                主要用于完全自定义Spring MVC的配置，如果我们需要对Spring MVC的配置进行大量的自定义，可以选择继承该类并重写其中的
                方法。但是需要注意的是，继承该类会覆盖Spring MVC的部分默认配置。
                因此，当我们只需要对部分配置进行自定义时，应该使用WebMvcConfigurer。
        ③：继承关系不同
            WebMvcConfigurer：
                没有继承关系，我们只需要实现该接口即可使用。
            WebMvcConfigurationSupport：
                是一个抽象类，需要继承后才能使用。
    总结：在日常开发中推荐优先使用WebMvcConfigurer的方式，因为简单方便，也没有特别复杂的定制需求；
         若我们项目中使用的MVC存在着更加复杂的配置需求推荐WebMvcConfigurationSupport，通过继承此类，我们可以说对官方的MVC代码进行
         重写操作，但是因为其配置量较大，实现比较复杂，因此在日常开发中使用WebMvcConfigurationSupport并不常见。

![b467d55695c637c172834c57ef86790c.gif][]

#### 2：MVC配置简要 ####

![4594744f90c5b2173b301686c71f4cfd.gif][]

说MVC配置，其实就是说在WebMvcConfigurer接口提供了很多种自定义配置，需要我们自定义配置，其常用配置如下：
        1：addInterceptors（拦截器配置）
            这个方法可用于配置拦截器。
        2：addCorsMappings（全局跨域处理）
            这个方法用来配置跨域访问的规则。
        3：addViewControllers（注册视图控制器）
            这个方法可以注册一个或多个视图控制器，让我们写的地址可以对应一个资源文件，如html文件
        4：addResourceHandlers（配置静态资源处理）
            方法可用于配置静态资源处理器。可以在客户端直接访问静态资源信息

![43403af754b1b5b90e609495770f73ea.gif][]

#### 3：Spring和SpringBoot配置WebMvcConfigurer区别 ####

![a6498345eebf36f2c8d9ac3706bee5bd.gif][]

Spring中配置WebMvcConfigurer方式：
        ①：创建一个 Java 类，并实现WebMvcConfigurer接口
            @Configuration
            public class MyWebMvcConfig implements WebMvcConfigurer {
                // 自定义配置代码
            }
        ②：注入到Bean容器里
            @Configuration
            public class AppConfig {
                @Bean
                public MyWebMvcConfig myWebMvcConfig() {
                    return new MyWebMvcConfig();
                }
            }
    SpringBoot中配置WebMvcConfigurer方式：（这种方式简单）
        ①：创建一个 Java 类，并实现WebMvcConfigurer接口就可以了
                @Configuration
                public class MyWebMvcConfig implements WebMvcConfigurer {
                    // 自定义配置代码
                }

![1977c9bf1531ff79fff09bad034ecb6c.gif][]

[回到目录 ↑↑↑][Link 1]

### 二：拦截器配置（addInterceptors） ###

在SpringBoot中，我们可以使用拦截器来对请求进行统一的预处理或后处理。拦截器可以用于日志记录、权限检查、性能监控、事务控制等方面，是一个非常重要的组件。要在SpringBoot中实现拦截器，则首先要创建一个实现HandlerInterceptor接口的拦截器类。该接口定义了三个方法，分别是**preHandle、postHandle和afterCompletion**，用于在请求处理前、请求处理后和请求完成后进行处理。

![786479aadd06daa912bfd48e6a05a35f.gif][]

HandlerInterceptor接口方法详解：
        ①：preHandler
            在请求处理之前被调用。该方法在Interceptor类中最先执行，用来进行一些前置初始化操作或是对当前请求做预处理，
            也可以进行一些判断来决定请求是否要继续进行下去。该方法的返回值是Boolean类型，当它返回false时，表示请求结束，
            后续的Interceptor和Controller都不会再执行；当它返回为true时会继续调用下一个Interceptor的preHandle方法，
            如果已经是最后一个Interceptor的时候就会调用当前请求的Controller方法。
        ②：postHandler
            在请求处理完成之后调用。也就是Controller方法调用之后执行，但是它会在DispatcherServlet进行视图返回渲染之前被调用，
            所以我们可以在这个方法中对Controller处理之后的ModelAndView对象进行操作。
        ③：afterCompletion
            在整个请求结束后调用。就是对应的Interceptor类的postHandler方法返回true时才执行。就是说该方法将在整个请求结束之后，
            也就是在DispatcherServlet渲染了对应的视图之后执行。此方法主要用来进行资源清理。
    注：官方其实不建议我们非要把3个方法都重写，我们只要对需要的方法重写接口，就比如大部分项目只需要重写preHandler方法

![470831e0666682136ddb716dbd20c3b2.gif][]

![00ac397d66769e68e7b7217875f0ac0f.gif][]

**示例代码 实现拦截器接口（用于配置拦截器）**

我们配置完拦截器之后，这时拦截器只是一个未被注册的普通类，这时需要把一个或者多个拦截器注册到WebMvcConfigurer

![526f92e70b9467f8dd58662541e772ee.gif][]

InterceptorRegistry类方法介绍：
        ①：addInterceptor
            该方法用于向拦截器链中添加一个拦截器。interceptor参数为待添加的拦截器对象，可以是自定义的拦截器类或Spring提供的预置
            拦截器。返回值为InterceptorRegistration对象，用于进一步配置该拦截器的属性。
        ②：addWebRequestInterceptor
            该方法用于向WebRequest拦截器链中添加一个拦截器。interceptor参数为待添加的拦截器对象，
            可以是自定义的WebRequestInterceptor类或者Spring提供的预置拦截器。
            也是返回值为InterceptorRegistration对象，用于进一步配置该拦截器的属性。
        ③：getInterceptors
            用于获取当前已经添加到拦截器链中的所有拦截器，返回值为List<HandlerInterceptor>对象，表示拦截器列表。
    InterceptorRegistration类方法介绍：
        ①：order
            该方法用于设置拦截器的执行顺序，即在拦截器链中的位置。order参数为一个整数，值越小表示越先执行。
        ②：addPathPatterns
            该方法用于设置需要拦截的请求路径模式，即满足哪些请求路径时才会触发该拦截器。若"/**"则拦截全部；
            传入的参数是一个字符串数组，包含多个Ant风格的路径模式，例如 "/api/**"、"/user/*"等。
        ③：excludePathPatterns
            该方法用于设置不需要拦截的请求路径模式，即满足哪些请求路径时不会触发该拦截器。一般不拦截，如登录或者Swagger等
            传入的参数是一个字符串数组，包含多个Ant风格的路径模式，例如 "/api/login"、"/user/login"等。
        ④：pathMatcher
            该方法用于设置该拦截器所使用的PathMatcher实例，从而可以自定义路径匹配逻辑。

![796044606d628a1d2330a507972744aa.gif][]

![01b17fa285eaa1935d3785971fdeab92.gif][]

**示例代码 在WebMvcConfigurer类上注册创建的拦截器**

**　　注：拦截的路径或者放行的路径是以Controller开始的，如我们在application.yml配置的地址前缀则不包含**

[回到目录 ↑↑↑][Link 1]

### 三：跨域配置（addCorsMappings） ###

如何是跨域，大家应该都了解，这里我将在WebMvcConfigurer中解决跨域问题，其实跨域的解决方式很多，这里我就简单说明，具体参考：[SpringBoot如何解决跨域的三种方式][SpringBoot]

![07e1a8f3ce355ab8b78d5746bcae78a2.gif][]

CorsRegistry类方法介绍：
        ①：addMapping
            该方法用于添加允许跨域访问的路径，String类型，若存在多个路径则需要在CorsRegistry里配置多个
    CorsRegistration类方法介绍：
        CorsRegistration是CorsRegistry的辅助类，使用它可以对单个跨域请求进行更细粒度的配置。
        ①：allowedOrigins（低版本使用，但是现在高版本也支持）
            设置允许跨域请求的来源URL。该方法接受多个参数，每个参数为一个允许的来源URL。或者设置"*"
        ②：allowedOriginPatterns（一般使用这种方式）
            设置允许跨域请求的来源URL的模式。该方法接受多个参数，每个参数为一个允许的来源URL模式。或者设置"*"
        ③：allowCredentials
            设置是否允许跨域请求携带凭证信息。默认情况下，浏览器不会向跨域请求发送Cookie等凭证信息。
            如果希望携带凭证信息，则需要将allowCredentials方法设置为true。
        ④：allowedMethods
            设置允许跨域请求的HTTP方法。该方法接受多个参数，每个参数为一种允许的HTTP请求方式。
        ⑤：allowedHeaders
            设置允许请求携带的HTTP头信息。该方法接受多个参数，每个参数为一种允许的HTTP头信息。(放行哪些请求头部信息)
        ⑥：exposedHeaders
            设置响应头信息，这些信息允许客户端访问。该方法接受多个参数，每个参数为一种允许的响应头信息。(暴露哪些响应头信息)
        ⑦：combine
            将当前CorsRegistration对象与另一个CorsConfiguration对象合并，返回合并后的CorsConfiguration对象。
            可以使用该方法将多个CorsRegistration对象的配置合并到同一个CorsConfiguration对象中。
        ⑧：maxAge
            设置响应的缓存时间，单位为秒，默认30分钟。
            例如，当设置maxAge为3600时，如果浏览器在一小时内再次向同一个目标URL发送跨域请求，
            就可以直接使用以前的预检请求结果，而不需要再次进行预检请求。maxAge属性只影响预检请求的缓存时间，
            而不会影响正常的跨域请求，因此不会对实际的业务逻辑产生影响。此外，maxAge属性的具体值需要根据实际情况进行调整，
            过小的缓存时间可能会导致频繁的预检请求，过大的缓存时间可能会使跨域请求的控制权得不到及时更新，从而增加安全风险。

![a6498345eebf36f2c8d9ac3706bee5bd.gif][]

![d463849b400b14e9439fdd95d8b6c7f9.gif][]

**测试跨域请求发送（直接启动这个html，配置可能跨域的地址即可）**

![d8797d71fc15380c1d14df9bc3064de6.gif][]

**示例代码** **跨域放行代码配置**

[回到目录 ↑↑↑][Link 1]

### 四：注册页面跳转（addViewControllers） ###

addViewControllers方法是SpringMVC中WebMvcConfigurer接口定义的一个方法，用于注册一个简单的视图控制器，以便将请求路径映射到一个具体的视图页面。在一些简单的场景下，我们可能只需要将某个请求路径直接映射到一个固定的视图页面，而不需要进行额外的逻辑处理。此时，可以使用addViewControllers方法来快速注册一个视图控制器，并指定对应的请求路径和视图名称即可。但是我们需要额外注意的是，**我们在SpringBoot中处理视图跳转时最好集成Thymeleaf，因为它是SpringBoot指定认可的并且，Thymeleaf与SpringMVC协同工作，可以方便地实现快速开发Web应用程序。**

![738e71147a857492bc935f0fbba0769d.gif][]

在SpringBoot配置Thymeleaf的一些信息：
    导入Thymeleaf坐标：
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
    在application.yml配置Thymeleaf配置信息：
        spring:
           # 配置Thymeleaf模板(默认启动会请求/templates/index.html)
          thymeleaf:
            cache: false                      # 是否有模板缓存
            prefix: classpath:/templates/     # 模板放置的位置
            suffix: .html                     # 模板后缀
            mode: HTML                        # 模板类型
            encoding: UTF-8                   # 模板编码

![defd8e974a67b266e0684e05d65019c9.gif][]

配置完基本的信息后我们就可以进行资源视图的跳转了，如下一些基本介绍：

![3df0a6906ec3fc51de5c3f9bad12a54a.gif][]

ViewControllerRegistry类说明：
        ①：addViewController(String urlPath)
            通过urlPath参数指定的请求URL路径（例如"/home"）注册一个简单的视图控制器，
            该方法返回一个ViewControllerRegistration对象，通过该对象可以设置相关属性，如视图名称、请求方式等。
            如：registry.addViewController("/login");
        ②：setOrder(int order)
            设置当前视图控制器的执行顺序，当有多个视图控制器针对同一请求路径时，可以使用该方法进行优先级排序。
            默认情况下，不同的视图控制器按照它们被注册的顺序执行。
        ③：addRedirectViewController(String urlPath, String redirectUrl)
            注册一个重定向视图控制器，将urlPath请求路径重定向到指定的重定向地址redirectUrl。
            如：registry.addRedirectViewController("/toBaidu","https://www.baidu.com");
    ViewControllerRegistration类说明：
    　　①：setViewName(String viewName)
            资源路径的前缀
    　　②：setStatusCode(HttpStatus statusCode)
            配置访问不存在资源的响应码，如下常见的：
                HttpStatus.BAD_REQUEST：请求参数错误或格式不正确，例如缺少必需参数、参数类型错误等。
                HttpStatus.UNAUTHORIZED：未经授权访问，需要用户登录或提供凭证。
                HttpStatus.FORBIDDEN：已经授权但访问被禁止，通常意味着权限不足或需要进行进一步身份验证。
                HttpStatus.NOT_FOUND：请求的资源不存在，通常使用自定义的404错误页面进行提示。
                HttpStatus.METHOD_NOT_ALLOWED：请求方式不支持，例如GET请求访问只支持POST的接口时会返回405错误。
                HttpStatus.INTERNAL_SERVER_ERROR：服务器内部错误，需要在后台进行排查和修复。
            示例：registry.addViewController("/**").setStatusCode(HttpStatus.NOT_FOUND);
                说明：访问不存在的页面我一律按照404处理，但是我们templates/error/404.html页面需要存在
    说明：按照我们之前配置的thymeleaf配置来说，默认根路径为resources/templates，跳转的资源文件都是.html文件

![4608bb9785937dd11a27b849206b3688.gif][]

![324cf0f78f78ba7d139c435c563338bd.gif][]

**示例代码 注册页面跳转配置**

[回到目录 ↑↑↑][Link 1]

### 五：配置静态资源处理（addResourceHandlers） ###

addResourceHandlers方法是SpringMVC框架提供的一种配置静态资源的方式，它可以将指定的资源路径映射到一个或多个URL路径上，并指定资源的缓存策略、版本号以及是否允许目录列表等选项。具体来说，addResourceHandlers方法需要传入一个ResourceHandlerRegistry对象作为参数，然后在这个对象上调用addResourceHandler方法，来添加一个或多个处理器。

![65ba996606634d47a6d771fc9537dc53.gif][]

ResourceHandlerRegistry类方法介绍：
        ①：addResourceHandler
            该方法用于指定静态资源的URL路径，支持Ant风格的通配符，如“/resources/**”表示匹配所有以“/resources/”开头的请求。
    ResourceHandlerRegistration类方法介绍：
        ①：addResourceLocations
            该方法为静态资源所在的物理路径或URL。可以使用多个addResourceLocations方法指定多个路径，如下例：
            registry.addResourceHandler("/resources/**")
                    .addResourceLocations("classpath:/static/", "file:/opt/files/")
            说明：
                classpath:/static/表示在项目的Classpath下（即src/main/resources文件夹下）查找static文件夹，
                file:/opt/files/表示在系统中的/opt/files/目录下查找文件。
        ②：setCacheControl
            此方法用于设置缓存控制头（cache-control header），CacheControl是一个封装了缓存策略的类。例如：
            CacheControl cc = CacheControl.maxAge(30, TimeUnit.DAYS).cachePublic();
            registry.addResourceHandler("/resources/**").addResourceLocations("classpath:/static/")
                    .setCacheControl(cc);
            说明：这将指示浏览器缓存静态资源30天，并且它们是public缓存，意味着中间代理服务器也可以缓存资源。
        ③：setCachePeriod
            该方法用于设置静态资源缓存时间，参数类型为Duration类型。如：
            registry.addResourceHandler("/resources/**").addResourceLocations("classpath:/static/")
                    .setCachePeriod(Duration.ofMinutes(5));
            说明：静态资源缓存的过期时间为5分钟
        ④：setOptimizeLocations
            此方法用于启用或禁用位置优化。如果启用位置优化，则将优化静态资源的位置，以便并发访问静态资源时可以获得更好的性能。
            默认情况下，位置优化是禁用的。
        ⑤：setUseLastModified
            此方法用于启用或禁用上次修改时间检查（last-modified check）。如果启用上次修改时间检查，则在每个请求中发送一
            个if-modified-since头，以检查是否需要返回新内容。默认情况下，上次修改时间检查是启用的。
        ⑥：resourceChain
            用于开启或关闭ResourceChain模式。当开启ResourceChain模式时，每个资源文件都会自动添加版本号，避免浏览器缓存问题。
            例如：registry.addResourceHandler("/resources/**").addResourceLocations("classpath:/static/")
                    .resourceChain(true);
            请注意，要使ResourceChain生效，还需要设置addResolver
            如：.resourceChain(false)
                // 添加VersionResourceResolver，且指定版本号
                .addResolver(new VersionResourceResolver()
                        .addFixedVersionStrategy("1.0.0", "/**"));
                下次访问地址：http://localhost:8881/resources/1.0.0/xxx.css

![d62737287f3c35cff50f788c043b9261.gif][]

![ae690e1f2dfeb87f70e7f69d12f75ddf.gif][]

**示例代码 配置静态资源处理**

其实还有许许多多的配置信息，后面会慢慢补充。

[API_6.0.9]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/
[c1b208da1f20334fce3953396cd9caa9.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/05fe1b40509144669f7b379fe4221494.png
[b467d55695c637c172834c57ef86790c.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/fafd25ca8c1b46ae99270ff8d3e7bef9.png
[4594744f90c5b2173b301686c71f4cfd.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1282afe66829408aa793b3b33ad6aa84.png
[43403af754b1b5b90e609495770f73ea.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/c4f00f94730a46bdae878018c00a0be0.png
[a6498345eebf36f2c8d9ac3706bee5bd.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/a0b6293f69d140ad81e3150adb492336.png
[1977c9bf1531ff79fff09bad034ecb6c.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/a5695b90eb0749b5b70d188640c7fdd8.png
[Link 1]: https://www.cnblogs.com/antLaddie/p/17444915.html#_labelTop
[786479aadd06daa912bfd48e6a05a35f.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/effadbc5bf8c4f4a9f4fd499d85cb77a.png
[470831e0666682136ddb716dbd20c3b2.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/3a94c2b2859e4b61883f3f66e0c79006.png
[00ac397d66769e68e7b7217875f0ac0f.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/17f00c8f44da4e7cae288f275f2efb61.png
[526f92e70b9467f8dd58662541e772ee.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/654bcc53296c4fe48f9048b7dbbecf68.png
[796044606d628a1d2330a507972744aa.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5a7f7ea3d1a64c2daf6332aa5b4bca3f.png
[01b17fa285eaa1935d3785971fdeab92.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f3132aabb13a4d64890017c1058bd5a6.png
[SpringBoot]: https://www.cnblogs.com/antLaddie/p/14751540.html
[07e1a8f3ce355ab8b78d5746bcae78a2.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/e3e6e931c842489799b1215bd5430d62.png
[d463849b400b14e9439fdd95d8b6c7f9.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/06d4251cf0444ae09cb295da40cf9a72.png
[d8797d71fc15380c1d14df9bc3064de6.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/c44e5e0e852e4e07af92b4f714fda60e.png
[738e71147a857492bc935f0fbba0769d.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/187b4017f4d74347b89dc5d2e80989e9.png
[defd8e974a67b266e0684e05d65019c9.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/e3d9de14420648e1bf6ad05947e440aa.png
[3df0a6906ec3fc51de5c3f9bad12a54a.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/7bafb09d7d1048e7883240efd133b5c3.png
[4608bb9785937dd11a27b849206b3688.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1d1a4b7ed9a24b908434bdb0449f3012.png
[324cf0f78f78ba7d139c435c563338bd.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/2b151634f11a448daae1400318100874.png
[65ba996606634d47a6d771fc9537dc53.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/52d002d65b3342dcb386fd7b632ca3f2.png
[d62737287f3c35cff50f788c043b9261.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/fc9e585b8a7940909870845cf4764f24.png
[ae690e1f2dfeb87f70e7f69d12f75ddf.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/29bf0e825dd640c58d4c8b27a1054e86.png