springboot启动原理解析

前言

大家都知道springboot为我们做的自动配置,很方便快捷,但是不懂springboot内部启动原理,以后难免会吃亏,接下来我们一起一步步揭开springboot的神秘面纱,让它不在神秘。

原博客地址:https://www.cnblogs.com/shamo89/p/8184960.html

正文

 当我们开发任何一个springboot项目,都会用到如下的启动类

@SpringBootApplication
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
}

  从上面代码可以看出,Annotation定义(@SpringBootApplication)和类定义(SpringApplication.run)最为耀眼,所以要揭开Springboot的神秘面纱,就要从此开始。

SpringBootApplication背后的秘密

 

@Target(ElementType.TYPE)              //注解的适用范围,其中TYPE用于描述类、接口(包括包注解类型)或enum声明
@Retention(RetentionPolicy.RUNTIME)    //注解的生命周期,保留到class文件中(三个生命周期)
@Documented                            //表明这个注解应该被javadoc记录
@Inherited                             //子类可以继承该注解
@SpringBootConfiguration              //继承了Configuration,表示当前是注解类
@EnableAutoConfiguration              //开启springboot的注解功能,springboot的四大神器之一,其借助@import的帮助
@ComponentScan(excludeFilters = {     //扫描路径设置(具体使用待确认)
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

  ......  
}

  虽然定义使用了多个Annotation进行了原信息标注,但实际上重要的只有三个Annotation:

  • @Configuration(@SpringBootConfiguration点开查看发现里面还是应用了@Configuration)
  • @EnableAutoConfiguration
  • @ComponentScan

所以,如果我们使用如下的SpringBoot启动类,整个SpringBoot应用依然可以与之前的启动类功能对等:

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

  每次写这三个比较累,所以写一个@SpringBootApplication方便点。接下来分别介绍这三个Annotation。

@Configuration

这里的@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

  • 表达依赖注入关系层面

为了表达bean与bean之间的依赖关系,在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定义,最终通过注解@EnableAutoConfiguration将这些bean定义加载到IoC容器中。

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

注:所以SpringBoot的启动类最好是放在root package下,因为默认不指定basePackages。

@EnableAutoConfiguration

个人感觉@EnableAutoConfiguration这个Annotation最为重要,所以放到最后来讲解,大家是否还记得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,其自身定义关键信息如下:

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

两个比较重要的注解:

  • @AutoConfigurationPackage:用于导入并装配用户自定义类,即自动扫描包中的类
  • @Import:导入自动配置的组件

AutoConfiguratioPackage注解:

 1 static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
 2 
 3         @Override
 4         public void registerBeanDefinitions(AnnotationMetadata metadata,
 5                 BeanDefinitionRegistry registry) {
 6             register(registry, new PackageImport(metadata).getPackageName());
 7         }
 8 
 9         @Override
10         public Set<Object> determineImports(AnnotationMetadata metadata) {
11             return Collections.<Object>singleton(new PackageImport(metadata));
12         }
13 
14     }

它其实是注册了一个Bean的定义。

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

以上图为例,DemoApplication是和demo包同级,但是demo2这个类是DemoApplication的父级,和example包同级也就是说,DemoApplication启动加载的bean中,并不会加载demo2,这也就是为什么,我们要把DemoApplication放在项目的最高级中。

Import(AutoConfigurationImportSelector.class)注解:

 

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

实现了ImportSelector接口的selectImports方法。

 1 @Override
 2     public String[] selectImports(AnnotationMetadata annotationMetadata) {
 3         if (!isEnabled(annotationMetadata)) {
 4             return NO_IMPORTS;
 5         }
 6         try {
 7             AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
 8                     .loadMetadata(this.beanClassLoader);
 9             AnnotationAttributes attributes = getAttributes(annotationMetadata);
10             List<String> configurations = getCandidateConfigurations(annotationMetadata,
11                     attributes);
12             configurations = removeDuplicates(configurations);
13             configurations = sort(configurations, autoConfigurationMetadata);
14             Set<String> exclusions = getExclusions(annotationMetadata, attributes);
15             checkExcludedClasses(configurations, exclusions);
16             configurations.removeAll(exclusions);
17             configurations = filter(configurations, autoConfigurationMetadata);
18             fireAutoConfigurationImportEvents(configurations, exclusions);
19             return configurations.toArray(new String[configurations.size()]);
20         }
21         catch (IOException ex) {
22             throw new IllegalStateException(ex);
23         }
24     }

可以看到第十行getCandidateConfigurations方法,他其实是使用SpringFactoriesLoader去加载public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";外部文件。这个外部文件,有很多自动配置的类。如下:

其中,最关键的要属@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助Springboot应用将所有符合条件的@Configuration配置都加载到当前SpringSpringboot创建并使用的IoC容器。就像一只“八爪鱼”。

 

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

借助于Spring框架原有的一个工具类:SpringFactoryLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成!

SpringFactoryLoader属于Spring框架私有的一种扩展方案,其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。

public abstract class SpringFactoriesLoader {
    //...
    public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
        ...
    }


    public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
        ....
    }
}

配合@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容器。

SpringBoot的启动原理基本算是讲完了,为了方便记忆,我根据上面的分析画了张图

 

深入探索SpringApplication执行流程

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

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

 1 @SuppressWarnings({ "unchecked", "rawtypes" })
 2     private void initialize(Object[] sources) {
 3         if (sources != null && sources.length > 0) {
 4             this.sources.addAll(Arrays.asList(sources));
 5         }
 6         this.webEnvironment = deduceWebEnvironment();
 7         setInitializers((Collection) getSpringFactoriesInstances(
 8                 ApplicationContextInitializer.class));
 9         setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
10         this.mainApplicationClass = deduceMainApplicationClass();
11     }
  • 第6行根据classpath里面是否存在某个特征类(org.springframework.web.context.ConfigurableWebApplicationContext)来决定是否应该创建一个为Web应用使用的ApplicationContext类型。
  • 第7行使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。
  • 第8行使用SpringFactoriesLoader在应用classpath中查找并加载所有可用的ApplicationListener。
  • 第10行判断并设置main方法的定义类。

2)SpringApplication实例初始化完成并且完成设置后,就开始执行run方法的逻辑了,方法执行开始,首先遍历执行所有通过SpringFactoriesLoader可以查找并加载的SpringApplicationRunListener。调用他们的started()方法,告诉这些SpringApplicationRunListener,Springboot应用可以开始执行了。

 1 public ConfigurableApplicationContext run(String... args) {
 2         StopWatch stopWatch = new StopWatch();
 3         stopWatch.start();
 4         ConfigurableApplicationContext context = null;
 5         FailureAnalyzers analyzers = null;
 6         configureHeadlessProperty();
 7         SpringApplicationRunListeners listeners = getRunListeners(args);
 8         listeners.starting();
 9         try {
10             ApplicationArguments applicationArguments = new DefaultApplicationArguments(
11                     args);
12             ConfigurableEnvironment environment = prepareEnvironment(listeners,
13                     applicationArguments);
14             Banner printedBanner = printBanner(environment);
15             context = createApplicationContext();
16             analyzers = new FailureAnalyzers(context);
17             prepareContext(context, environment, listeners, applicationArguments,
18                     printedBanner);
19              //核心点:会打印springboot启动标志,直到server.port端口启动
20             refreshContext(context);
21             afterRefresh(context, applicationArguments);
22             listeners.finished(context, null);
23             stopWatch.stop();
24             if (this.logStartupInfo) {
25                 new StartupInfoLogger(this.mainApplicationClass)
26                         .logStarted(getApplicationLog(), stopWatch);
27             }
28             return context;
29         }
30         catch (Throwable ex) {
31             handleRunFailure(context, listeners, analyzers, ex);
32             throw new IllegalStateException(ex);
33         }
34     }

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

 1 private ConfigurableEnvironment prepareEnvironment(
 2             SpringApplicationRunListeners listeners,
 3             ApplicationArguments applicationArguments) {
 4         // Create and configure the environment
 5         ConfigurableEnvironment environment = getOrCreateEnvironment();
 6         configureEnvironment(environment, applicationArguments.getSourceArgs());
 7         listeners.environmentPrepared(environment);
 8         if (!this.webEnvironment) {
 9             environment = new EnvironmentConverter(getClassLoader())
10                     .convertToStandardEnvironmentIfNecessary(environment);
11         }
12         return environment;
13     }

4)遍历调用所有SpringApplicationRunListener的environmentPrepared的方法,告诉他们:“当前SPringBoot应用的Environment准备好了”。

1 public void environmentPrepared(ConfigurableEnvironment environment) {
2         for (SpringApplicationRunListener listener : this.listeners) {
3             listener.environmentPrepared(environment);
4         }
5     }

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

private Banner printBanner(ConfigurableEnvironment environment) {
        if (this.bannerMode == Banner.Mode.OFF) {
            return null;
        }
        ResourceLoader resourceLoader = this.resourceLoader != null ? this.resourceLoader
                : new DefaultResourceLoader(getClassLoader());
        SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter(
                resourceLoader, this.banner);
        if (this.bannerMode == Mode.LOG) {
            return bannerPrinter.print(environment, this.mainApplicationClass, logger);
        }
        return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
    }

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

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

@SuppressWarnings({ "rawtypes", "unchecked" })
    protected void applyInitializers(ConfigurableApplicationContext context) {
        for (ApplicationContextInitializer initializer : getInitializers()) {
            Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(
                    initializer.getClass(), ApplicationContextInitializer.class);
            Assert.isInstanceOf(requiredType, context, "Unable to call initializer.");
            initializer.initialize(context);
        }
    }

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

private void prepareContext(ConfigurableApplicationContext context,
            ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
            ApplicationArguments applicationArguments, Banner printedBanner) {
        context.setEnvironment(environment);
        postProcessApplicationContext(context);
        applyInitializers(context);
        listeners.contextPrepared(context);
        if (this.logStartupInfo) {
            logStartupInfo(context.getParent() == null);
            logStartupProfileInfo(context);
        }

        // Add boot specific singleton beans
        context.getBeanFactory().registerSingleton("springApplicationArguments",
                applicationArguments);
        if (printedBanner != null) {
            context.getBeanFactory().registerSingleton("springBootBanner", printedBanner);
        }

        // Load the sources
        Set<Object> sources = getSources();
        Assert.notEmpty(sources, "Sources must not be empty");
        load(context, sources.toArray(new Object[sources.size()]));
        listeners.contextLoaded(context);
    }

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

private void prepareAnalyzer(ConfigurableApplicationContext context,
            FailureAnalyzer analyzer) {
        if (analyzer instanceof BeanFactoryAware) {
            ((BeanFactoryAware) analyzer).setBeanFactory(context.getBeanFactory());
        }
    }

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

public void contextLoaded(ConfigurableApplicationContext context) {
        for (SpringApplicationRunListener listener : this.listeners) {
            listener.contextLoaded(context);
        }
    }

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

private void refreshContext(ConfigurableApplicationContext context) {
        refresh(context);
        if (this.registerShutdownHook) {
            try {
                context.registerShutdownHook();
            }
            catch (AccessControlException ex) {
                // Not allowed in some environments.
            }
        }
    }

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

private void callRunners(ApplicationContext context, ApplicationArguments args) {
        List<Object> runners = new ArrayList<Object>();
        runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
        runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
        AnnotationAwareOrderComparator.sort(runners);
        for (Object runner : new LinkedHashSet<Object>(runners)) {
            if (runner instanceof ApplicationRunner) {
                callRunner((ApplicationRunner) runner, args);
            }
            if (runner instanceof CommandLineRunner) {
                callRunner((CommandLineRunner) runner, args);
            }
        }
    }

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

去除事件通知点后,整个流程如下:

public void finished(ConfigurableApplicationContext context, Throwable exception) {
        for (SpringApplicationRunListener listener : this.listeners) {
            callFinishedListener(listener, context, exception);
        }
    }

总结

到此,SpringBoot的核心组件完成了基本的解析,综合来看,大部分都是Spring框架背后的一些概念和实践方式,SpringBoot只是在这些概念和实践上对特定的场景事先进行了固化和升华,而也恰恰是这些固化让我们开发基于Spring框架的应用更加方便高效。

 

posted @ 2019-06-11 21:28  许明初  阅读(3463)  评论(0编辑  收藏  举报