快捷導(dǎo)航

使用springboot自動(dòng)配置源碼解讀

更新時(shí)間：2024年11月07日 15:24:51 作者：阿勝yss

自動(dòng)裝配是Spring Boot的一個(gè)核心特性,允許程序員在開發(fā)中更加專注于業(yè)務(wù)邏輯,而不是花費(fèi)大量的時(shí)間去配置和管理第三方組件,當(dāng)開發(fā)者在pom.xml文件中添加了某個(gè)依賴后,Spring Boot通過自動(dòng)配置的方式,將這些第三方組件的實(shí)例自動(dòng)注入到IOC容器中

什么是自動(dòng)裝配

當(dāng)我們程序依賴第三方功能組件時(shí)，不需要手動(dòng)將這些組件類加載到IOC容器中。

例如當(dāng)程序需要用到redis時(shí)，在pom.xml文件中引入依賴，然后使用依賴注入的方式直接從IOC容器中拿到相應(yīng)RedisTemplate實(shí)例。

@SpringBootApplication 作用

@SpringBootConfiguration：主啟動(dòng)類可以當(dāng)做配置類使用，比如注入Bean等。
@ComponentScan：包掃描注解。
@EnableAutoConfiguration(重要)：開啟自動(dòng)配置。

@EnableAutoConfiguration

@AutoConfigurationPackage : 自動(dòng)配置包注解，默認(rèn)將主配置類(@SpringBootApplication)所在的包及其子包里面的所有組件掃描到IOC容器中。
@Import : 引入相應(yīng)的自動(dòng)裝配類，這里是導(dǎo)入了AutoConfigurationImportSelector類，從所有的spring.factories 文件注入自動(dòng)配置類到IOC容器。

@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 引入 Registrar配置類

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

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

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;
	// 獲取basePackageClasses屬性的屬性值，并且對(duì)于的包名放入packageNames列表中
    for(int var6 = 0; var6 < var5; ++var6) {
        Class<?> basePackageClass = var4[var6];
        packageNames.add(basePackageClass.getPackage().getName());
    }

    if (packageNames.isEmpty()) {
    // 如果packageNames為空，就將AutoConfigurationPackage注解標(biāo)注的類所在的包名作為packageNames
        packageNames.add(ClassUtils.getPackageName(metadata.getClassName()));
    }

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

@Import(AutoConfigurationImportSelector.class)

直接給到最終代碼邏輯 getAutoConfigurationEntry 方法

// 判斷是否開啟自動(dòng)配置
if (!this.isEnabled(annotationMetadata)) {
    return EMPTY_ENTRY;
} else {
    // 獲取注解屬性
    AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
    // 從 spring.factories 文件中獲取自動(dòng)配置類
    List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
    // 去掉重復(fù)的自動(dòng)配置類
    configurations = this.removeDuplicates(configurations);
    // 根據(jù)注解配置 排除自動(dòng)配置類
    Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
    this.checkExcludedClasses(configurations, exclusions);
    configurations.removeAll(exclusions);
    configurations = this.getConfigurationClassFilter().filter(configurations);
    this.fireAutoConfigurationImportEvents(configurations, exclusions);
    return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
}