暂无图片
暂无图片
暂无图片
暂无图片
暂无图片

SpringBoot启动类原理分析

灵动思维文化传媒 2019-02-14
304

点击上方"蓝字", 右上角选择“设为星标”

 周一至五早8点半!精品技术文章准时送上!




上篇我们主要介绍了SpringBoot的简单介绍,以及快速的搭建了一个HelloWorld应用,而且提到了启动类的@SpringBootApplication注解,那么本篇我们就来对SpringBoot的启动原理就行分析下。




SpringBoot启动原理分析
Springboot Principle Analysis


01

@SpringBootApplicationz注解分析


先看看@SpringBootApplication注解的源码。



从源码上可以看出这个@SpringBootApplication注解是复合注解。我们对里面的注解进行分析下:

  • @Target(ElementType.TYPE)            

    // 注解的适用范围,其中TYPE用于描述类、接口(包括包注解类型)或enum声明

  • @Retention(RetentionPolicy.RUNTIME)  

    // 注解的生命周期,保留到class文件中(三个生命周期)

  • @Documented                          

    // 表明这个注解应该被javadoc记录

  • @Inherited                          

    // 子类可以继承该注解

  • @SpringBootConfiguration            

    // 继承了Configuration,表示当前是注解类

  • @EnableAutoConfiguration            

    // 开启springboot的注解功能,springboot的四大神器之一

  • @ComponentScan

    // 扫描路径配置

这里比较重要的就是@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan接下来我们来说说这个三个注解。



@SpringBootConfiguration


这个类继承了@Configuraction,这里的@Configuration对我们来说不陌生,它就是JavaConfig形式的Spring Ioc容器的配置类使用的那个@Configuration,SpringBoot社区推荐使用基于JavaConfig的配置形式,所以,这里的启动类标注了@Configuration之后,本身其实也是一个IoC容器的配置类。举几个简单例子回顾下,XML跟config配置方式的区别:

  • 表达形式层面

① 基于XML配置的方式

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"

       default-lazy-init="true">

    <!--bean定义-->

</beans>


② 基于JavaConfig的配置方式

@Configuration

public class MockConfiguration{

    //bean定义

}

任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类


  • 注册bean定义层面

① 基于XML配置的方式


<bean id="mockService" class="..MockServiceImpl">

    ...

</bean>


② 基于JavaConfig的配置方式

@Configuration

public class MockConfiguration{

    @Bean

    public MockService mockService(){

        return new MockServiceImpl();

    }

}

任何一个标注了@Bean的方法,其返回值将作为一个bean定义注册到Spring的IoC容器,方法名将默认成该bean定义的id。


  • 表达依赖注入关系层面


① 基于XML配置的方式

<bean id="mockService" class="..MockServiceImpl">

    <propery name ="dependencyService" ref="dependencyService" />

</bean>


<bean id="dependencyService" class="DependencyServiceImpl"></bean>


② 基于JavaConfig的配置方式


@Configuration

public class MockConfiguration{

    @Bean

    public MockService mockService(){

        return new MockServiceImpl(dependencyService());

    }

    

    @Bean

    public DependencyService dependencyService(){

        return new DependencyServiceImpl();

    }

}


如果一个bean的定义依赖其他bean,则直接调用对应的JavaConfig类中依赖bean的创建方法就可以了。


@ComponentScan


@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素,@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中。

我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描,所有这里有一个注意点!


注意!注意!注意!


我们的启动类最好放在root package下,因为默认是不配置basePackages属性的。


@EnableAutoConfiguration


个人感觉@EnableAutoConfiguration这个注解最为重要,所以放在最后来解读,大家是否还记得Spring框架提供的各种名字为@Enable开头的Annotation定义?比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等,@EnableAutoConfiguration的理念和做事方式其实一脉相承,简单概括一下就是,借助@Import的支持,收集和注册特定场景相关的bean定义

  • @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器。

  • @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器。

而@EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器,仅此而已!@EnableAutoConfiguration作为一个复合Annotation,其自身定义关键信息如下:其中两个比较重要的Annotation

@AutoConfigurationPackage
@Import({EnableAutoConfigurationImportSelector.})


首先我们来分析这两个注解:

  • @AutoConfigurationPackage注解,它其实是注册了一个Bean的定义。

public static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {


        @Override

        public void registerBeanDefinitions(AnnotationMetadata metadata,

                BeanDefinitionRegistry registry) {

            register(registry, new PackageImport(metadata).getPackageName());

        }


new PackageImport(metadata).getPackageName(),它返回了当前主程序同级以及子级的包组件。



以上图为例,AppStart是和controller包同级,但是demo这个包是AppStart的父级,它和cnzx包同级,也就是说AppStart启动加载的Bean中,并不会加载demo包下面的Bean,这也就是为什么我们要把AppStart放在项目的最高级中。


  • Import(AutoConfigurationImportSelector.class)注解:

我们先看下面的关系图


可以从图中看出  AutoConfigurationImportSelector 继承了 DeferredImportSelector 继承了 ImportSelector

ImportSelector有一个方法为:selectImports。那么我在来看看这个方法。


可以看到上面红色字体getCandidateConfigurations(),在往下看



这个时候它会使用SpringFactoriesLoader.loadFactoryNames()去加载一个配置,看看如何加载了什么;




从上面看出,它其实是去加载META-INF/spring.factories";外部文件。这个外部文件,有很多自动配置的类。如下:


其中,最关键的要属@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器,看看关系图。


自动配置幕后英雄:SpringFactoriesLoader详解


借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成!SpringFactoriesLoader属于Spring框架私有的一种扩展方案,其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。


配合@EnableAutoConfiguration使用的话,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,获取对应的一组@Configuration类,在看这个图。


上图就是从SpringBoot的autoconfigure依赖包中的META-INF/spring.factories配置文件中摘录的一段内容,可以很好地说明问题。

所以,@EnableAutoConfiguration自动配置的魔法骑士就变成了:从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射(Java Refletion)实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类,然后汇总为一个并加载到IoC容器。


好了我们用一张图来总结上面的原理,如下图:


02

SpringApplication执行流程

SpringApplication的run方法的实现是我们的主要线路,该方法的主要流程大体可以归纳如下:

  • 如果我们使用的是SpringApplication的静态run方法,那么,这个方法里面首先要创建一个SpringApplication对象实例,然后调用这个创建好的SpringApplication的实例方法。在SpringApplication实例初始化的时候,它会提前做几件事情:


  

上图初始化方法的作用如下:


① 根据classpath里面是否存在某个特征类 (org.springframework.web.context.ConfigurableWebApplicationContext)来决定是否应该创建一个为Web应用使用的ApplicationContext类型。

②使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。

③使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。

④推断并设置main方法的定义类。


  • SpringApplication实例初始化完成并且完成设置后,就开始执行run方法的逻辑了,方法执行伊始,首先遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener。调用它们的started()方法,告诉这些SpringApplicationRunListener,“嘿,SpringBoot应用要开始执行咯!”。


  •  创建并配置当前Spring Boot应用将要使用的Environment(包括配置要使用的PropertySource以及Profile)。


  • 遍历调用所有SpringApplicationRunListener的environmentPrepared()的方法,告诉他们:“当前SpringBoot应用使用的Environment准备好了咯!”。

  • 如果SpringApplication的showBanner属性被设置为true,则打印banner。

  • 根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果,决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成,然后根据条件决定是否添加ShutdownHook,决定是否使用自定义的BeanNameGenerator,决定是否使用自定义的ResourceLoader,当然,最重要的,将之前准备好的Environment设置给创建好的ApplicationContext使用。


  • ApplicationContext创建好之后,SpringApplication会再次借助Spring-FactoriesLoader,查找并加载classpath中所有可用的ApplicationContext-Initializer,然后遍历调用这些ApplicationContextInitializer的initialize(applicationContext)方法来对已经创建好的ApplicationContext进行进一步的处理。





  • 遍历调用所有SpringApplicationRunListener的contextPrepared()方法




  • 最核心的一步,将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext。

  • 遍历调用所有SpringApplicationRunListener的contextLoaded()方法

  • 用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。

  • 查找当前ApplicationContext中是否注册有CommandLineRunner,如果有,则遍历执行它们。

  • 正常情况下,遍历执行SpringApplicationRunListener的finished()方法、(如果整个过程出现异常,则依然调用所有SpringApplicationRunListener的finished()方法,只不过这种情况下会将异常信息一并传入处理)。




同样的我们用一张手绘图来总结下:


好了大体的原理就是这样了,总之一定要多跟着源码才知道怎么个原理。下篇我们就开始说说springBoot整合一些常用的组件。



End

更多Java、数据库、微服务、分布式的原创系列文章正在路上,欢迎扫描下方二维码,持续关注:

灵动思维文化传媒(id:itjhzx)
多年技术经验倾囊相授



文章转载自灵动思维文化传媒,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。

评论