SpringBoot对Spring MVC的会进行自动配置,这些默认的配置可以满足我们的大部分需求,但是我们对Spring MVC有时往往会有一些自己的需求定制。 我们也可以通过自定义配置类(标注 @Configuration注解 的类)并实现 WebMvcConfigurer 接口来定制 Spring MVC 配置,例如拦截器、格式化程序、视图控制器等等。
WebMvcConfigurer 是一个基于 Java 8 的接口,该接口定义了许多与 Spring MVC 相关的方法,其中大部分方法都是 default 类型的,且都是空实现。因此我们只需要定义一个配置类实现 WebMvcConfigurer 接口,并重写相应的方法便可以定制 Spring MVC 的配置。
WebMvcConfigurer常用的方法如下表所示:
在SpringBoot项目中,我们可以通过拓展SpringMVC和全面接管Spring MVC这两种方式来定制Spring MVC.
拓展Spring MVC
如果SpringBoot对Spring MVC的自动配置不能满足我们的需求的话,我们还可以通过实现 WebMvcConfigurer接口的配置类,并加上@Configuration 注解来拓展Spring MVC。这样不仅能够保留Spring Boot的Spring MVC的自动的默认配置,还可以额外增加自己的配置。
下面来演示一下:启动 Spring Boot,访问http://localhost:8080/login、http://localhost:8080/、http://localhost:8080/index3 个 URL 都能跳转到登陆页 login.html。
假如我们要实现这样的一个功能:
创建一个任意名字的Spring Boot 项目,我这里叫demo01 ,然后创建一个config包,里面创建一个MyMvcConfig的类,这个类实现了WebMvcConfigurer接口。
在静态资源目录下创建两个html页面,分别时index.html和login.html :
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>index</title> </head> <body> <h1>首页</h1> </body> </html>
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>index</title> </head> <body> <h1>首页</h1> </body> </html>
然后我们编写配置类
package com.example.demo01.config; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class MyMvcConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry){ //当访问 “/” 或 “/index.html” 时,都直接跳转到登陆页面 registry.addViewController("/").setViewName("login"); registry.addViewController("/index").setViewName("login"); } }
我们再编写一个controller:
@GetMapping("/login") public String loginPage(){ return "forward:/login.html"; }
好的,我们运行一下我们的项目,会发现您会发现“http://localhost:8080/login”、“http://localhost:8080/”“http://localhost:8080/index”3 个 URL 都会返回login,如下所示:
全面接管Spring MVC
这个用法其实用得非常少,大家了解一下就好了。
再一些特殊的情况下,我们可能先要抛弃Spring Boot对Spring Boot的全部的自动配置,完全接管Spring MVC。此时我们可以自定义一个WebMvcConfigurer 的配置类,并在该类上标注@EnableWebMvc 注解。来实现完全接管Spring MVC 。(注意:完全接管Spring MVC后,SpringBoot对Spring MVC的自动配置将要全部失效。并且我们还要知道,Spring Boot 能够访问位于静态资源文件夹中的静态文件,这是因为 Spring Boot 对 Spring MVC 的默认自动配置中定义的,当我们全面接管 Spring MVC 后,Spring Boot 对 Spring MVC 的默认配置都会失效,此时再访问静态资源文件夹中的静态资源就会报 404 错误。)
下面举一个例子来演示如何使用:
1.在 MyMvcConfig 配置类上标注 @EnableWebMvc,除此之外其他文件都不做任何修改,代码如下。
package com.example.demo01.config; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; //实现 WebMvcConfigurer 接口可以来扩展 SpringMVC 的功能 // 完全接管SpringMVC @EnableWebMvc @Configuration public class MyMvcConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry){ //当访问 “/” 或 “/index.html” 时,都直接跳转到登陆页面 registry.addViewController("/").setViewName("login"); registry.addViewController("/index").setViewName("login"); } }
好的,我们运行一下我们的项目,会发现您会发现“http://localhost:8080/login”、“http://localhost:8080/”“http://localhost:8080/index”3 个 URL 都会返回500或404。通过在properties中配置静态资源路径,可以解决这个问题。但我们最好还是不要使用这个方式,因为他会把SpringMVC得默认配置都给失效,会产生很多的bug。