Spring Boot自动配置原理-阿里云开发者社区

Spring Boot自动配置原理

2024-02-22 48

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： Spring Boot自动配置原理

首先我们看下Spring Boot Starter的Maven依赖，在图中不用想我们就可以才出来自动配置一定主要是由spring-boot-autoconfigure模快来实现的，由此，我们着重研究spring-boot-autoconfigure的原理就可以推断出Spring Boot的自动配置原理，Start！

@SpringBootApplication注解依赖图

1 开启自动配置

开启自动配置主要是由@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 {};
}

很容易我们发现在这里它导入了一个AutoConfigurationImportSelector的类，点进去看下

他有几个很重要的方法，粘贴下：

/**
 * 判断是否开启自动配置，直接返回true
 */
protected boolean isEnabled(AnnotationMetadata metadata) {
    if (getClass() == AutoConfigurationImportSelector.class) {
        return getEnvironment().getProperty(
            EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class,
            true);
    }
    return true;
}
/**
 * 返回应该考虑的自动配置类名. 默认情况下该方法将使用 {@link SpringFactoriesLoader} 
 */
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
                                                  AnnotationAttributes attributes) {
    // 这一步非常重要，加载Spring Boot自动配置的核心文件
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
        getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
    Assert.notEmpty(configurations,
                    "No auto configuration classes found in META-INF/spring.factories. If you "
                    + "are using a custom packaging, make sure that file is correct.");
    return configurations;
}
/**
 * 检查排除的自动配置类
 */
private void checkExcludedClasses(List<String> configurations,
                                  Set<String> exclusions) {
    List<String> invalidExcludes = new ArrayList<>(exclusions.size());
    for (String exclusion : exclusions) {
        if (ClassUtils.isPresent(exclusion, getClass().getClassLoader())
            && !configurations.contains(exclusion)) {
            invalidExcludes.add(exclusion);
        }
    }
    if (!invalidExcludes.isEmpty()) {
        handleInvalidExcludes(invalidExcludes);
    }
}

我们顺藤摸瓜，看下SpringFactoriesLoader类

public final class SpringFactoriesLoader {
    public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
    private static final Log logger = LogFactory.getLog(SpringFactoriesLoader.class);
    private static final Map<ClassLoader, MultiValueMap<String, String>> cache = new ConcurrentReferenceHashMap();
}

直接看到了加载的核心配置文件META-INF/spring.factories，然后其他两个属性分别是日志和缓存的声明

我们再简单的看下spring.factories文件

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener
......