springboot3meven统一管理

转载

mob64ca13f96cda 2024-11-07 10:02:17

文章标签 mvc spring spring boot MVC 拦截器 文章分类 架构后端开发

前言

自从用了Spring Boot是否有一个感觉，以前MVC的配置都很少用到了，比如视图解析器，拦截器，过滤器等等，这也正是Spring Boot好处之一。

但是往往Spring Boot提供默认的配置不一定适合实际的需求，因此需要能够定制MVC的相关功能，这篇文章就介绍一下如何扩展和全面接管MVC。

Spring Boot 版本

本文基于的Spring Boot的版本是2.3.4.RELEASE。

如何扩展MVC？

在这里需要声明一个前提：配置类上没有标注@EnableWebMvc并且没有任何一个配置类继承了WebMvcConfigurationSupport。至于具体原因，下文会详细解释。

扩展MVC其实很简单，只需要以下步骤：

创建一个MVC的配置类，并且标注@Configuration注解。
实现WebMvcConfigurer这个接口，并且实现需要的方法。

WebMvcConfigurer这个接口中定义了MVC相关的各种组件，比如拦截器，视图解析器等等的定制方法，需要定制什么功能，只需要实现即可。

在Spring Boot之前的版本还可以继承一个抽象类WebMvcConfigurerAdapter，不过在2.3.4.RELEASE这个版本中被废弃了，如下：

@Deprecated
public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {}

举个栗子：现在要添加一个拦截器，使其在Spring Boot中生效，此时就可以在MVC的配置类重写addInterceptors()方法，如下：

/**
 * MVC扩展的配置类，实现WebMvcConfigurer接口
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private RepeatSubmitInterceptor repeatSubmitInterceptor;

    /**
     * 重写addInterceptors方法，注入自定义的拦截器
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(repeatSubmitInterceptor).excludePathPatterns("/error");
    }
}

操作很简单，除了拦截器，还可以定制视图解析，资源映射处理器等等相关的功能，和Spring MVC很类似，只不过Spring MVC是在XML文件中配置，Spring Boot是在配置类中配置而已。

什么都不配置为什么依然能运行MVC相关的功能？

早期的SSM架构中想要搭建一个MVC其实挺复杂的，需要配置视图解析器，资源映射处理器，DispatcherServlet等等才能正常运行，但是为什么Spring Boot仅仅是添加一个WEB模块依赖即能正常运行呢？依赖如下：

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

其实这已经涉及到了Spring Boot高级的知识点了，在这里就简单的说一下，Spring Boot的每一个starter都会有一个自动配置类，什么是自动配置类呢？自动配置类就是在Spring Boot项目启动的时候会自动加载的类，能够在启动期间就配置一些默认的配置。WEB模块的自动配置类是WebMvcAutoConfiguration。

WebMvcAutoConfiguration这个配置类中还含有如下一个子配置类WebMvcAutoConfigurationAdapter，如下：

@Configuration(proxyBeanMethods = false)
 @Import(EnableWebMvcConfiguration.class)
 @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
 @Order(0)
 public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {}

WebMvcAutoConfigurationAdapter这个子配置类实现了WebMvcConfigurer这个接口，这个正是MVC扩展接口，这个就很清楚了。自动配置类是在项目启动的时候就加载的，因此Spring Boot会在项目启动时加载WebMvcAutoConfigurationAdapter这个MVC扩展配置类，提前完成一些默认的配置（比如内置了默认的视图解析器，资源映射处理器等等），这也就是为什么没有配置什么MVC相关的东西依然能够运行。

如何全面接管MVC？【不推荐】

全面接管MVC是什么意思呢？全面接管的意思就是不需要Spring Boot自动配置，而是全部使用自定义的配置。

全面接管MVC其实很简单，只需要在配置类上添加一个@EnableWebMvc注解即可。还是添加拦截器，例子如下：

/**
 * @EnableWebMvc：全面接管MVC，导致自动配置类失效
 */
@Configuration
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private RepeatSubmitInterceptor repeatSubmitInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //添加拦截器
        registry.addInterceptor(repeatSubmitInterceptor).excludePathPatterns("/error");
    }
}

一个注解就能全面接口MVC，是不是很爽，不过，不建议使用。

为什么@EnableWebMvc一个注解就能够全面接管MVC？

what？？？为什么呢？上面刚说过自动配置类WebMvcAutoConfiguration会在项目启动期间加载一些默认的配置，这会怎么添加一个@EnableWebMvc注解就不行了呢？ springboot3meven统一管理_MVC

其实很简单，@EnableWebMvc源码如下：

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

其实重要的就是这个@Import(DelegatingWebMvcConfiguration.class)注解了，Spring中的注解，快速导入一个配置类DelegatingWebMvcConfiguration，源码如下：

@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {}

明白了，@EnableWebMvc这个注解实际上就是导入了一个WebMvcConfigurationSupport子类型的配置类而已。

而WEB模块的自动配置类有这么一行注解@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，源码如下：

前言

自从用了Spring Boot是否有一个感觉，以前MVC的配置都很少用到了，比如视图解析器，拦截器，过滤器等等，这也正是Spring Boot好处之一。

但是往往Spring Boot提供默认的配置不一定适合实际的需求，因此需要能够定制MVC的相关功能，这篇文章就介绍一下如何扩展和全面接管MVC。

Spring Boot 版本

本文基于的Spring Boot的版本是2.3.4.RELEASE。

如何扩展MVC？

扩展MVC其实很简单，只需要以下步骤：

创建一个MVC的配置类，并且标注@Configuration注解。
实现WebMvcConfigurer这个接口，并且实现需要的方法。

WebMvcConfigurer这个接口中定义了MVC相关的各种组件，比如拦截器，视图解析器等等的定制方法，需要定制什么功能，只需要实现即可。

在Spring Boot之前的版本还可以继承一个抽象类WebMvcConfigurerAdapter，不过在2.3.4.RELEASE这个版本中被废弃了，如下：

@Deprecated
public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {}

举个栗子：现在要添加一个拦截器，使其在Spring Boot中生效，此时就可以在MVC的配置类重写addInterceptors()方法，如下：

/**
 * MVC扩展的配置类，实现WebMvcConfigurer接口
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private RepeatSubmitInterceptor repeatSubmitInterceptor;

    /**
     * 重写addInterceptors方法，注入自定义的拦截器
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(repeatSubmitInterceptor).excludePathPatterns("/error");
    }
}

什么都不配置为什么依然能运行MVC相关的功能？

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

WebMvcAutoConfiguration这个配置类中还含有如下一个子配置类WebMvcAutoConfigurationAdapter，如下：

@Configuration(proxyBeanMethods = false)
 @Import(EnableWebMvcConfiguration.class)
 @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
 @Order(0)
 public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {}

如何全面接管MVC？【不推荐】

全面接管MVC是什么意思呢？全面接管的意思就是不需要Spring Boot自动配置，而是全部使用自定义的配置。

全面接管MVC其实很简单，只需要在配置类上添加一个@EnableWebMvc注解即可。还是添加拦截器，例子如下：

/**
 * @EnableWebMvc：全面接管MVC，导致自动配置类失效
 */
@Configuration
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private RepeatSubmitInterceptor repeatSubmitInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //添加拦截器
        registry.addInterceptor(repeatSubmitInterceptor).excludePathPatterns("/error");
    }
}

一个注解就能全面接口MVC，是不是很爽，不过，不建议使用。

为什么@EnableWebMvc一个注解就能够全面接管MVC？

what？？？为什么呢？上面刚说过自动配置类WebMvcAutoConfiguration会在项目启动期间加载一些默认的配置，这会怎么添加一个@EnableWebMvc注解就不行了呢？ springboot3meven统一管理_mvc_02

其实很简单，@EnableWebMvc源码如下：

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

其实重要的就是这个@Import(DelegatingWebMvcConfiguration.class)注解了，Spring中的注解，快速导入一个配置类DelegatingWebMvcConfiguration，源码如下：

@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {}

明白了，@EnableWebMvc这个注解实际上就是导入了一个WebMvcConfigurationSupport子类型的配置类而已。

而WEB模块的自动配置类有这么一行注解@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，源码如下：

@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
  ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {

这个注解@ConditionalOnMissingBean什么意思呢？简单的说就是IOC容器中没有指定的Bean这个配置才会生效。

一切都已经揭晓了，@EnableWebMvc导入了一个WebMvcConfigurationSupport类型的配置类，导致了自动配置类WebMvcAutoConfiguration标注的@@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)判断为false了，从而自动配置类失效了。

这个注解@ConditionalOnMissingBean什么意思呢？简单的说就是IOC容器中没有指定的Bean这个配置才会生效。

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：responseBody 怎么判断返回的内容为空

下一篇：pytorch 扩充3维张量用0填充

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯