• SpringBoot启动流程解析


    来源:http://www.cnblogs.com/trgl/p/7353782.html

    配合理解:(https://blog.csdn.net/fly_zhyu/article/details/76407830;

    https://blog.csdn.net/zxzzxzzxz123/article/details/69941910/;

    写在前面:

           由于该系统是底层系统,以微服务形式对外暴露dubbo服务,所以本流程中SpringBoot不基于jetty或者tomcat等容器启动方式发布服务,而是以执行程序方式启动来发布(参考下图keepRunning方法)。

           本文以调试一个实际的SpringBoot启动程序为例,参考流程中主要类类图,来分析其启动逻辑和自动化配置原理。

    总览:

           上图为SpringBoot启动结构图,我们发现启动流程主要分为3个部分,

    (1)、 进行SpringApplication的初始化模块,配置一些基本的环境变量、资源、构造器、监听器;

    (2)、实现了应用具体的启动方案,包括启动流程的监听模块、加载配置环境模块、及核心的创建上下文环境模块;

    (3)、是自动化配置模块,该模块作为springboot自动配置核心,在后面的分析中会详细讨论。在下面的启动程序中我们会串联起结构中的主要功能。

    一、Springboot:请求入口
     
    @SpringBootApplication
    @EnableAspectJAutoProxy
    @EnableScheduling
    @EnableTransactionManagement
    public class Application {
        
        public static void main(String[] args) {
     
            SpringApplication.run(Application.class, args);
     
        }
    }
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ImportResource("classpath*:spring-context.xml") @ComponentScan(excludeFilters
    = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) }) public @interface SpringBootApplication { …… }

    启动:

          每个SpringBoot程序都有一个主入口,也就是main方法,main里面调用SpringApplication.run()启动整个spring-boot程序,该方法所在类需要使用3个注解:@SpringBootApplication@ImportResource注解(if need),@SpringBootApplication,(@SpringBootApplication 是一个复合注解,包括@ComponentScan,和@SpringBootConfiguration,@EnableAutoConfiguration);功能如下:

    (1)、@EnableAutoConfiguration:SpringBoot根据应用所声明的依赖来对Spring框架进行自动配置。作用:

    帮助SpringBoot应用将将所有符合自动配置条件的bean定义加载到IoC容器。
    具体解释:从classpath中搜索所有META-INF/spring.factories配置文件然后,将其中org.springframework.boot.autoconfigure.EnableAutoConfiguration key对应的配置项加载到spring容器(https://www.jianshu.com/p/464d04c36fb1);

    解释2:它也是复合注解、借助@Import将所有符合自动配置条件的bean定义加载到Spring ioc 中。帮助springboot应用将所有符合条件的@configuration配置都加载到当前spring ioc;    

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

     

    自动配置幕后英雄:SpringFactoriesLoader详解
           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容器。

    (2)、@SpringBootConfiguration:被标注的类等于在spring的XML配置文件中(applicationContext.xml),装配所有bean事务,提供了一个spring的上下文环境。具体解释(https://www.jianshu.com/p/caa9cd010940):

    解释2:继承自@Configuration,二者功能也一致,标注当前类是配置类,并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中,并且实例名就是方法名。@SpringBootConfiguration注解类相当于spring配置bean的xml文件。
    ·xml中bean的定义:
    • xml中bean的定义:
    <beans>
        <bean id="course" class="demo.Course">
            <property name="module" ref="module"/>
        </bean>
        <bean id="module" class="demo.Module">
            <property name="assignment" ref="assignment"/>
        </bean>
        <bean id="assignment" class="demo.Assignment" />
    </beans>
    • 注解配置类:
    @Configuration
    public class AppContext {
        @Bean
        public Course course() {
            Course course = new Course();
            course.setModule(module());
            return course;
        }
        @Bean
        public Module module() {
            Module module = new Module();
            module.setAssignment(assignment());
            return module;
        }
        @Bean
        public Assignment assignment() {
            return new Assignment();
        }
    }

     下面是一个典型的Spring配置文件(application-config.xml):

    <beans> 
            <bean id="orderService" class="com.acme.OrderService"/> 
                    <constructor-arg ref="orderRepository"/> 
            </bean> 
            <bean id="orderRepository" class="com.acme.OrderRepository"/> 
                    <constructor-arg ref="dataSource"/> 
            </bean> 
    </beans> 
    @Configuration 
    public class ApplicationConfig { 
       
            public @Bean OrderService orderService() { 
                    return new OrderService(orderRepository()); 
            } 
       
            public @Bean OrderRepository orderRepository() { 
                    return new OrderRepository(dataSource()); 
            } 
       
            public @Bean DataSource dataSource() { 
                    // instantiate and return an new DataSource … 
            } 
    }

    然后你就可以像这样来使用是bean了:

    JavaConfigApplicationContext ctx = new JavaConfigApplicationContext(ApplicationConfig.class); 

    OrderService orderService = ctx.getBean(OrderService.class);

    这么做有什么好处呢?

         1.使用纯java代码,不在需要xml

         2.在配置中也可享受OO带来的好处

         3.类型安全对重构也能提供良好的支持

         4.依旧能享受到所有springIoC容器提供的功能

     

    (3)、@ComponentScan:组件扫描,可自动发现和装配Bean,默认扫描SpringApplication的run方法里的Booter.class所在的包路径下文件,所以最好将该启动类放到根包路径下;具体解释(https://blog.csdn.net/u013078669/article/details/52664779 ):

    @ComponentScan告诉Spring 哪个packages 的用注解标识的类 会被spring自动扫描并且装入bean容器。

    例如,如果你有个类用@Controller注解标识了,那么,如果不加上@ComponentScan,自动扫描该controller,那么该Controller就不会被spring扫描到,更不会装入spring容器中,因此你配置的这个Controller也没有意义。

    类上的注解@Configuration 是最新的用注解配置spring,也就是说这是个配置文件,和原来xml配置是等效的,只不过现在用java代码进行配置了 加上一个@Configuration注解就行了,是不是很方便,不需要那么繁琐的xml配置了,这样基于注解的配置,可读性也大大增高了。

    解释2:它主要作用扫描当前包及其子包下被@Component,@Controller,@Service,@Repository注解标记的类并纳入到spring容器中进行管理。是以前的<context:component-scan>(以前使用在xml中使用的标签,用来扫描包配置的平行支持)。可通过@ComponentScan 的basepackage等属性来指定扫描范围。(@SpringBootApplication(scanBasePackages = "com.ucredit")。如果不指定默认spring框架实现,从声明@ComponentScan所在的类的package进行扫描。所以springboot的启动类最好放在root package下。

    参数:

    basePackageClasses:对basepackages()指定扫描注释组件包类型安全的替代。

    excludeFilters:指定不适合组件扫描的类型。

    includeFilters:指定哪些类型有资格用于组件扫描。

    lazyInit:指定是否应注册扫描的beans为lazy初始化。

    nameGenerator:用于在Spring容器中的检测到的组件命名。

    resourcePattern:控制可用于组件检测的类文件。

    scopedProxy:指出代理是否应该对检测元件产生,在使用过程中会在代理风格时尚的范围是必要的。

    scopeResolver:用于解决检测到的组件的范围。

    useDefaultFilters:指示是否自动检测类的注释

    (4)@Import :这个注解帮助我们将多个配置文件(可能是按功能分,或是按业务分)导入到单个主配置中,以避免将所有配置写在一个配置中。

    • @Import 与xml配置方式下的 作用一样。支持导入的类型有: 
      一个或多个拥有 @Configuration 注解的配置类
    • ImportSelector 接口的实现类
    • ImportBeanDefinitionRegistrar 的实现类

       1)、如果Import注解中Class为ImportSelector子类,通过invokeAwareMethods(selector)设置aware值,如果类型为  DeferredImportSelector则添加到deferredImportSelectors集合中,待前面的parser.parse(configCandidates)
     方法中processDeferredImportSelectors()处理;如果不是,则执行selectImports方法,将获取到的结果递归调用  processImports,解析selectImports得到的结果

       2)、如果Import注解中Class为ImportBeanDefinitionRegistrar子类,则添加到importBeanDefinitionRegistrars中,注 意该部分的数据在执行完parser.parse(configCandidates)后调用this.reader.loadBeanDefinitions(configClasses)解 析,否则执行配置信息的解析操作。

    阐释:

    public interface Car {
     
         public void print();
    }
    @Component
    public class Toyota implements Car {
     
        @Override
        public void print() {
            // TODO Auto-generated method stub
             System.out.println("I am Toyota");
        }
     
    }
     
    @Component
    public class Volkswagen implements Car {
     
        @Override
        public void print() {
            // TODO Auto-generated method stub
            System.out.println("I am Volkswagen");
        }
     
    }
     
    @Configuration
    public class JavaConfigA {
        
        @Bean(name="volkswagen")
        public Car getVolkswagen(){
            return new Volkswagen();
        }
    }
     
    @Configuration
    public class JavaConfigB {
        @Bean(name="toyota")
        public Car getToyota(){
            return new Toyota();
        }
    }
     
    @Configuration
    @Import({JavaConfigA.class,JavaConfigB.class})
    public class ParentConfig {
        //Any other bean definitions
    }
    public class ContextLoader {
     
          public static void main (String args[]){
                AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ParentConfig.class);
                Car car = (Toyota)context.getBean("toyota");
                car.print();
                car = (Volkswagen)context.getBean("volkswagen");
                car.print();
                context.close();
            }
    }
     
     

    (5)@EnableAspectJAutoProxy: 表示开启AOP代理自动配置,如果配@EnableAspectJAutoProxy表示使用cglib进行代理对象的生成;

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

    (7)@Inherited 元注解

    元注解,就是用来中声明注解类型时需要使用到的注解

     nherited作用是,使用此注解声明出来的自定义注解,在使用此自定义注解时,如果注解在类上面时,子类会自动继承此注解,否则的话,子类不会继承此注解。这里一定要记住,使用Inherited声明出来的注解,只有在类上使用时才会有效,对方法,属性等其他无效。

    声明的此注解使用了Inherited元注解,表示此注解用在类上时,会被子类所继承

    (八)、@Documented 注解

            Documented注解表明这个注释是由 javadoc记录的,在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化,它的注释成为公共API的一部分。

    (九)、@Retention() 注解

    RetentionPolicy这个枚举类型的常量描述保留注释的各种策略,它们与元注释(@Retention)一起指定注释要保留多长时间

    (十)、@Target()  注解

    ElementType 这个枚举类型的常量提供了一个简单的分类:注释可能出现在Java程序中的语法位置(这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置)

    SpringBoot启动类

    首先进入run方法


     

    run方法中去创建了一个SpringApplication实例,在该构造方法内,我们可以发现其调用了一个初始化的initialize方法


     

     

    这里主要是为SpringApplication对象赋一些初值。构造函数执行完毕后,我们回到run方法


     

    该方法中实现了如下几个关键步骤:

    1.创建了应用的监听器SpringApplicationRunListeners并开始监听

    2.加载SpringBoot配置环境(ConfigurableEnvironment),如果是通过web容器发布,会加载StandardEnvironment,其最终也是继承了ConfigurableEnvironment,类图如下


     

    可以看出,*Environment最终都实现了PropertyResolver接口,我们平时通过environment对象获取配置文件中指定Key对应的value方法时,就是调用了propertyResolver接口的getProperty方法

    3.配置环境(Environment)加入到监听器对象中(SpringApplicationRunListeners)

    4.创建run方法的返回对象:ConfigurableApplicationContext(应用配置上下文),我们可以看一下创建方法:


     

    方法会先获取显式设置的应用上下文(applicationContextClass),如果不存在,再加载默认的环境配置(通过是否是web environment判断),默认选择AnnotationConfigApplicationContext注解上下文(通过扫描所有注解类来加载bean),最后通过BeanUtils实例化上下文对象,并返回,ConfigurableApplicationContext类图如下:


     

    主要看其继承的两个方向:

    LifeCycle:生命周期类,定义了start启动、stop结束、isRunning是否运行中等生命周期空值方法

    ApplicationContext:应用上下文类,其主要继承了beanFactory(bean的工厂类)

    5.回到run方法内,prepareContext方法将listeners、environment、applicationArguments、banner等重要组件与上下文对象关联

    6.接下来的refreshContext(context)方法(初始化方法如下)将是实现spring-boot-starter-*(mybatis、redis等)自动化配置的关键,包括spring.factories的加载,bean的实例化等核心工作。


    refresh方法

    配置结束后,Springboot做了一些基本的收尾工作,返回了应用环境上下文。回顾整体流程,Springboot的启动,主要创建了配置环境(environment)、事件监听(listeners)、应用上下文(applicationContext),并基于以上条件,在容器中开始实例化我们需要的Bean,至此,通过SpringBoot启动的程序已经构造完成,接下来我们来探讨自动化配置是如何实现。


    自动化配置:

           之前的启动结构图中,我们注意到无论是应用初始化还是具体的执行过程,都调用了SpringBoot自动配置模块


    SpringBoot自动配置模块

           该配置模块的主要使用到了SpringFactoriesLoader,即Spring工厂加载器,该对象提供了loadFactoryNames方法,入参为factoryClass和classLoader,即需要传入上图中的工厂类名称和对应的类加载器,方法会根据指定的classLoader,加载该类加器搜索路径下的指定文件,即spring.factories文件,传入的工厂类为接口,而文件中对应的类则是接口的实现类,或最终作为实现类,所以文件中一般为如下图这种一对多的类名集合,获取到这些实现类的类名后,loadFactoryNames方法返回类名集合,方法调用方得到这些集合后,再通过反射获取这些类的类对象、构造方法,最终生成实例


    工厂接口与其若干实现类接口名称

    下图有助于我们形象理解自动配置流程


    SpringBoot自动化配置关键组件关系图 

          mybatis-spring-boot-starter、spring-boot-starter-web等组件的META-INF文件下均含有spring.factories文件,自动配置模块中,SpringFactoriesLoader收集到文件中的类全名并返回一个类全名的数组,返回的类全名通过反射被实例化,就形成了具体的工厂实例,工厂实例来生成组件具体需要的bean。

    之前我们提到了EnableAutoConfiguration注解,其类图如下


     

    可以发现其最终实现了ImportSelector(选择器)和BeanClassLoaderAware(bean类加载器中间件),重点关注一下AutoConfigurationImportSelector的selectImports方法


     

    该方法在springboot启动流程——bean实例化前被执行,返回要实例化的类信息列表。我们知道,如果获取到类信息,spring自然可以通过类加载器将类加载到jvm中,现在我们已经通过spring-boot的starter依赖方式依赖了我们需要的组件,那么这些组建的类信息在select方法中也是可以被获取到的,不要急我们继续向下分析


     

    该方法中的getCandidateConfigurations方法,通过方法注释了解到,其返回一个自动配置类的类名列表,方法调用了loadFactoryNames方法,查看该方法


     

    在上面的代码可以看到自动配置器会跟根据传入的factoryClass.getName()到项目系统路径下所有的spring.factories文件中找到相应的key,从而加载里面的类。我们就选取这个mybatis-spring-boot-autoconfigure下的spring.factories文件


     

    进入org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration中,主要看一下类头


     

    发现@Spring的Configuration,俨然是一个通过注解标注的springBean,继续向下看,

    @ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class})这个注解的意思是:当存在SqlSessionFactory.class, SqlSessionFactoryBean.class这两个类时才解析MybatisAutoConfiguration配置类,否则不解析这一个配置类,make sence,我们需要mybatis为我们返回会话对象,就必须有会话工厂相关类

    @CondtionalOnBean(DataSource.class):只有处理已经被声明为bean的dataSource

    @ConditionalOnMissingBean(MapperFactoryBean.class)这个注解的意思是如果容器中不存在name指定的bean则创建bean注入,否则不执行(该类源码较长,篇幅限制不全粘贴)

           以上配置可以保证sqlSessionFactory、sqlSessionTemplate、dataSource等mybatis所需的组件均可被自动配置,@Configuration注解已经提供了Spring的上下文环境,所以以上组件的配置方式与Spring启动时通过mybatis.xml文件进行配置起到一个效果。通过分析我们可以发现,只要一个基于SpringBoot项目的类路径下存在SqlSessionFactory.class, SqlSessionFactoryBean.class,并且容器中已经注册了dataSourceBean,就可以触发自动化配置,意思说我们只要在maven的项目中加入了mybatis所需要的若干依赖,就可以触发自动配置,但引入mybatis原生依赖的话,每集成一个功能都要去修改其自动化配置类,那就得不到开箱即用的效果了。所以Spring-boot为我们提供了统一的starter可以直接配置好相关的类,触发自动配置所需的依赖(mybatis)如下:


     

    这里是截取的mybatis-spring-boot-starter的源码中pom.xml文件中所有依赖:


     

    因为maven依赖的传递性,我们只要依赖starter就可以依赖到所有需要自动配置的类,实现开箱即用的功能。也体现出Springboot简化了Spring框架带来的大量XML配置以及复杂的依赖管理,让开发人员可以更加关注业务逻辑的开发。

  • 相关阅读:
    Educational Codeforces Round 13
    Educational Codeforces Round 12
    vscode 修改标签栏样式为换行全部展示
    webpack uglifyjs 报错 Unexpected token name
    tsconfig.js 使用 paths 设置alias无效问题
    Webpack 报错 filename.indexOf is not a function 的问题
    'GL_EXT_shader_framebuffer_fetch' : extension is not supported
    Flutter命令突然无响应、vscode突然无法连接到IOS模拟器
    解决node fs.writeFile 生成csv 文件乱码问题
    数组map方法与如何使用ES5实现
  • 原文地址:https://www.cnblogs.com/hahajava/p/9970023.html
Copyright © 2020-2023  润新知