玩转springboot之springboot扩展SpringMVC

news2024/7/2 21:15:22

springboot扩展SpringMVC

springboot为springmvc提供了很多自动配置，虽然适用于大部分应用，但是不一定适合你的应用

WebMvcConfigurer

WebMvcConfigurer是用来全局定制化Spring boot的MVC特性，可以通过实现WebMvcConfigurer接口来配置应用的MVC全局特性，但是由于该接口方法很多，全部实现比较麻烦，所以一般是继承WebMvcConfigurerAdapter类，该类实现了WebMvcConfigurer接口，并全部提供了空实现，可以选择需要自定义的来进行重写的

WebMvcConfigurerAdapter类在springboot2.x中就不建议使用了，因为java8中接口可以存在default方法，使得WebMvcConfigurerAdapter没有意义，直接实现WebMvcConfigurer接口即可

既保留自动配置又有扩展配置

根据官网的描述，如果想要扩展SpringBoot对于SpringMVC的配置而又保留SpringBoot对SpringMVC的自动配置，可以编写一个配置类（@Configuration）继承WebMvcConfigurerAdapter类，但是不能标注@EnableWebMvc

如果是使用的springmvc框架而非springboot框架的话，必须有@EnableWebMvc注解，否则重写WebMvcConfigurerAdapter的方法无效

@Configuration
public class MyMvcConfig extends WebMvcConfigurerAdapter {

    // 配置拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        super.addInterceptors(registry);
    }
    
    // 时间、数字格式化
    @Override
    public void addFormatters(FormatterRegistry registry) {
    }
    
    // 消息解析器
   // 对应xml中的 <mvc:annotation-driven>
    //    <mvc:message-converters register-defaults="true">
    //        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
    //            <constructor-arg value="UTF-8"/>
    //        </bean>
    //    </mvc:message-converters>
    //</mvc:annotation-driven>
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    }

    // 验证器  用以处理所有注解了@Valid的元素或注解了@Validated 的控制器方法参数
    @Override
    public Validator getValidator() {
        return null;
    }
  
   // 静态资源过滤
   // 对应xml 中的 <mvc:resources location="/WEB-INF/templates/" mapping="/templates/**"/>
   @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
    }
   
  // 视图解析器 
  // 对应于在xml中配置 viewResolver的bean
   @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
    }
    
}

原因

为什么继承WebMvcConfigurerAdapter就可以扩展springmvc的配置呢?

在WebMvcAutoConfiguration类中有一个bean是WebMvcAutoConfigurationAdapter

 @Configuration
 @Import(EnableWebMvcConfiguration.class)
 @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
 public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {

使用@Import来引入的这个组件中有一个方法，会将所有的WebMvcConfigurer类都加入到configurers中

public void setConfigurers(List<WebMvcConfigurer> configurers) {
  if (!CollectionUtils.isEmpty(configurers)) {
   this.configurers.addWebMvcConfigurers(configurers);
  }
 }

而WebMvcConfigurerAdapter就实现于WebMvcConfigurer

public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {

使用自定义配置抛弃自动配置

在上述配置类上加上@EnableWebMvc注解，就可以完全取代springboot对于springmvc的自动配置

原因

至于为什么会这样，看一下@EnableWebMvc这个注解就知道了

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}

这个注解会引入一个DelegatingWebMvcConfiguration组件，而这个类是继承自WebMvcConfigurationSupport

@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {

接下来看一下WebMvcAutoConfiguration的加载条件是什么

@Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
  WebMvcConfigurerAdapter.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
  ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {