Spring的@PropertySource注解源碼解析
一、源碼時序圖
本節(jié)，就以源碼時序圖的方式，直觀的感受下@PropertySource注解在Spring源碼層面的執(zhí)行流程。
@PropertySource注解在Spring源碼層面的執(zhí)行流程如圖所示：
由圖可以看出，@PropertySource注解在Spring源碼層面的執(zhí)行流程會涉及到PropertySourceTest類、AnnotationConfigApplicationContext類、AbstractApplicationContext類、PostProcessorRegistrationDelegate類、ConfigurationClassPostProcessor類、ConfigurationClassParser類、PropertySourceRegistry類、PropertySourceProcessor類和DefaultPropertySourceFactory類。具體的源碼執(zhí)行細(xì)節(jié)參見源碼解析部分。
二、源碼解析
@PropertySource注解在Spring源碼層面的執(zhí)行流程，結(jié)合源碼執(zhí)行的時序圖，會理解的更加深刻。
1. 運行案例程序啟動類
在PropertySourceTest類的main()方法中調(diào)用了AnnotationConfigApplicationContext類的構(gòu)造方法，并傳入了PropertySourceConfig類的Class對象來創(chuàng)建IOC容器。
接下來，會進(jìn)入AnnotationConfigApplicationContext類的構(gòu)造方法。
注意：@PropertySource注解在Spring源碼中的執(zhí)行流程的（2）~（11）步與前面章節(jié)的@Import注解相同，這里不再贅述，直接跳到ConfigurationClassParser類的doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass, Predicatefilter)方法。
2. 解析ConfigurationClassParser類的doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass, Predicatefilter)方法
protected final SourceClass doProcessConfigurationClass(
ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter)
throws IOException {
//#############省略其他代碼################
for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), PropertySources.class,
org.springframework.context.annotation.PropertySource.class)) {
if (this.propertySourceRegistry != null) {
this.propertySourceRegistry.processPropertySource(propertySource);
}
}
//#############省略其他代碼################
}
可以看到，在ConfigurationClassParser類的doProcessConfigurationClass()方法中，遍歷獲取到的@PropertySources注解和@PropertySource注解的屬性，并且調(diào)用propertySourceRegistry對象的processPropertySource()方法解析注解屬性的值。
3. 解析PropertySourceRegistry類的processPropertySource(AnnotationAttributes propertySource)方法
void processPropertySource(AnnotationAttributes propertySource) throws IOException {
String name = propertySource.getString("name");
if (!StringUtils.hasLength(name)) {
name = null;
}
String encoding = propertySource.getString("encoding");
if (!StringUtils.hasLength(encoding)) {
encoding = null;
}
String[] locations = propertySource.getStringArray("value");
Assert.isTrue(locations.length > 0, "At least one @PropertySource(value) location is required");
boolean ignoreResourceNotFound = propertySource.getBoolean("ignoreResourceNotFound");
Class<? extends PropertySourceFactory> factoryClass = propertySource.getClass("factory");
Class<? extends PropertySourceFactory> factorClassToUse = (factoryClass != PropertySourceFactory.class ? factoryClass : null);
PropertySourceDescriptor descriptor = new PropertySourceDescriptor(Arrays.asList(locations), ignoreResourceNotFound, name, factorClassToUse, encoding);
this.propertySourceProcessor.processPropertySource(descriptor);
this.descriptors.add(descriptor);
}
可以看到，在PropertySourceRegistry類的processPropertySource()方法中，解析@PropertySource注解中的屬性后，將解析出的屬性值封裝到PropertySourceDescriptor對象中，調(diào)用propertySourceProcessor對象的processPropertySource()方法，并傳入PropertySourceDescriptor對象進(jìn)行進(jìn)一步處理。
4. 解析PropertySourceProcessor類的processPropertySource(PropertySourceDescriptor descriptor)方法
public void processPropertySource(PropertySourceDescriptor descriptor) throws IOException {
String name = descriptor.name();
String encoding = descriptor.encoding();
List<String> locations = descriptor.locations();
Assert.isTrue(locations.size() > 0, "At least one @PropertySource(value) location is required");
boolean ignoreResourceNotFound = descriptor.ignoreResourceNotFound();
PropertySourceFactory factory = (descriptor.propertySourceFactory() != null ? instantiateClass(descriptor.propertySourceFactory()) : DEFAULT_PROPERTY_SOURCE_FACTORY);
for (String location : locations) {
try {
String resolvedLocation = this.environment.resolveRequiredPlaceholders(location);
Resource resource = this.resourceLoader.getResource(resolvedLocation);
addPropertySource(factory.createPropertySource(name, new EncodedResource(resource, encoding)));
}
catch (IllegalArgumentException | FileNotFoundException | UnknownHostException | SocketException ex) {
//#########省略其他代碼################
}
}
}
可以看到，在processPropertySource()方法中，會通過@PropertySource注解的屬性值解析出配置文件的內(nèi)容，并且通過factory對象的createPropertySource()方法來創(chuàng)建PropertySource對象。
5. 解析DefaultPropertySourceFactory類的createPropertySource(String name, EncodedResource resource)方法
@Override
public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
return (name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource));
}
6. 回到PropertySourceProcessor類的processPropertySource(PropertySourceDescriptor descriptor)方法
在PropertySourceProcessor類的processPropertySource()方法中，創(chuàng)建完P(guān)ropertySource對象后，會調(diào)用addPropertySource()方法將獲取到的屬性值添加到Spring的環(huán)境變量中。
7. 解析PropertySourceProcessor類的addPropertySource(PropertySource<?> propertySource)方法
private void addPropertySource(org.springframework.core.env.PropertySource<?> propertySource) {
String name = propertySource.getName();
MutablePropertySources propertySources = this.environment.getPropertySources();
if (this.propertySourceNames.contains(name)) {
org.springframework.core.env.PropertySource<?> existing = propertySources.get(name);
if (existing != null) {
PropertySource<?> newSource = (propertySource instanceof ResourcePropertySource ?((ResourcePropertySource) propertySource).withResourceName() : propertySource);
if (existing instanceof CompositePropertySource) {
((CompositePropertySource) existing).addFirstPropertySource(newSource);
}
else {
if (existing instanceof ResourcePropertySource) {
existing = ((ResourcePropertySource) existing).withResourceName();
}
CompositePropertySource composite = new CompositePropertySource(name);
composite.addPropertySource(newSource);
composite.addPropertySource(existing);
propertySources.replace(name, composite);
}
return;
}
}
if (this.propertySourceNames.isEmpty()) {
propertySources.addLast(propertySource);
}
else {
String firstProcessed = this.propertySourceNames.get(this.propertySourceNames.size() - 1);
propertySources.addBefore(firstProcessed, propertySource);
}
this.propertySourceNames.add(name);
}
可以看到，在PropertySourceProcessor類的addPropertySource()方法中，會將解析出的配置文件的內(nèi)容添加到Spring的環(huán)境變量中。
具體就是在PropertySourceProcessor類的addPropertySource()方法中，獲取到ConfigurableEnvironment中的MutablePropertySources對象，用來存儲解析出的配置文件中的配置項內(nèi)容。
如果有相同的配置項內(nèi)容，將existing對象強轉(zhuǎn)為CompositePropertySource類型，把新舊相同的配置項進(jìn)行合并，再放到MutablePropertySources對象中。
后續(xù)就可以通過Spring的環(huán)境變量，來獲取到配置文件中的配置項內(nèi)容。
至此，@PropertySource注解在Spring源碼中的執(zhí)行流程分析完畢。
到此這篇關(guān)于Spring的@PropertySource注解源碼解析的文章就介紹到這了,更多相關(guān)@PropertySource注解源碼內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java中Word與PDF轉(zhuǎn)換為圖片的方法詳解
這篇文章主要為大家詳細(xì)介紹了如何使用Java實現(xiàn)將Word與PDF轉(zhuǎn)換為圖片,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-10-10
解決jasperreport導(dǎo)出的pdf每頁顯示的記錄太少問題
這篇文章主要介紹了解決jasperreport導(dǎo)出的pdf每頁顯示的記錄太少問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
下面小編就為大家?guī)硪黄猨ava 將方法作為傳參--多態(tài)的實例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-09-09
一個線程在給定的時間點只能處于一種狀態(tài)。線程可以有6種狀態(tài)：New、Runnable、Blocked、Waiting、Timed?waiting和Terminated。本文將詳細(xì)講解這6種狀態(tài)，需要的可以參考一下2022-05-05
這篇文章主要介紹了前置++和后置++ 的相關(guān)資料,并附示例代碼，幫助大家學(xué)習(xí)參考，需要的朋友可以參考下2016-09-09
springboot本地調(diào)試沒問題,打包運行報錯原因及分析
這篇文章主要介紹了springboot本地調(diào)試沒問題,打包運行報錯原因及分析，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-05-05
Java使用正則表達(dá)式(regex)匹配中文實例代碼
本文給大家分享java使用正則表達(dá)式匹配中文的實例代碼，以及java中要匹配中文的正則表達(dá)式兩種寫法，感興趣的朋友通過本文一起看看吧2016-12-12
SpringBoot中的異常處理與參數(shù)校驗的方法實現(xiàn)
這篇文章主要介紹了SpringBoot中的異常處理與參數(shù)校驗的方法實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-04-04
這篇文章主要介紹了 Java動態(tài)代理機制的實例詳解的相關(guān)資料,希望通過本文大家能夠掌握動態(tài)代理機制，需要的朋友可以參考下2017-09-09
解決mybatis-generator生成Mapper文件沒有Selective結(jié)尾的問題
這篇文章主要介紹了解決mybatis-generator生成Mapper文件沒有Selective結(jié)尾的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09