Spring boot 梳理 -@SpringBootApplication@EnableAutoConfiguration与（@EnableWebMVCWebMvcConfigurationSu(代

Posted 手握太阳

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring boot 梳理 -@SpringBootApplication@EnableAutoConfiguration与（@EnableWebMVCWebMvcConfigurationSu(代相关的知识，希望对你有一定的参考价值。

  1. @EnableWebMvc=继承DelegatingWebMvcConfiguration=继承WebMvcConfigurationSupport
    1. 直接看源码,@EnableWebMvc实际上引入一个DelegatingWebMvcConfiguration　　
      1. @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({DelegatingWebMvcConfiguration.class})
public @interface EnableWebMvc {
}

         

      2. DelegatingWebMvcConfiguration继承了WebMvcConfigurationSupport
        1. @Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
...

    2. @EnableWebMvc,WebMvcConfigurationSupport,WebMvcConfigurer和WebMvcConfigurationAdapter使用

      1. Java8给出了新的特性，使得接口方法可以拥有默认实现。所以你现在可以直接实现WebMvcConfigurer而不用像以前那样通过继承它的实现类来达到目的。

      2. WebMvcConfigurationAdapter已经废弃，最好用implements WebMvcConfigurer代替

        @Configuration
public class MyConfig implements WebMvcConfigurer {
    
}

        如果使用继承,WebMvcConfigurationSupport，DelegatingWebMvcConfiguration，或者使用@EnableWebMvc，

        需要注意会覆盖application.properties中关于WebMvcAutoConfiguration的设置，需要在自定义配置中实现，如

        springboot2.0、spring5.0 拦截器配置WebMvcConfigurerAdapter过时使用WebMvcConfigurationSupport来代替 新坑

        示例如下

        Configuration
@EnableWebMvc
public class MyConfig implements WebMvcConfigurer {

}
        @Configuration
public class MyConfig extends WebMvcConfigurationSupport {

}
        @Configuration
public class MyConfig extends DelegatingWebMvcConfiguration {

}
        上面代码中需要在类中实现关于WebMvcAutoConfiguration的配置，而不是在application.properties中。
      3. 总结

        implements WebMvcConfigurer ： 不会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
        @EnableWebMvc + implements WebMvcConfigurer ： 会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
        extends WebMvcConfigurationSupport ：会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
        extends DelegatingWebMvcConfiguration ：会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
        只要使用@EnableWebMvc（隐式使用WebMvcConfigurationSupport）或显示使用WebMvcConfigurationSupport

就会屏蔽springboot的@EnableAutoConfiguration中的设置

         

         
        @EnableWebMvc=WebMvcConfigurationSupport，使用了@EnableWebMvc注解等于扩展了WebMvcConfigurationSupport但是没有重写任何方法
        @EnableWebMvc+extends WebMvcConfigurationAdapter，在扩展的类中重写父类的方法即可，这种方式会屏蔽springboot的@EnableAutoConfiguration中的设置
        extends WebMvcConfigurationSupport，在扩展的类中重写父类的方法即可，这种方式会屏蔽springboot的@EnableAutoConfiguration中的设置
        extends WebMvcConfigurationAdapter，在扩展的类中重写父类的方法即可，这种方式依旧使用springboot的@EnableAutoConfiguration中的设置

      4. 总结：大家在使用2.0版本的springboot的时候 使用WebMvcConfigurationSupport类配置拦截器时一定要重写addResourceHandlers来实现静态资源的映射,不要使用application.properties中添加配置来实现映射，不然资源会映射不成功导致打开页面资源一直加载不到。会出现下面这种奇怪的问题

      5. 扩展SpringMVC:编写一个配置类（@Configuration），是WebMvcConfigurerAdapter类型；不能标注@EnableWebMvc;

        1. 　　 
          @Configuration
// WebMvcConfigurerAdapter过时,使用WebMvcConfigurer接口
public class MyMvcConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        // 浏览器发送 /cuzz 请求来到 success
        registry.addViewController("/cuzz").setViewName("success");
    }
}

           

      6. 半全面接管SpringMVC:SpringBoot对SpringMVC的自动配置不需要了，所有都是我们自己配置；所有的SpringMVC的自动配置都失效了,我们需要在配置类中添加@EnableWebMvc即可；

        1. 　　在WebMvcConfigurationSupport（@EnableWebMvc）和@EnableAutoConfiguration这两种方式都有一些默认的设定 
          而WebMvcConfigurationAdapter则是一个abstract class
        2. //使用WebMvcConfigurerAdapter可以来扩展SpringMVC的功能
@EnableWebMvc
@Configuration
public class MyMvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
       // super.addViewControllers(registry);
        //浏览器发送 /atguigu 请求来到 success
        registry.addViewController("/atguigu").setViewName("success");
    }
}

           

  2. 　　@EnableAutoConfiguration
    1. 导入jar下面的配置文件META-INF/spring.factories
    2. @EnableAutoConfiguration是springboot项目的启动类注解@SpringBootApplication的子元素，主要功能为自动配置
    3. @EnableAutoConfiguration实际是导入了EnableAutoConfigurationImportSelector和Registrar两个类
    4. @Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
...
}
      @Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
}

       

    5. 这两个类的具体原理有些复杂，不太清除，主要内容是通过SpringFactoriesLoader.loadFactoryNames()导入jar下面的配置文件META-INF/spring.factories
      1. 在AutoConfigurationImportSelector类中可以看到通过 SpringFactoriesLoader.loadFactoryNames()
把 spring-boot-autoconfigure.jar/META-INF/spring.factories中每一个xxxAutoConfiguration文件都加载到容器中，spring.factories文件里每一个xxxAutoConfiguration文件一般都会有下面的条件注解:

    @ConditionalOnClass ： classpath中存在该类时起效
    @ConditionalOnMissingClass ： classpath中不存在该类时起效
    @ConditionalOnBean ： DI容器中存在该类型Bean时起效
    @ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
    @ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效

         

      2. SpringFactoriesLoader属于Spring框架私有的一种扩展方案(类似于Java的SPI方案java.util.ServiceLoader)，其主要功能就是从指定的配置文件META-INF/spring-factories加载配置，spring-factories是一个典型的java properties文件，只不过Key和Value都是Java类型的完整类名，比如：

         

    6. 配置文件中的内容如下
      1. # Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\\
...
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\\

         

    7. 　　其中有WebMvcAutoConfiguration,WebMvcAutoConfiguration源码如下
      1. @Configuration
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
@AutoConfigureOrder(-2147483638)
@AutoConfigureAfter({DispatcherServletAutoConfiguration.class, ValidationAutoConfiguration.class})
public class WebMvcAutoConfiguration {
...猜测，Spring boot 在此处加载 application.properties 中关于MVC的默认配置；如果@Conditional返回false，则该配置类不执行
}

         

      2. @ConditionalOnMissingBean({WebMvcConfigurationSupport.class})意思是如果存在它修饰的类的bean
        ,则不需要再创建这个bean。
      3. 由此可得出结论：
        如果有配置文件继承了DelegatingWebMvcConfiguration，
        或者WebMvcConfigurationSupport，或者配置文件有@EnableWebMvc，那么 @EnableAutoConfiguration 中的
        WebMvcAutoConfiguration 将不会被自动配置，而是使用WebMvcConfigurationSupport的配置。
  3. @SpringBootApplication
    1. @Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
...
}

       

  4. 转：https://www.cnblogs.com/sufferingStriver/p/9026764.html

以上是关于Spring boot 梳理 -@SpringBootApplication@EnableAutoConfiguration与（@EnableWebMVCWebMvcConfigurationSu(代的主要内容，如果未能解决你的问题，请参考以下文章

Spring boot 梳理 -@SpringBootApplication@EnableAutoConfiguration与（@EnableWebMVCWebMvcConfigurationSu(代

Spring Boot 梳理 - 4个核心

Spring boot 梳理 - 在bean中使用命令行参数-自动装配ApplicationArguments

Spring boot 梳理 - 代码结构（Main类的位置）

Spring boot 梳理 - 显示Springboot默认自动生成的bean

Spring Boot+Vue3 动态菜单实现思路梳理