springboot2.0.3源码篇

  • 时间:
  • 浏览:0

前言

  开心一刻   

    女儿: “妈妈,你如此 漂亮,当年怎么才能 会会在么在嫁给了爸爸呢?”

    妈妈: “当年你爸前会穷嘛!‘

    女儿: “穷你还嫁给他!”

    妈妈: “那过后过后毕业参加工作,领导对是我不好,他是我的扶贫对象,我年轻理解错了,就嫁给他了!”

    女儿......

@Import注解应用

  应用开发中,当让我们让我们的功能模块比较多时,往往会按模块或类别对Spring的bean配置文件进行管理,使配置文件模块化,更容易维护;spring3.0过后,对Spring XML bean文件进行拆分, 例如

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/301/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
 
    <import resource="config/user.xml"/>
    <import resource="config/role.xml"/>
    <import resource="config/permission.xml"/>
 
</beans>

  spring3.0及过后,引入了@Import注解,提供与Spring XML中的<import />元素等效的功能;spring4.2过后,@Import只支持导入配置类(@Configuration修饰的类、ImportSelector实现类和ImportBeanDefinitionRegistrar实现类),而spring4.2及过后不仅支持导入配置类,共同也支持导入常规的java类(如普通的User类)

  示例地址:spring-boot-autoconfig,一种前会配置,无需down下来运行,看一眼具体怎么才能 才能 配置即可

  运行测试用例,结果如下

  都还要看得人,Dog、Cat、Role、User、Permission的实例都将会注册到了spring容器,也可是我说上述讲的@Import的4种依据前会还能不能 将实例注册到spring容器的

@Import注解原理

  @Import何以有如此 强大的功能,肩头肯定有某个团队在运作,而许多团队是谁了,可是我spring;spring容器肯定在某个阶段有对@Import进行了防止,至于spring是在那先 过后对@Import进行了怎么才能 才能 的防止,让我们让我们来跟一跟源码;ConfigurationClassPostProcessor实现了BeanDefinitionRegistryPostProcessor,如此 它会在spring启动的refresh阶段被应用,让我们让我们从refresh的invokeBeanFactoryPostProcessors依据刚开始了

  ConfigurationClassPostProcessor

    注意此时spring容器中的bean定义与bean实例,数量非常少,让我们让我们都还要留心观察下

    一路跟下来,让我们让我们来到processConfigBeanDefinitions依据,该依据会创建三个白ConfigurationClassParser对象,该对象会分析所有@Configuration注解的配置类,产生一组ConfigurationClass对象,过后 从这组ConfigurationClass对象中加载bean定义

  ConfigurationClassParser

    主可是我parse依据

    从启动类(示例中是com.lee.autoconfig.AutoConfigApplication)刚开始了,递归解析配置类以及配置类的父级配置类;边跟边注意beanFactory中beanDefinitionMap的变化,ConfigurationClassParser对象有beanFactory的引用,属性叫兰registry;让我们让我们都还要仔细看下doProcessConfigurationClass依据

/**
 * 通过从源类中读取注解、成员和依据来构建三个白完整性的配置类:ConfigurationClass
 * 注意返回值,是父级类或null(null带有一种情况汇报,没找到父级类或过后将会防止完成)
 */
@Nullable
protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
        throws IOException {

    // 递归防止配置类内置的成员类
    processMemberClasses(configClass, sourceClass);

    // 防止配置类上所有@PropertySource注解
    for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
            sourceClass.getMetadata(), PropertySources.class,
            org.springframework.context.annotation.PropertySource.class)) {
        if (this.environment instanceof ConfigurableEnvironment) {
            processPropertySource(propertySource);
        }
        else {
            logger.warn("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() +
                    "]. Reason: Environment must implement ConfigurableEnvironment");
        }
    }

    // 防止配置类上所有的@ComponentScan注解,包括@ComponentScans和ComponentScan
    Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
            sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
    if (!componentScans.isEmpty() &&
            !this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
        for (AnnotationAttributes componentScan : componentScans) {
            // 立即扫描@ComponentScan修饰的配置类,
            // 通常是从启动类所在的包(示例中是com.lee.autoconfig)刚开始了扫描,扫描配置类(被@Configuration修饰的类)
            Set<BeanDefinitionHolder> scannedBeanDefinitions =
                    this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
            // 进一步检查通过配置类扫描得到的bean定义集,并在还要时递归解析
            for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
                BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
                if (bdCand == null) {
                    bdCand = holder.getBeanDefinition();
                }
                if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
                    parse(bdCand.getBeanClassName(), holder.getBeanName());
                }
            }
        }
    }

    // 防止配置类上所有的@Import注解
    // 包括@Import支持的4种类型:ImportSelector、ImportBeanDefinitionRegistrar、@Configuration和普通java类
    // 普通java类会被按@Configuration依据防止
    processImports(configClass, sourceClass, getImports(sourceClass), true);

    // 防止配置类上所有的@ImportResource注解,xml依据的bean可是我其中之一
    AnnotationAttributes importResource =
            AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
    if (importResource != null) {
        String[] resources = importResource.getStringArray("locations");
        Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
        for (String resource : resources) {
            String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
            configClass.addImportedResource(resolvedResource, readerClass);
        }
    }

    // 防止配置类中被@Bean修饰的依据
    Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
    for (MethodMetadata methodMetadata : beanMethods) {
        configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
    }

    // 防止默认的依据或接口
    processInterfaces(configClass, sourceClass);

    // 防止父级类,将会有搞笑的话
    if (sourceClass.getMetadata().hasSuperClass()) {
        String superclass = sourceClass.getMetadata().getSuperClassName();
        if (superclass != null && !superclass.startsWith("java") &&
                !this.knownSuperclasses.containsKey(superclass)) {
            this.knownSuperclasses.put(superclass, configClass);
            // Superclass found, return its annotation metadata and recurse
            return sourceClass.getSuperClass();
        }
    }

    // No superclass -> processing is complete
    return null;
}
View Code

    上述代码中写了相关注释,有兴趣的同学都还要更进一步的去跟,这里我只跟下processImports依据,将会许多与自动配置息息相关

    起始的ConfigurationClass包括:1、工程中所有让我们让我们自定义的被@Configuration修饰的类,示例中就不到AnimalConfig;2、应用的启动类,示例中是:AutoConfigApplication。

    让我们让我们自定义的ConfigurationClass一般无需带有多级父级ConfigurationClass,例如AnimalConfig,就如此 父级ConfigurationClass,解析就比较简单,让我们让我们无需关注,但AutoConfigApplication就不一样了,他往往会被多个注解修饰,而那先 注解会牵扯出多个ConfigurationClass,还要递归防止所有的ConfigurationClass;上图中,让我们让我们跟到了三个白比较重要的类:AutoConfigurationImportSelector,实例化过后封装成了DeferredImportSelectorHolder对象,存倒入了ConfigurationClassParser的deferredImportSelectors属性中

自动配置源码解析

  一群人将会有那我的大问题:哪来的AutoConfigurationImportSelector,它有那先 用? 客观莫急,让我们让我们慢慢往下看

  让我们让我们的应用启动类被@SpringBootApplication,它是个组合注解,详情如下

  相信让我们让我们看得人得人@Import(AutoConfigurationImportSelector.class)了,ConfigurationClassParser可是我从此解析到的AutoConfigurationImportSelector,至于AutoConfigurationImportSelector有那先 用,马上揭晓;让我们让我们回到ConfigurationClassParser的parse依据,底下还有个特别要的依据:processDeferredImportSelectors,值得让我们让我们完整性跟下

  processDeferredImportSelectors

    说的简单点,从类路径下的所有spring.facoties文件中读取完整性的自动配置类(spring.factories文件中org.springframework.boot.autoconfigure.EnableAutoConfiguration的值),过后 筛选出满足条件的配置类,封装成ConfigurationClass,存倒入ConfigurationClassParser的configurationClasses属性中

    说的完整性点,分三个白依据进行说明

      selectImports依据

        从类路径下的所有spring.facoties文件中读取org.springframework.boot.autoconfigure.EnableAutoConfiguration的所有值,此时获取的是全路径类名的数组,过后 进行筛选过滤,1、先去重防止,将会多个spring.factories中将会占据 重复的;2、过后 剔除让我们让我们配置的还要排除的类,包括@SpringBootApplication注解的exclude、excludeName,以及配置文件中的spring.autoconfigure.exclude;3、条件过滤,过滤出满足当时人条件注解的配置类。最终获取所有满足条件的自动配置类,示例带有2三个白。

        条件注解更完整性的信息请查看:spring-boot-2.0.3源码篇 - @Configuration、Condition与@Conditional,读取spring.facoties文件的完整性信息请查看:spring-boot-2.0.3启动源码篇一 - SpringApplication构造依据

      processImports依据

        许多依据在解析ConfigurationClassParser的parse依据的过后将会用到过了,可是我如此 做说明,它实在可是我用来防止配置类上的@Import注解的;上述selectImports依据解溶解来的配置类,每个配置类前会经过processImports依据防止,递归防止@Import注解,就与递归防止让我们让我们的启动类的@Import注解一样,从而获取所有的自动配置类;springboot的自动配置可是我那我实现的。

  此时还可是我获取了满足条件的自动配置类,配置类中的bean定义加载还如此 进行,让我们让我们回到ConfigurationClassPostProcessor的processConfigBeanDefinitions依据,其带有如下代码

// 各种依据的配置类的解析,包括springboot的自动配置 - @Import、AutoConfigurationImportSelector
parser.parse(candidates);
parser.validate();

Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
configClasses.removeAll(alreadyParsed);

// Read the model and create bean definitions based on its content
if (this.reader == null) {
    this.reader = new ConfigurationClassBeanDefinitionReader(
            registry, this.sourceExtractor, this.resourceLoader, this.environment,
            this.importBeanNameGenerator, parser.getImportRegistry());
}
this.reader.loadBeanDefinitions(configClasses);    // 将配置类中的bean定义加载到beanFactory

  至此,springboot的自动配置源码解析就完成了,有兴趣的都还要更近一步的深入

总结

  1、各个依据之间的调用时序图如下,结合许多时序图看底下的内容,更好看懂

  2、springboot自动配置底层依赖的是SpringFactoriesLoader和AutoConfigurationImportSelector;@EnableAutoConfiguration注解就像三个白八爪鱼,抓取所有满足条件的配置类,过后 读取其中的bean定义到spring容器,@EnableAutoConfiguration得以生效的关键组件关系图如下