致力于最高效的Java學習
@Component
public class Person {
@Value('i am name')
private String name;
}
<bean class='Person'>
<property name ='name' value='i am name'></property>
</bean>
${key}
方式從環(huán)境變量中獲取值${key}
方式全局配置文件中獲取值#{SpEL}
@Value(${key})
的方式獲取全局配置文件中的指定配置項。@Value
的方式去配置項需要一個一個去取,這就顯得有點 low 了。我們可以使用 @ConfigurationProperties
。@ConfigurationProperties
的類的所有屬性和配置文件中相關的配置項進行綁定。(默認從全局配置文件中獲取配置值),綁定之后我們就可以通過這個類去訪問全局配置文件中的屬性值了。person.name=kundy
person.age=13
person.sex=male
@Component
@ConfigurationProperties(prefix = 'person')
public class Person {
private String name;
private Integer age;
private String sex;
}
@ConfigurationProperties
有一個 prefix 參數(shù),主要是用來指定該配置項在配置文件中的前綴。public class Circle {
public void sayHi() {
System.out.println('Circle sayHi()');
}
}
@Import({Circle.class})
@Configuration
public class MainConfig {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
Circle circle = context.getBean(Circle.class);
circle.sayHi();
}
Circle sayHi()
public class Triangle {
public void sayHi(){
System.out.println('Triangle sayHi()');
}
}
public class MyImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
return new String[]{'annotation.importannotation.waytwo.Triangle'};
}
}
@Import({Circle.class,MyImportSelector.class})
@Configuration
public class MainConfigTwo {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigTwo.class);
Circle circle = context.getBean(Circle.class);
Triangle triangle = context.getBean(Triangle.class);
circle.sayHi();
triangle.sayHi();
}
Circle sayHi()
Triangle sayHi()
public class Rectangle {
public void sayHi() {
System.out.println('Rectangle sayHi()');
}
}
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Rectangle.class);
// 注冊一個名字叫做 rectangle 的 bean
beanDefinitionRegistry.registerBeanDefinition('rectangle', rootBeanDefinition);
}
}
@Import({Circle.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class})
@Configuration
public class MainConfigThree {
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigThree.class);
Circle circle = context.getBean(Circle.class);
Triangle triangle = context.getBean(Triangle.class);
Rectangle rectangle = context.getBean(Rectangle.class);
circle.sayHi();
triangle.sayHi();
rectangle.sayHi();
}
Circle sayHi()
Triangle sayHi()
Rectangle sayHi()
@Conditional 注釋可以實現(xiàn)只有在特定條件滿足時才啟用一些配置。
public class ConditionBean {
public void sayHi() {
System.out.println('ConditionBean sayHi()');
}
}
public class MyCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
return true;
}
}
@Configuration
@Conditional(MyCondition.class)
public class ConditionConfig {
@Bean
public ConditionBean conditionBean(){
return new ConditionBean();
}
}
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class);
ConditionBean conditionBean = context.getBean(ConditionBean.class);
conditionBean.sayHi();
}
SpringApplication.run() -> run(new Class[]{primarySource}, args) -> new SpringApplication(primarySources)).run(args)
。new SpringApplication(primarySources)).run(args)
這個方法。public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
this.sources = new LinkedHashSet();
this.bannerMode = Mode.CONSOLE;
this.logStartupInfo = true;
this.addCommandLineProperties = true;
this.addConversionService = true;
this.headless = true;
this.registerShutdownHook = true;
this.additionalProfiles = new HashSet();
this.isCustomEnvironment = false;
this.resourceLoader = resourceLoader;
Assert.notNull(primarySources, 'PrimarySources must not be null');
// 保存主配置類(這里是一個數(shù)組,說明可以有多個主配置類)
this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
// 判斷當前是否是一個 Web 應用
this.webApplicationType = WebApplicationType.deduceFromClasspath();
// 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationContextInitializer,然后保存起來
this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
// 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationListener,然后保存起來
this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
// 從多個配置類中找到有 main 方法的主配置類(只有一個)
this.mainApplicationClass = this.deduceMainApplicationClass();
}
public ConfigurableApplicationContext run(String... args) {
// 創(chuàng)建計時器
StopWatch stopWatch = new StopWatch();
stopWatch.start();
// 聲明 IOC 容器
ConfigurableApplicationContext context = null;
Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
this.configureHeadlessProperty();
// 從類路徑下找到 META/INF/Spring.factories 獲取 SpringApplicationRunListeners
SpringApplicationRunListeners listeners = this.getRunListeners(args);
// 回調所有 SpringApplicationRunListeners 的 starting() 方法
listeners.starting();
Collection exceptionReporters;
try {
// 封裝命令行參數(shù)
ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
// 準備環(huán)境,包括創(chuàng)建環(huán)境,創(chuàng)建環(huán)境完成后回調 SpringApplicationRunListeners#environmentPrepared()方法,表示環(huán)境準備完成
ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);
this.configureIgnoreBeanInfo(environment);
// 打印 Banner
Banner printedBanner = this.printBanner(environment);
// 創(chuàng)建 IOC 容器(決定創(chuàng)建 web 的 IOC 容器還是普通的 IOC 容器)
context = this.createApplicationContext();
exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[]{ConfigurableApplicationContext.class}, context);
/*
* 準備上下文環(huán)境,將 environment 保存到 IOC 容器中,并且調用 applyInitializers() 方法
* applyInitializers() 方法回調之前保存的所有的 ApplicationContextInitializer 的 initialize() 方法
* 然后回調所有的 SpringApplicationRunListener#contextPrepared() 方法
* 最后回調所有的 SpringApplicationRunListener#contextLoaded() 方法
*/
this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
// 刷新容器,IOC 容器初始化(如果是 Web 應用還會創(chuàng)建嵌入式的 Tomcat),掃描、創(chuàng)建、加載所有組件的地方
this.refreshContext(context);
// 從 IOC 容器中獲取所有的 ApplicationRunner 和 CommandLineRunner 進行回調
this.afterRefresh(context, applicationArguments);
stopWatch.stop();
if (this.logStartupInfo) {
(new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
}
// 調用 所有 SpringApplicationRunListeners#started()方法
listeners.started(context);
this.callRunners(context, applicationArguments);
} catch (Throwable var10) {
this.handleRunFailure(context, var10, exceptionReporters, listeners);
throw new IllegalStateException(var10);
}
try {
listeners.running(context);
return context;
} catch (Throwable var9) {
this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners)null);
throw new IllegalStateException(var9);
}
}
@SpringBootConfiguration@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
}
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
@Import({Registrar.class})
,導入了一個 Registrar 的組件。關于 @Import 的用法文章上面也有介紹哦。getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames()
。loadFactoryNames()
方法傳入了 EnableAutoConfiguration.class 這個參數(shù)。先記住這個參數(shù),等下會用到。META-INF/spring.factories
這類文件是什么就不懵了。當然在很多第三方依賴中都會有這個文件,一般每導入一個第三方的依賴,除了本身的jar包以外,還會有一個 xxx-spring-boot-autoConfigure,這個就是第三方依賴自己編寫的自動配置類。我們現(xiàn)在就以 spring-boot-autocongigure 這個依賴來說。可以看到 EnableAutoConfiguration 下面有很多類,這些就是我們項目進行自動配置的類。
一句話:將類路徑下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。
HttpEncodingAutoConfiguration
通過上面方式,所有的自動配置類就被導進主配置類中了。但是這么多的配置類,明顯有很多自動配置我們平常是沒有使用到的,沒理由全部都生效吧。
接下來我們以 HttpEncodingAutoConfiguration為例來看一個自動配置類是怎么工作的。為啥選這個類呢?主要是這個類比較的簡單典型。
先看一下該類標有的注解:
@Configuration
@EnableConfigurationProperties({HttpProperties.class})
@ConditionalOnWebApplication(
type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(
prefix = 'spring.http.encoding',
value = {'enabled'},
matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
}
@EnableConfigurationProperties({HttpProperties.class})
把配置文件中的配置項與當前 HttpProperties 類綁定上了。@ConfigurationProperties(
prefix = 'spring.http'
)// 從配置文件中獲取指定的值和bean的屬性進行綁定
public class HttpProperties {
}
SpringBoot啟動會加載大量的自動配置類。
我們看需要的功能有沒有SpringBoot默認寫好的自動配置類。
我們再來看這個自動配置類中到底配置了那些組件(只要我們要用的組件有,我們就不需要再來配置了)。
給容器中自動配置類添加組件的時候,會從properties類中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值。
xxxAutoConfiguration:自動配置類給容器中添加組件。
xxxProperties:封裝配置文件中相關屬性。
不知道小伙伴們有沒有發(fā)現(xiàn),很多需要待加載的類都放在類路徑下的META-INF/Spring.factories 文件下,而不是直接寫死這代碼中,這樣做就可以很方便我們自己或者是第三方去擴展,我們也可以實現(xiàn)自己 starter,讓SpringBoot 去加載?,F(xiàn)在明白為什么 SpringBoot 可以實現(xiàn)零配置,開箱即用了吧!