Spring Boot自动配置原理

举报
海风极客 发表于 2022/10/16 18:22:10 2022/10/16
【摘要】 首先我们看下Spring Boot Starter的Maven依赖,在图中不用想我们就可以才出来自动配置一定主要是由spring-boot-autoconfigure模快来实现的,由此,我们着重研究spring-boot-autoconfigure的原理就可以推断出Spring Boot的自动配置原理,Start!@SpringBootApplication注解依赖图 1 开启自动配置开启自...

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1n5GBYn1-1629337256392)(Spring Boot自动配置原理.assets/image-20210818100823859.png)]

@SpringBootApplication注解依赖图

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mwQ6XuqX-1629337256395)(Spring Boot自动配置原理.assets/image-20210818105627836.png)]

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

......

发现声明了好多配置项和自动配置类,这足以说明自动配置并没有多么高大上,只是Spring团队的开发者们一步一步用各种方式实现的,致敬!

2 条件注解

在这里插入图片描述
Conditional翻译为‘有条件的’

我们挑几个重要的来讲:

  • @Conditional:按照一定的条件进行判断,满足条件给容器注册bean

  • @ConditionalOnClass:按照有无该类条件进行判断,满足条件给容器注册bean

  • @ConditionalOnBean:按照有无该Bean条件进行判断,满足条件给容器注册bean

  • @ConditionalOnMissingBean:按照有无该Bean条件进行判断,满足条件给容器注册bean

  • @ConditionalOnProperty:按照有无该Property条件进行判断,满足条件给容器注册bean

3 启动配置流程总结

在这里插入图片描述

4 总体流程图

在这里插入图片描述

【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。