自动配置
Spring使用@Configuration作为配置的注解,当Spring发现某个类使用了@Configuration标注了,就去将该类下寻找使用@Bean注解的方法创建bean并放入到容器中
@Configuration
spring boot的自动配置是通过@ConditionalOnXxx(@ConditionalOnClass、@ConditionalOnMissingBean等)
来实现的,该类型的注解都是基于@Conditional注解来实现的
关于自动配置可以通过浏览spring-boot-autoconfigure.jar下的spring.factories配置文件,查看所有的自动配置
理解Spring Boot的自动配置先要理解@Conditional注解
@Bean: 将当前对象放入到Spring的IOC容器中来管理
@Conditional:满足特定条件时才会创建一个Bean放入到IOC容器,SpringBoot就是利用这个特性进行自动配置的
写一个小示例来理解下@Conditional的作用: 在不同的操作系统中列举某个目录下的文件的命令是不同的,类unix系统使用ls命令,windows命令使用dir命令。现在定义两个类分别对应着两种系统,只将当前系统对应的类放入到IOC容器中,另一个类不放进IOC中
代码:
OnWindowsCondition
public class OnWindowsCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
return conditionContext.getEnvironment().getProperty("os.name").contains("Windows");
}
}
OnUnixCondition
public class OnUnixCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
String osName = conditionContext.getEnvironment().getProperty("os.name");
return osName.contains("unix") || osName.contains("linux") || osName.contains("Mac OS X");
}
}
ListService
public interface ListService {
public String cmd();
}
public class WindowsListService implements ListService {
@Override
public String cmd() {
return "dir";
}
}
public class UnixListService implements ListService {
@Override
public String cmd() {
return "ls";
}
}
ListSesrviceConfig
使用@Bean来标注将对象放入到IOC容器中,但是如果有@Conditional只有在满足条件注解才会将对象放入到IOC容器中,不满足就不会放入容器
@Configuration
public class ListSesrviceConfig {
@Bean
@Conditional(OnWindowsCondition.class)
public ListService windowsListService(){
return new WindowsListService();
}
@Bean
@Conditional(OnUnixCondition.class)
public ListService unixListService(){
return new UnixListService();
}
}
main()
会根据context.getEnvironment().getProperty(“os.name”)获取当前的系统环境.在Windows电脑上运行就会装载
WindowsListService,在Linux等环境上运行就会装载UnixListService
@ConditionalOnXxx都是组合@Conditional元注解,使用了不同的条件Condition
- @ConditionalOnBean:当容器里有指定Bean的条件下
- @ConditionalOnClass:当类路径下有指定类的条件下
- @ConditionalOnExpression:基于SpEL表达式作为判断条件
- @ConditionalOnJava:基于JV版本作为判断条件
- @ConditionalOnJndi:在JNDI存在的条件下差在指定的位置
- @ConditionalOnMissingBean:当容器里没有指定Bean的情况下
- @ConditionalOnMissingClass:当类路径下没有指定类的条件下
- @ConditionalOnNotWebApplication:当前项目不是Web项目的条件下
- @ConditionalOnProperty:指定的属性是否有指定的值
- @ConditionalOnResource:类路径是否有指定的资源
- @ConditionalOnSingleCandidate:当指定Bean在容器中只有一个,或者虽然有多个但是指定首选Bean
- @ConditionalOnWebApplication:当前项目是Web项目的条件下
@SpringBootApplication
启动入口:Application
@SpringBootApplication
public class SpringBootDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootDemoApplication.class, args);
}
}
@SpringBootApplication 是一个复合注解,由以下3个注解组成:
- @SpringBootConfiguration
- @EnableAutoConfiguration
- @ComponentScan
其中@SpringBootConfiguration实际上是@Configuration
@SpringBootConfiguration
将@SpringBootApplication注解替换成其等价的三个注解是完全的相等的,可以启动并正常访问
@ComponentScan
组件扫描这注解,即使没有使用过注解也经常在spring的配置文件中使用过
<context:component-scan base-package=“com.xxx.xxx”/>, 组件扫描就是扫描指定的包下的类,并加载符合条件的组件(比如@Component、@Service、@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中,如果不指定basePackage则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。Spring Boot 中的@ComponentScan没有指定basePackage,所以会从.下开始扫描,所以,一般Application类要放在groupId.artifactId包下
@Configuration
@Configuration 就是指的Java Config(Java 配置),是一个Ioc容器类,相当于传统项目中见到的一个spring 的xml配置文件
一个空Java Config类 相当于一个空的xml配置文件,都是用来作为配置bean的容器
在xml中配置一个bean,就等于在Java Config中定义一个方法,使用@Bean注解就相当于xml中的bean标签,bean标签中的id就是方法的名称, bean标签中的class就是Java Config中的返回值,Java Config中的方法的内部就是创建一个实例
xml中一个bean的属性需要引用另一个bean时,在Java Config中需要先定义出需要的依赖类,然后通过Setter方法或者构造方法给依赖的属性赋值,从而创建出一个完整的实例
@EnableAutoConfiguration
Spring中有很多以Enable开头的注解,其作用就是借助@Import来收集并注册特定场景相关的bean,并加载到IoC容器。@EnableAutoConfiguration就是借助@Import来收集所有符合自动配置条件的bean定义,并加载到IoC容器
@EnableAutoConfiguration通过@Import中的AutoConfigurationImportSelector,可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器(ApplicationContext)
SpringFactoriesLoader
主要功能就是从指定的配置文件META-INF/spring.factories加载配置。配合@EnableAutoConfiguration使用的话,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,
获取对应的一组@Configuration类
spring.factories
@EnableAutoConfiguration自动配置就是从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射(Java Refletion)实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类,然后汇总为一个并加载到IoC容器。
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()方法,只不过这种情况下会将异常信息一并传入处理)
去除事件通知点后,整个流程如下: