咱们开发任何一个Spring Boot项目,都会用到以下的启动类html
1 @SpringBootApplication 2 public class Application { 3 public static void main(String[] args) { 4 SpringApplication.run(Application.class, args); 5 } 6 }
从上面代码能够看出,Annotation定义(@SpringBootApplication)和类定义(SpringApplication.run)最为耀眼,因此要揭开SpringBoot的神秘面纱,咱们要从这两位开始就能够了。web
1、SpringBootApplication背后的秘密redis
@SpringBootApplication注解是Spring Boot的核心注解,它实际上是一个组合注解:spring
1 @Target(ElementType.TYPE) 2 @Retention(RetentionPolicy.RUNTIME) 3 @Documented 4 @Inherited 5 @SpringBootConfiguration 6 @EnableAutoConfiguration 7 @ComponentScan(excludeFilters = { 8 @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), 9 @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) }) 10 public @interface SpringBootApplication { 11 ... 12 }
虽然定义使用了多个Annotation进行了原信息标注,但实际上重要的只有三个Annotation:sql
即 @SpringBootApplication = (默认属性)@Configuration + @EnableAutoConfiguration + @ComponentScan。数组
因此,若是咱们使用以下的SpringBoot启动类,整个SpringBoot应用依然能够与以前的启动类功能对等:springboot
1 @Configuration 2 @EnableAutoConfiguration 3 @ComponentScan 4 public class Application { 5 public static void main(String[] args) { 6 SpringApplication.run(Application.class, args); 7 } 8 }
每次写这3个比较累,因此写一个@SpringBootApplication方便点。接下来分别介绍这3个Annotation。mybatis
一、@Configurationapp
这里的@Configuration对咱们来讲不陌生,它就是JavaConfig形式的Spring Ioc容器的配置类使用的那个@Configuration,SpringBoot社区推荐使用基于JavaConfig的配置形式,因此,这里的启动类标注了@Configuration以后,自己其实也是一个IoC容器的配置类。框架
举几个简单例子回顾下,XML跟config配置方式的区别:
(1)表达形式层面
基于XML配置的方式是这样:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd" 5 default-lazy-init="true"> 6 <!--bean定义--> 7 </beans>
而基于JavaConfig的配置方式是这样:
1 @Configuration 2 public class MockConfiguration{ 3 //bean定义 4 }
任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类。
(2)注册bean定义层面
基于XML的配置形式是这样:
1 <bean id="mockService" class="..MockServiceImpl"> 2 ... 3 </bean>
而基于JavaConfig的配置形式是这样的:
1 @Configuration 2 public class MockConfiguration{ 3 @Bean 4 public MockService mockService(){ 5 return new MockServiceImpl(); 6 } 7 }
任何一个标注了@Bean的方法,其返回值将做为一个bean定义注册到Spring的IoC容器,方法名将默认成该bean定义的id。
(3)表达依赖注入关系层面
为了表达bean与bean之间的依赖关系,在XML形式中通常是这样:
1 <bean id="mockService" class="..MockServiceImpl"> 2 <propery name ="dependencyService" ref="dependencyService" /> 3 </bean> 4 5 <bean id="dependencyService" class="DependencyServiceImpl"></bean>
而基于JavaConfig的配置形式是这样的:
1 @Configuration 2 public class MockConfiguration{ 3 @Bean 4 public MockService mockService(){ 5 return new MockServiceImpl(dependencyService()); 6 } 7 8 @Bean 9 public DependencyService dependencyService(){ 10 return new DependencyServiceImpl(); 11 } 12 }
若是一个bean的定义依赖其余bean,则直接调用对应的JavaConfig类中依赖bean的建立方法就能够了。
@Configuration:提到@Configuration就要提到他的搭档@Bean。使用这两个注解就能够建立一个简单的spring配置类,能够用来替代相应的xml配置文件。
1 <beans> 2 <bean id = "car" class="com.test.Car"> 3 <property name="wheel" ref = "wheel"></property> 4 </bean> 5 <bean id = "wheel" class="com.test.Wheel"></bean> 6 </beans>
至关于:
1 @Configuration 2 public class Conf { 3 @Bean 4 public Car car() { 5 Car car = new Car(); 6 car.setWheel(wheel()); 7 return car; 8 } 9 10 @Bean 11 public Wheel wheel() { 12 return new Wheel(); 13 } 14 }
@Configuration的注解类标识这个类可使用Spring IoC容器做为bean定义的来源。
@Bean注解告诉Spring,一个带有@Bean的注解方法将返回一个对象,该对象应该被注册为在Spring应用程序上下文中的bean。
二、@ComponentScan
@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素,@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(好比@Component和@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中。
咱们能够经过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,若是不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。
注:因此SpringBoot的启动类最好是放在root package下,由于默认不指定basePackages。
三、@EnableAutoConfiguration
我的感受@EnableAutoConfiguration这个Annotation最为重要,因此放在最后来解读,你们是否还记得Spring框架提供的各类名字为@Enable开头的Annotation定义?好比@EnableScheduling、@EnableCaching、@EnableMBeanExport等,@EnableAutoConfiguration的理念和作事方式其实一脉相承,简单归纳一下就是,借助@Import的支持,收集和注册特定场景相关的bean定义。
而@EnableAutoConfiguration也是借助@Import的帮助,将全部符合自动配置条件的bean定义加载到IoC容器,仅此而已!
@EnableAutoConfiguration会根据类路径中的jar依赖为项目进行自动配置,如:添加了spring-boot-starter-web依赖,会自动添加Tomcat和Spring MVC的依赖,Spring Boot会对Tomcat和Spring MVC进行自动配置。
@EnableAutoConfiguration做为一个复合Annotation,其自身定义关键信息以下:
1 @SuppressWarnings("deprecation") 2 @Target(ElementType.TYPE) 3 @Retention(RetentionPolicy.RUNTIME) 4 @Documented 5 @Inherited 6 @AutoConfigurationPackage 7 @Import(EnableAutoConfigurationImportSelector.class) 8 public @interface EnableAutoConfiguration { 9 ... 10 }
其中,最关键的要属@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration能够帮助SpringBoot应用将全部符合条件的@Configuration配置都加载到当前SpringBoot建立并使用的IoC容器。就像一只“八爪鱼”同样,借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration能够智能的自动配置功效才得以大功告成!
自动配置幕后英雄:SpringFactoriesLoader详解
SpringFactoriesLoader属于Spring框架私有的一种扩展方案,其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。
1 public abstract class SpringFactoriesLoader { 2 //... 3 public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) { 4 ... 5 } 6 7 8 public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) { 9 .... 10 } 11 }
配合@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、深刻探索SpringApplication执行流程
SpringApplication的run方法的实现是咱们本次旅程的主要线路,该方法的主要流程大致能够概括以下:
1) 若是咱们使用的是SpringApplication的静态run方法,那么,这个方法里面首先要建立一个SpringApplication对象实例,而后调用这个建立好的SpringApplication的实例方法。在SpringApplication实例初始化的时候,它会提早作几件事情:
2) SpringApplication实例初始化完成而且完成设置后,就开始执行run方法的逻辑了,方法执行伊始,首先遍历执行全部经过SpringFactoriesLoader能够查找到并加载的SpringApplicationRunListener。调用它们的started()方法,告诉这些SpringApplicationRunListener,“嘿,SpringBoot应用要开始执行咯!”。
3) 建立并配置当前Spring Boot应用将要使用的Environment(包括配置要使用的PropertySource以及Profile)。
4) 遍历调用全部SpringApplicationRunListener的environmentPrepared()的方法,告诉他们:“当前SpringBoot应用使用的Environment准备好了咯!”。
5) 若是SpringApplication的showBanner属性被设置为true,则打印banner。
6) 根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果,决定该为当前SpringBoot应用建立什么类型的ApplicationContext并建立完成,而后根据条件决定是否添加ShutdownHook,决定是否使用自定义的BeanNameGenerator,决定是否使用自定义的ResourceLoader,固然,最重要的,将以前准备好的Environment设置给建立好的ApplicationContext使用。
7) ApplicationContext建立好以后,SpringApplication会再次借助Spring-FactoriesLoader,查找并加载classpath中全部可用的ApplicationContext-Initializer,而后遍历调用这些ApplicationContextInitializer的initialize(applicationContext)方法来对已经建立好的ApplicationContext进行进一步的处理。
8) 遍历调用全部SpringApplicationRunListener的contextPrepared()方法。
9) 最核心的一步,将以前经过@EnableAutoConfiguration获取的全部配置以及其余形式的IoC容器配置加载到已经准备完毕的ApplicationContext。
10) 遍历调用全部SpringApplicationRunListener的contextLoaded()方法。
11) 调用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。
12) 查找当前ApplicationContext中是否注册有CommandLineRunner,若是有,则遍历执行它们。
13) 正常状况下,遍历执行SpringApplicationRunListener的finished()方法、(若是整个过程出现异常,则依然调用全部SpringApplicationRunListener的finished()方法,只不过这种状况下会将异常信息一并传入处理)
去除事件通知点后,整个流程以下:
本文以调试一个实际的SpringBoot启动程序为例,参考流程中主要类类图,来分析其启动逻辑和自动化配置原理。
总览:
上图为SpringBoot启动结构图,咱们发现启动流程主要分为三个部分,第一部分进行SpringApplication的初始化模块,配置一些基本的环境变量、资源、构造器、监听器,第二部分实现了应用具体的启动方案,包括启动流程的监听模块、加载配置环境模块、及核心的建立上下文环境模块,第三部分是自动化配置模块,该模块做为springboot自动配置核心,在后面的分析中会详细讨论。在下面的启动程序中咱们会串联起结构中的主要功能。
启动:
每一个SpringBoot程序都有一个主入口,也就是main方法,main里面调用SpringApplication.run()启动整个spring-boot程序,该方法所在类须要使用@SpringBootApplication注解,以及@ImportResource注解(if need),@SpringBootApplication包括三个注解,功能以下:
@EnableAutoConfiguration:SpringBoot根据应用所声明的依赖来对Spring框架进行自动配置。
@SpringBootConfiguration(内部为@Configuration):被标注的类等于在spring的XML配置文件中(applicationContext.xml),装配全部bean事务,提供了一个spring的上下文环境。
@ComponentScan:组件扫描,可自动发现和装配Bean,默认扫描SpringApplication的run方法里的Booter.class所在的包路径下文件,因此最好将该启动类放到根包路径下。
首先进入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的实例化等核心工做。
配置结束后,Springboot作了一些基本的收尾工做,返回了应用环境上下文。回顾总体流程,Springboot的启动,主要建立了配置环境(environment)、事件监听(listeners)、应用上下文(applicationContext),并基于以上条件,在容器中开始实例化咱们须要的Bean,至此,经过SpringBoot启动的程序已经构造完成,接下来咱们来探讨自动化配置是如何实现。
自动化配置:
以前的启动结构图中,咱们注意到不管是应用初始化仍是具体的执行过程,都调用了SpringBoot自动配置模块。
该配置模块的主要使用到了SpringFactoriesLoader,即Spring工厂加载器,该对象提供了loadFactoryNames方法,入参为factoryClass和classLoader,即须要传入上图中的工厂类名称和对应的类加载器,方法会根据指定的classLoader,加载该类加器搜索路径下的指定文件,即spring.factories文件,传入的工厂类为接口,而文件中对应的类则是接口的实现类,或最终做为实现类,因此文件中通常为以下图这种一对多的类名集合,获取到这些实现类的类名后,loadFactoryNames方法返回类名集合,方法调用方获得这些集合后,再经过反射获取这些类的类对象、构造方法,最终生成实例。
下图有助于咱们形象理解自动配置流程。
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配置以及复杂的依赖管理,让开发人员能够更加关注业务逻辑的开发。