配置及启动原理解析
一、Profile功能
1、为了方便多环境适配,springboot简化了profile功能。
(1)application-profile功能
- 默认配置文件 application.yaml;任何时候都会加载
- 指定环境配置文件 application-{env}.yaml
- 激活指定环境
- 配置文件激活
- 命令行激活:java -jar xxx.jar --spring.profiles.active=prod --person.name=haha
修改配置文件的任意值,命令行优先
- 默认配置与环境配置同时生效
- 同名配置项,profile配置优先
2、@Profile条件装配功能
@Configuration(proxyBeanMethods = false)
@Profile("production")
public class ProductionConfiguration {
// ...
}
3、profile分组
spring.profiles.group.production[0]=proddb
spring.profiles.group.production[1]=prodmq
使用:--spring.profiles.active=production 激活
二、自定义Starter
我们在使用SpringBoot做应用开发时,可以快速地集成一些开源的框架和组件,一个很重要的原因是Spring Boot为我们提供了自动装配功能,也就是启动器Starter。它帮助我们简化繁琐的配置,让我们能开箱即用。
我们当然也可以编写自己的启动器。假设我们要开发一个公司内部的程序包给各个应用使用,如果要在Spring Boot上下文中使用它的话,最好也为它编写一个启动程序。
本节中,我们一起来一步步地解开Spring Boot 自动配置的神秘面纱。然后,我们将使用这些概念为我们的自定义库创建一个启动器。
1、创建一个maven项目,在pom文件中添加如下依赖:
spring-boot-autoconfigure
此jar包中包含大量核心注解,包含条件注解等。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wisdom</groupId>
<artifactId>spring-boot-starter-hello</artifactId>
<version>1.0-REALEASE</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.0.0.RELEASE</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2、创建properties属性类,用于读取属性
Spring Boot使用一些预置的默认属性值来初始化Bean。为了覆盖这些默认值,我们通常使用一些特定的名称在application.properties文件中声明它们。这些属性Spring Boot容器可以自动获取。
@ConfigurationProperties
配置此注解可以自动导入application.properties
配置文件中的属性,前提需要指定属性前缀prefix。如果application.properties
文件中未指定相应属性,便使用默认的,如上name=“wisdom”,hobby=“basketball”
@ConfigurationProperties(prefix = "com.micah.config")
public class HelloProperties {
private String name = "wisdom";
private String hobby = "basketball";
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getHobby() {
return hobby;
}
public void setHobby(String hobby) {
this.hobby = hobby;
}
}
3、创建配置类
public class HelloConfiguration {
private String name;
private String hobby;
public String getName() {
return "name is " + name;
}
public String getHobby() {
return "hobby is " + hobby;
}
public void setName(String name) {
this.name = name;
}
public void setHobby(String hobby) {
this.hobby = hobby;
}
}
4、创建自动配置类
/**
* @Author m.kong
* @Date 2021/3/29 下午11:28
* @Version 1
* @Description
*/
@Configuration
/**
*启用属性配置,将读取HelloProperties里面的属性。*/
@EnableConfigurationProperties(HelloProperties.class)
/**
* 当类路径下面有HelloServiceConfiguration此类时,自动配置。*/
@ConditionalOnClass(HelloConfiguration.class)
/**
* 判断指定的属性是否具备指定的值。当容器中没有指定bean是,创建此bean。
*/
@ConditionalOnProperty(prefix = "com.micah.config", value = "enabled", matchIfMissing = true)
public class HelloAutoConfiguration {
@Autowired
private HelloProperties helloProperties;
@Bean
@ConditionalOnMissingBean(HelloConfiguration.class)
public HelloConfiguration helloServiceConfiguration() {
HelloConfiguration helloService = new HelloConfiguration();
helloService.setName(helloProperties.getName());
helloService.setHobby(helloProperties.getHobby());
return helloService;
}
}
5、在resources文件夹下面新建一个META-INF文件,并在下面创建spring.factories文件,将上一步中的配置类进行注册。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.micah.config.HelloAutoConfiguration
至此,自定义的hello-spring-boot-starter编写完毕,当然spring boot官方建议对于非官方的starter命名方式为xxx-spring-boot-starter。执行mvn clean install将项目打成一个jar包。
6、新建一个springboot项目,在pom文件中添加刚刚打包的jar的坐标。
<dependency>
<groupId>com.wisdom</groupId>
<artifactId>spring-boot-starter-hello</artifactId>
<version>1.0-REALEASE</version>
</dependency>
在启动类上编写访问接口
@SpringBootApplication
@RestController
public class SpringbootApplication {
@Autowired
private HelloServiceConfiguration helloService;
public static void main(String[] args) {
SpringApplication.run(Springboot03Application.class, args);
}
@RequestMapping("/name")
public String getName() {
return helloService.getName();
}
@RequestMapping("/hobby")
public String getHobby() {
return helloService.getHobby();
}
}
启动此springboot项目,依次访问 localhost:8080/name 和localhost:8080/hobby。
由于没有在application.properties中添加指定属性,所以会使用默认的属性。
接下来在application.properties添加我们自己的属性
com.micah.config.hobby=football
com.micah.config.name=messi
重启springboot项目,继续访问
三、SpringBoot启动原理
版权声明:本节为CSDN博主「javarrr」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/javarrr/article/details/89472495
分析SpringBoot的启动原理,当然是从启动类开始:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
从启动类可知,其启动核心为@SpringBootApplication
和SpringApplication.run()
。
1、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 {
...
}
(1)在其中比较重要的有三个注解,分别是:
-
@SpringBootConfiguration // 继承了Configuration,表示当前是注解类
-
@EnableAutoConfiguration // 开启springboot的注解功能,springboot的四大神器之一,其借助@import的帮助
-
@ComponentScan(excludeFilters = { // 扫描路径设置(具体使用待确认)
接下来对三个注解一一详解,增加对SpringbootApplication
的理解
(2)@Configuration注解
按照原来xml配置文件的形式,在springboot中我们大多用配置类来解决配置问题
配置bean方式的不同:
a)xml配置文件的形式配置bean
<?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>
b)java configuration的配置形式配置bean
@Configuration
public class MockConfiguration{
//bean定义
}
注入bean方式的不同:
a)xml配置文件的形式注入bean
<bean id="mockService" class="..MockServiceImpl">
...
</bean>
b)java configuration的配置形式注入bean
@Configuration
public class MockConfiguration{
@Bean
public MockService mockService(){
return new MockServiceImpl();
}
}
任何一个标注了@Bean的方法,其返回值将作为一个bean定义注册到Spring的IoC容器,方法名将默认成该bean定义的id。
表达bean之间依赖关系的不同:
a)xml配置文件的形式表达依赖关系
<bean id="mockService" class="..MockServiceImpl">
<propery name ="dependencyService" ref="dependencyService" />
</bean>
<bean id="dependencyService" class="DependencyServiceImpl"></bean>
b)java configuration配置的形式表达依赖关系
@Configuration
public class MockConfiguration{
@Bean
public MockService mockService(){
return new MockServiceImpl(dependencyService());
}
@Bean
public DependencyService dependencyService(){
return new DependencyServiceImpl();
}
}
如果一个bean的定义依赖其他bean,则直接调用对应的JavaConfig类中依赖bean的创建方法就可以了。
(3)@ComponentScan注解
作用:
(a)对应xml配置中的元素;
(b)ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义;
(c) 将这些bean定义加载到IoC容器中.
我们可以通过basePackages等属性来定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。
注:所以SpringBoot的启动类最好是放在root package下,因为默认不指定basePackages。
(4)@EnableAutoConfiguration
此注解顾名思义是可以自动配置,所以应该是springboot中最为重要的注解。
在spring框架中就提供了各种以@Enable开头的注解,例如: @EnableScheduling、@EnableCaching、@EnableMBeanExport等; @EnableAutoConfiguration的理念和做事方式其实一脉相承简单概括一下就是,借助@Import的支持,收集和注册特定场景相关的bean定义。
- @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器【定时任务、时间调度任务】
- @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器【监控JVM运行时状态】
- @EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器。
@EnableAutoConfiguration作为一个复合Annotation,其自身定义关键信息如下:
@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage【重点注解】
@Import(EnableAutoConfigurationImportSelector.class)【重点注解】
public @interface EnableAutoConfiguration {
...
}
其中最重要的两个注解已经标注:
1、@AutoConfigurationPackage
【重点注解】
2、@Import(EnableAutoConfigurationImportSelector.class)
【重点注解】
当然还有其中比较重要的一个类就是:EnableAutoConfigurationImportSelector.class
AutoConfigurationPackage注解:
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
@Override
public void registerBeanDefinitions(AnnotationMetadata metadata,BeanDefinitionRegistry registry) {
register(registry, new PackageImport(metadata).getPackageName());
}
它其实是注册了一个Bean的定义。
new PackageImport(metadata).getPackageName()
,它其实返回了当前主程序类的 同级以及子级 的包组件。
以上图为例,MyStarterApplication是和mystarter包同级,但是demo2这个类是DemoApplication的父级,和example包同级
也就是说,MyStarterApplication启动加载的Bean中,并不会加载demo2,这也就是为什么,我们要把DemoApplication放在项目的最高级中。
Import(AutoConfigurationImportSelector.class)
注解:
可以从图中看出 AutoConfigurationImportSelector 继承了 DeferredImportSelector 继承了 ImportSelector
ImportSelector有一个方法为:selectImports。
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
AnnotationAttributes attributes = getAttributes(annotationMetadata);
List<String> configurations = getCandidateConfigurations(annotationMetadata,attributes);
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = filter(configurations, autoConfigurationMetadata);
fireAutoConfigurationImportEvents(configurations, exclusions);
return StringUtils.toStringArray(configurations);
}
可以看到第九行,它其实是去加载 public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
外部文件。这个外部文件,有很多自动配置的类。如下:
其中,最关键的要属@Import(EnableAutoConfigurationImportSelector.class)
,借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。就像一只“八爪鱼”一样。
自动配置幕后英雄:SpringFactoriesLoader
详解
借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成!
SpringFactoriesLoader
属于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容器。
2、启动原理
SpringApplication的run方法的实现是我们本次旅程的主要线路,该方法的主要流程大体可以归纳如下:
时序图:
(1) 如果我们使用的是SpringApplication的静态run方法,那么,这个方法里面首先要创建一个SpringApplication对象实例,然后调用这个创建好的SpringApplication的实例方法。在SpringApplication实例初始化的时候,它会提前做几件事情:
public static ConfigurableApplicationContext run(Object[] sources, String[] args) {
return new SpringApplication(sources).run(args);
}
- 根据classpath里面是否存在某个特征类(
org.springframework.web.context.ConfigurableWebApplicationContext
)来决定是否应该创建一个为Web应用使用的ApplicationContext类型。 - 使用
SpringFactoriesLoader
在应用的classpath
中查找并加载所有可用的ApplicationContextInitializer
。 - 使用
SpringFactoriesLoader
在应用的classpath
中查找并加载所有可用的ApplicationListener
。 - 推断并设置main方法的定义类。
@SuppressWarnings({ "unchecked", "rawtypes" })
private void initialize(Object[] sources) {
if (sources != null && sources.length > 0) {
this.sources.addAll(Arrays.asList(sources));
}
this.webEnvironment = deduceWebEnvironment();
setInitializers((Collection) getSpringFactoriesInstances(
ApplicationContextInitializer.class));
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
this.mainApplicationClass = deduceMainApplicationClass();
}
(2)SpringApplication实例初始化完成并且完成设置后,就开始执行run方法的逻辑了,方法执行伊始,首先遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener。调用它们的started()方法,告诉这些SpringApplicationRunListener,“嘿,SpringBoot应用要开始执行咯!”。
public ConfigurableApplicationContext run(String... args) {
StopWatch stopWatch = new StopWatch();
stopWatch.start();
ConfigurableApplicationContext context = null;
FailureAnalyzers analyzers = null;
configureHeadlessProperty();
SpringApplicationRunListeners listeners = getRunListeners(args);
listeners.starting();
try {
ApplicationArguments applicationArguments = new DefaultApplicationArguments(
args);
ConfigurableEnvironment environment = prepareEnvironment(listeners,
applicationArguments);
Banner printedBanner = printBanner(environment);
context = createApplicationContext();
analyzers = new FailureAnalyzers(context);
prepareContext(context, environment, listeners, applicationArguments,
printedBanner);
// 核心点:会打印springboot的启动标志,直到server.port端口启动
refreshContext(context);
afterRefresh(context, applicationArguments);
listeners.finished(context, null);
stopWatch.stop();
if (this.logStartupInfo) {
new StartupInfoLogger(this.mainApplicationClass)
.logStarted(getApplicationLog(), stopWatch);
}
return context;
}
catch (Throwable ex) {
handleRunFailure(context, listeners, analyzers, ex);
throw new IllegalStateException(ex);
}
}
(3) 创建并配置当前Spring Boot应用将要使用的Environment(包括配置要使用的PropertySource以及Profile)。
private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners,ApplicationArguments applicationArguments) {
// Create and configure the environment
ConfigurableEnvironment environment = getOrCreateEnvironment();
configureEnvironment(environment, applicationArguments.getSourceArgs());
listeners.environmentPrepared(environment);
if (!this.webEnvironment) {
environment = new EnvironmentConverter(getClassLoader()).convertToStandardEnvironmentIfNecessary(environment);
}
return environment;
}
(4) 遍历调用所有SpringApplicationRunListener
的environmentPrepared()
的方法,告诉他们:“当前SpringBoot应用使用的Environment准备好了咯!”。
public void environmentPrepared(ConfigurableEnvironment environment) {
for (SpringApplicationRunListener listener : this.listeners) {
listener.environmentPrepared(environment);
}
}
(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
,然后遍历调用这些ApplicationContextInitializer的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,<br>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);
}
}