SpringBoot自动配置入门

news2025/1/10 2:34:39

文章目录

前言
自动包规则原理及初始化自动配置
- 1.@SpringBootConfiguration
- 2.@ComponentScan
- 3.@EnableAutoConfiguration
- - （1）@AutoConfigurationPackage
  - （2）@Import(AutoConfigurationImportSelector.class)
- 4.修改默认配置
总结（自动配置流程）

前言

入门SpringBoot的自动配置：自动包规则原理、初始加载自动配置类、自动配置流程。

自动包规则原理及初始化自动配置

SpringBoot的启动类：

@SpringBootApplication
public class MainApplication {

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

}

我们就从启动类去分析了解自动配置。
进入@SpringBootApplication内部（双击@SpringBootApplication选中，然后ctrl+鼠标左键），可以看到如下：
在这里插入图片描述

重点分析@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan。

1.@SpringBootConfiguration

进入@SpringBootConfiguration内部：

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

可以看到里面有@Configuration（代表当前是一个配置类），@Target({ElementType.TYPE})（说明该注解作用在类上）等等。注解末尾的Configuration其实就能表明它是配置类，从这可以看出@SpringBootConfiguration就是一个声明是SpringBoot的配置类。

2.@ComponentScan

这个注解在Spring的学习中，大家应该早就接触到了。
它指定扫描哪些文件。

3.@EnableAutoConfiguration

进入@EnableAutoConfiguration：

@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，@Import(AutoConfigurationImportSelector.class)。

（1）@AutoConfigurationPackage

标签名直译为：自动配置包，指定了默认的包规则。
进入@AutoConfigurationPackage：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({AutoConfigurationPackages.Registrar.class})给容器中导入一个组件
public @interface AutoConfigurationPackage {
    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};
}

进入AutoConfigurationPackages.Registrar.class：

       PackageImports(AnnotationMetadata metadata) {
            AnnotationAttributes attributes = AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(AutoConfigurationPackage.class.getName(), false));
            List<String> packageNames = new ArrayList(Arrays.asList(attributes.getStringArray("basePackages")));
            Class[] var4 = attributes.getClassArray("basePackageClasses");
            int var5 = var4.length;

            for(int var6 = 0; var6 < var5; ++var6) {
                Class<?> basePackageClass = var4[var6];
                packageNames.add(basePackageClass.getPackage().getName());
            }

            if (packageNames.isEmpty()) {
                packageNames.add(ClassUtils.getPackageName(metadata.getClassName()));
            }

            this.packageNames = Collections.unmodifiableList(packageNames);
        }

        List<String> getPackageNames() {
            return this.packageNames;
        }

        public boolean equals(Object obj) {
            return obj != null && this.getClass() == obj.getClass() ? this.packageNames.equals(((PackageImports)obj).packageNames) : false;
        }

        public int hashCode() {
            return this.packageNames.hashCode();
        }

        public String toString() {
            return "Package Imports " + this.packageNames;
        }
    }

    static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
        Registrar() {
        }

        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            AutoConfigurationPackages.register(registry, (String[])(new PackageImports(metadata)).getPackageNames().toArray(new String[0]));
        }

        public Set<Object> determineImports(AnnotationMetadata metadata) {
            return Collections.singleton(new PackageImports(metadata));
        }
    }

利用Registrar给容器中导入一系列组件。
将指定的一个包下的所有组件导入进MainApplication所在包下。

（2）@Import(AutoConfigurationImportSelector.class)

进入AutoConfigurationImportSelector.class：

利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件
调用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
利用工厂加载 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader);得到所有的组件
从META-INF/spring.factories位置来加载一个文件。
- 默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
- spring-boot-autoconfigure-3.1.2.jar包里面也有META-INF/spring.factories

在这里插入图片描述

文件里面写死了spring-boot一启动就要给容器中加载的所有配置类
spring-boot-autoconfigure-3.1.2.jar/META-INF/spring.factories
# Auto Configure (127个)
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
...

虽然我们127个场景的所有自动配置启动的时候默认全部加载，但是xxxxAutoConfiguration按照条件装配规则（@Conditional），最终会按需配置。

如AopAutoConfiguration类：
只有配置文件中满足以下条件，才会注册组件。
在这里插入图片描述
所以上诉的讲诉，总结：@EnableAutoConfiguration是告知应用启动的时候需要扫描依赖包中需要实例化的类的注解

4.修改默认配置

以DispatcherServletAutoConfiguration的内部类DispatcherServletConfiguration为例子:

@Bean
@ConditionalOnBean(MultipartResolver.class)  //容器中有这个类型组件
@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //容器中没有这个名字 multipartResolver 的组件
public MultipartResolver multipartResolver(MultipartResolver resolver) {
	//给@Bean标注的方法传入了对象参数，这个参数的值就会从容器中找。
	//SpringMVC multipartResolver。防止有些用户配置的文件上传解析器不符合规范
	// Detect if the user has created a MultipartResolver but named it incorrectly
	return resolver;//给容器中加入了文件上传解析器；
}