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/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得以生效的关键组件关系图如下