SpringBoot-@SpringBootApplication自动配置

喜欢ヅ旅行 2024-05-24 01:34 23阅读 0赞

> 本文介绍SpringBoot的自动配置

#### 文章目录 ####

*  前言
 *  @SpringBootApplication
 *   *  @SpringBootConfiguration
     *   *  @Configuration
     *  @EnableAutoConfiguration
     *   *  @AutoConfigurationPackage
         *  @Import

## 前言 ##

@SpringBootApplication一般放在项目的一个启动类上，用来把启动类注入到容器中，此外定义了容器扫描的范围。  
程序的入口如下：

@SpringBootApplication
    public class PushServerApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(PushServerApplication.class,args);
        }
    }

## @SpringBootApplication ##

@SpringBootApplication注解主要包装了@SpringBootConfiguration @EnableAutoConfiguration和@ComponentScan注解。

*  @SpringBootConfiguration：包装了@Configuration ，用于将组件添加到容器中
 *  @EnableAutoConfiguration：扫描@ComponentScan指定的路径下的类，添加到IOC。另外，将META-INF/spring.factories中定义的bean 添加到 IoC 容器中。
 *  @ComponentScan：主要用来指定扫描容器的范围，默认扫描启动类所在的包路径下的类

package org.springframework.boot.autoconfigure;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Inherited;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    import org.springframework.beans.factory.support.BeanNameGenerator;
    import org.springframework.boot.SpringBootConfiguration;
    import org.springframework.boot.context.TypeExcludeFilter;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.FilterType;
    import org.springframework.context.annotation.ComponentScan.Filter;
    import org.springframework.core.annotation.AliasFor;
    
    @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 {
        
        @AliasFor(
            annotation = EnableAutoConfiguration.class
        )
        Class<?>[] exclude() default {
        };
    
        @AliasFor(
            annotation = EnableAutoConfiguration.class
        )
        String[] excludeName() default {
        };
    
        @AliasFor(
            annotation = ComponentScan.class,
            attribute = "basePackages"
        )
        String[] scanBasePackages() default {
        };
    
        @AliasFor(
            annotation = ComponentScan.class,
            attribute = "basePackageClasses"
        )
        Class<?>[] scanBasePackageClasses() default {
        };
    
        @AliasFor(
            annotation = ComponentScan.class,
            attribute = "nameGenerator"
        )
        Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
    
        @AliasFor(
            annotation = Configuration.class
        )
        boolean proxyBeanMethods() default true;
    }

### @SpringBootConfiguration ###

@SpringBootConfiguration是对@Configuration的封装，功能和@Configuration一致。  
并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Configuration
    @Indexed
    public @interface SpringBootConfiguration {
        
        @AliasFor(
            annotation = Configuration.class
        )
        boolean proxyBeanMethods() default true;
    }

#### @Configuration ####

@Configuration 可以理解为一个Configuration就是对应的一个Spring的xml版的容器；（beans）@Component和@Bean是两种使用注解来定义bean的方式。

*  @Component（@Service或@Repository）用于自动检测和使用类路径扫描自动配置bean。注释类和bean之间存在隐式的**一对一映射**（即每个类一个bean）。
 *  @Bean用于显式声明单个bean，而不是让Spring像上面那样自动执行它。它将bean的声明与类定义分离，并允许您精确地创建和配置bean。

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Component
    public @interface Configuration {
        
        @AliasFor(
            annotation = Component.class
        )
        String value() default "";
    
        boolean proxyBeanMethods() default true;
    }

### @EnableAutoConfiguration ###

*  开启Spring上下文的自动配置，尽可能去加载需要的配置Beans。自动配置类，一般是根据你的classpath路径来应用的。
 *  默认EnableAutoConfiguration扫描的是当前启用注解的Class对象的目录作为root目录。所以这个目录下的所有子目录都会被扫描。
 *  通过exclude()传入Class类型，excludeName() 传入名称来排除其他类型的加载。自动加载的配置始终是在普通用户定义的Bean加载之后执行。

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import({
        AutoConfigurationImportSelector.class})
    public @interface EnableAutoConfiguration {
        
        String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    
        Class<?>[] exclude() default {
        };
    
        String[] excludeName() default {
        };
    }

#### @AutoConfigurationPackage ####

将 Registrar 类导入到容器中，而 Registrar 类作用是**扫描主配置类同级目录及其子包**，并将相应的组件导入到 Springboot创建管理容器中。

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @Import({
        Registrar.class})
    public @interface AutoConfigurationPackage {
        
        String[] basePackages() default {
        };
    
        Class<?>[] basePackageClasses() default {
        };
    }

#### @Import ####

@Import通过将 AutoConfigurationImportSelector 类导入到容器中，AutoConfigurationImportSelector 类作用是通过selectImports方法中，使用内部工具类SpringFactoriesLoader查找 classpath 上所用 jar 包中的 MATE-INF/spring.factories 进行加载， 实现将配置类信息交给 SpringFactory 加载器进行一系列的容器创建过程。

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
        
        Class<?>[] value();
    }