springboot2.0.3源码篇

  • 时间:
  • 浏览:0
  • 来源:大发pk10_pk10人工计划_大发pk10人工计划

前言

  开心一刻   

    女儿: “妈妈,你越来越 漂亮,当年为什么我么我会 嫁给了爸爸呢?”

    妈妈: “当年你爸后该 穷嘛!‘

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

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

    女儿......

@Import注解应用

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

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/1501/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得以生效的关键组件关系图如下