主程序(重要)
//@SpringBootApplication 標(biāo)注,是一個(gè)SpringBoot應(yīng)用
@SpringBootApplication
public class SpringbootdemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootdemoApplication.class, args);
}
}
再寫SpringBoot項(xiàng)目的時(shí)候,總要寫這么一個(gè)主程序,這個(gè)主程序最大的特點(diǎn)就是其類上放了一個(gè)@SpringBootApplication注解,這也正是SpringBoot項(xiàng)目啟動(dòng)的核心,也是我們要研究的重點(diǎn)。
注意:之后的分析可能會(huì)深入源碼,源碼是一層一層嵌套的,所以光靠文字說明會(huì)比較難以理解,最好是自己在IDE環(huán)境下跟著一步一步跟著點(diǎn)下去。當(dāng)然也可以繞過這一部分直接看結(jié)論。
點(diǎn)開@SpringBootApplication,可以發(fā)現(xiàn)它是一個(gè)組合注解,主要是由這么幾個(gè)注解構(gòu)成的。
@SpringBootConfiguration//核心
@EnableAutoConfiguration//核心
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
我們首先要研究的就是核心的兩個(gè)注解 @SpringBootConfiguration和 @EnableAutoConfiguration ,逐個(gè)進(jìn)行分析。
@SpringBootConfiguration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}
可以看到SpringBootConfiguration其實(shí)就攜帶了一個(gè)@Configuration注解,這個(gè)注解我們?cè)偈煜げ贿^了,他就代表自己是一個(gè)Spring的配置類。所以我們可以認(rèn)為:@SpringBootConfiguration = @Configuration
@EnableAutoConfiguration
顧名思義,這個(gè)注解一定和自動(dòng)配置相關(guān),點(diǎn)進(jìn)去看源代碼之后可以發(fā)現(xiàn),其內(nèi)部就包含了這么兩個(gè)注解。
@AutoConfigurationPackage //自動(dòng)配置包
@Import(AutoConfigurationImportSelector.class)//自動(dòng)配置導(dǎo)入選擇
來看看@Import(AutoConfigurationImportSelector.class)
中的內(nèi)容:
它幫我們導(dǎo)入了AutoConfigurationImportSelector,這個(gè)類中存在一個(gè)方法可以幫我們獲取所有的配置,代碼如下。
/*
所有的配置都存放在configurations中,
而這些配置都從getCandidateConfiguration中獲取,
這個(gè)方法是用來獲取候選的配置。
*/
List
getCandidateConfigurations():
這個(gè)方法可以用來獲取所有候選的配置,那么這些候選的配置又是從哪來的呢?
/*獲取候選的配置*/
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}
實(shí)際上它返回了一個(gè)List,這個(gè)List是由 loadFactoryNames() 方法返回的,其中傳入了一個(gè)getSpringFactoriesLoaderFactoryClass(),我們可以看看這個(gè)方法的內(nèi)容。
protected Class? getSpringFactoriesLoaderFactoryClass() {
return EnableAutoConfiguration.class;
}
我們看到了一個(gè)眼熟的詞 —— EnableAutoConfiguration ,也就是說,它實(shí)際上返回的就是標(biāo)注了這個(gè)類的所有包。標(biāo)注了這個(gè)類的包不就是@SpringBootApplication
嗎?
所以我們可以得出結(jié)論:它兜兜轉(zhuǎn)轉(zhuǎn)繞了這么多地方,就是為了將啟動(dòng)類所需的所有資源導(dǎo)入。
我們接著往下看,它其中還有這么一條語句,是一條斷言:
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
這個(gè)斷言的意思是,configurations必須非空,否則就打印一段話,No auto configuration classes found in META-INF/spring.factories
,我們把這個(gè)邏輯反過來想想。如果這個(gè)集合不為空,是不是就代表找到了這個(gè)spring.factories并且會(huì)去加載這個(gè)文件中的內(nèi)容呢?
帶著這個(gè)疑問,我們首先找到spring.factories這個(gè)文件:
可以看到里面包含了很多自動(dòng)配置屬性:
我們可以隨便找一個(gè)自動(dòng)配置點(diǎn)進(jìn)去,比如WebMvcAutoConfiguration
:
這里放了所有關(guān)于WebMvc的配置,如視圖解析器、國際化等等。
分析到這里,我們就可以得出一個(gè)完整的結(jié)論了:
當(dāng)我們的SpringBoot項(xiàng)目啟動(dòng)的時(shí)候,會(huì)先導(dǎo)入AutoConfigurationImportSelector,這個(gè)類會(huì)幫我們選擇所有候選的配置,我們需要導(dǎo)入的配置都是SpringBoot幫我們寫好的一個(gè)一個(gè)的配置類,那么這些配置類的位置,存在與META-INF/spring.factories文件中,通過這個(gè)文件,Spring可以找到這些配置類的位置,于是去加載其中的配置。
看到這里,可能有些同學(xué)會(huì)存在疑問,spring.factories中存在那么多的配置,每次啟動(dòng)時(shí)都是把它們?nèi)考虞d嗎?這顯然是不現(xiàn)實(shí)的。
這其實(shí)也是我在看源碼的時(shí)候存在疑問的地方,因?yàn)槠渲杏幸粋€(gè)注解并不常用,我們點(diǎn)開一個(gè)配置類就可以看到。
@ConditionalOnXXX:如果其中的條件都滿足,該類才會(huì)生效。
所以在加載自動(dòng)配置類的時(shí)候,并不是將spring.factories的配置全量加載進(jìn)來,而是通過這個(gè)注解的判斷,如果注解中的類都存在,才會(huì)進(jìn)行加載。
所以就實(shí)現(xiàn)了:我們?cè)趐om.xml文件中加入stater啟動(dòng)器,SpringBoot自動(dòng)進(jìn)行配置。完成開箱即用。
結(jié)論
SpringBoot所有自動(dòng)配置類都是在啟動(dòng)的時(shí)候進(jìn)行掃描并加載,通過spring.factories可以找到自動(dòng)配置類的路徑,但是不是所有存在于spring,factories中的配置都進(jìn)行加載,而是通過@ConditionalOnClass注解進(jìn)行判斷條件是否成立(只要導(dǎo)入相應(yīng)的stater,條件就能成立),如果條件成立則加載配置類,否則不加載該配置類。
在這里貼一個(gè)我認(rèn)為的比較容易理解的過程:
- SpringBoot在啟動(dòng)的時(shí)候從類路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值
- 將這些值作為自動(dòng)配置類導(dǎo)入容器 , 自動(dòng)配置類就生效 , 幫我們進(jìn)行自動(dòng)配置工作;
- 以前我們需要自己配置的東西 , 自動(dòng)配置類都幫我們解決了
- 整個(gè)J2EE的整體解決方案和自動(dòng)配置都在springboot-autoconfigure的jar包中;
- 它將所有需要導(dǎo)入的組件以全類名的方式返回 , 這些組件就會(huì)被添加到容器中 ;
- 它會(huì)給容器中導(dǎo)入非常多的自動(dòng)配置類 (xxxAutoConfiguration), 就是給容器中導(dǎo)入這個(gè)場景需要的所有組件 , 并配置好這些組件 ;
- 有了自動(dòng)配置類 , 免去了我們手動(dòng)編寫配置注入功能組件等的工作;
摘自https://blog.kuangstudy.com/index.php/archives/630/
約定大于配置
開箱即用的原理說完了,約定大于配置就比較好理解了。其實(shí)約定大于配置就是開箱即用中那些自動(dòng)配置的細(xì)節(jié)。說的具體點(diǎn)就是: 我們的配置文件(.yml)應(yīng)該放在哪個(gè)目錄下,配置文件的命名規(guī)范,項(xiàng)目啟動(dòng)時(shí)掃描的Bean,組件的默認(rèn)配置是什么樣的(比如SpringMVC的視圖解析器)等等等等這一系列的東西,都可以被稱為約定 ,下面就來一點(diǎn)一點(diǎn)地說一下SpringBoot中的“約定”。
maven目錄結(jié)構(gòu)的約定
我們可以去Spring的官網(wǎng)查看一下官方文檔,看看文檔中描述的目錄結(jié)構(gòu)是怎樣的。
Config locations are searched in reverse order. By default, the configured locations are classpath:/,classpath:/config/,file:./,file:./config/. The resulting search order is the following:
- file:./config/
- file:./
- classpath:/config/
- classpath:/
也就是說,spring的配置文件目錄可以放在
- /config
- /(根目錄)
- resource/config/
- resource/
這四個(gè)路徑從上到下存在優(yōu)先級(jí)關(guān)系。
SpringBoot默認(rèn)配置文件的約定
SpringBoot默認(rèn)可以加載以下三種配置文件:
- application.yml
- application.yaml
- application.properties
建議使用前兩種作為項(xiàng)目的配置文件。
項(xiàng)目啟動(dòng)時(shí)掃描包范圍的約定
SpringBoot的注解掃描的默認(rèn)規(guī)則是SpringBoot的入口類所在包及其子包。
若入口類所在的包是cn.objectspace.demo那么自動(dòng)掃描包的范圍是cn.objectspace.demo包及其下面的子包,如果service包和dao包不在此范圍,則不會(huì)自動(dòng)掃描。
SpringBoot自動(dòng)配置類如何讀取yml配置
從更細(xì)節(jié)的角度去理解自動(dòng)配置
上文中我們闡述了一些SpringBoot自動(dòng)配置的原理,我們是從全局的角度去看自動(dòng)配置的整個(gè)過程。比如從哪個(gè)地方開始進(jìn)行裝配流程、如何找到裝配的包等。
那么現(xiàn)在將自己的視角貼近SpringBoot,來聊聊application.yml中我們配置的東西,是如何配置到一個(gè)個(gè)的配置類中的。
yml配置文件中可以配置那些東西
首先要知道這個(gè)問題的答案,我們應(yīng)該習(xí)慣springboot的配置方式。在上文中我們闡述了SpringBoot總是將所有的配置都用JavaConfig的形式去呈現(xiàn)出來,這樣能夠使代碼更加優(yōu)雅。
那么yml中配置的東西,必然是要和這種配置模式去進(jìn)行聯(lián)系的,我們?cè)赼pplication.yml中配置的東西,通常是一些存在與自動(dòng)配置類中的屬性,那么這些自動(dòng)配置類,在啟動(dòng)的時(shí)候是怎么找到的呢?
如果你還記得上文的描述,那么你可以很明確地知道:spring.factories!沒錯(cuò),就是它,所以這個(gè)問題我們似乎得到了答案——只要存在與spring.factories中的,我們都可以在application.yml中進(jìn)行配置。
當(dāng)然,這并不意味著不存在其中的我們就不能配置,這些配置類我們是可以進(jìn)行自定義的,只要我們寫了配置類,我們就可以在yml中配置我們需要的屬性值,然后在配置類中直接讀取這個(gè)配置文件,將其映射到配置類的屬性上。那么就牽扯出我們的問題了:配置類是如何去讀取yml配置文件中的信息的呢?
@ConfigurationProperties
要明白這個(gè)問題。我們就首先要去了解這個(gè)注解有什么作用。
我們可以自己嘗試在application.yml中去定義一些屬性,如下:
object:
name: Object
blogurl: blog.objectspace.cn
我們現(xiàn)在自己定義一個(gè)類去讀取這個(gè)文件:
@Component
@ConfigurationProperties(prefix = "object")
public class TestConfig {
private String name;
private String blogUrl;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getBlogUrl() {
return blogUrl;
}
public void setBlogUrl(String blogUrl) {
this.blogUrl = blogUrl;
}
}
然后我們?cè)跍y試類中輸出一下這個(gè)對(duì)象:
@SpringBootTest
class SpringbootdemoApplicationTests {
@Autowired
TestConfig testConfig;
@Test
void contextLoads() {
System.out.println(testConfig.getName());
System.out.println(testConfig.getBlogUrl());
}
}
測試結(jié)果:
我們可以看到,在控制臺(tái)中輸出了我們?cè)趛ml中配置的屬性值,但是這些值我們沒有在任何地方顯式地對(duì)這個(gè)對(duì)象進(jìn)行注入。
所以@ConfigurationProperties這個(gè)注解,可以將yml文件中寫好的值注入到我們類的屬性中。
明白了它的作用,就能明白自動(dòng)配置類工作的原理了。
我們依舊是選取SpringMVC的自動(dòng)配置類,我們來看看其中有些什么東西。
點(diǎn)擊任意一個(gè)*Properties類中,look一下其中的內(nèi)容:
看到這里相信所有人都明白了,我們就拿mvc配置來舉例。
我們?cè)趛ml中配置的date-format,就可以通過@ConfigurationProperties映射到類中的dateFormat中,然后在通過自動(dòng)配置類,將這些屬性配置到配置類中。
-
JAVA
+關(guān)注
關(guān)注
20文章
2992瀏覽量
114823 -
開發(fā)
+關(guān)注
關(guān)注
0文章
375瀏覽量
41901 -
框架
+關(guān)注
關(guān)注
0文章
404瀏覽量
18218 -
spring
+關(guān)注
關(guān)注
0文章
341瀏覽量
15579
發(fā)布評(píng)論請(qǐng)先 登錄
CYBT343026-01想要修改power,是每次開機(jī)都要設(shè)置一遍碼?
個(gè)人認(rèn)為51匯編至少過一遍
主程序執(zhí)行一遍后單片機(jī)鎖存器怎么變化?
剛學(xué)STM32,按照一個(gè)網(wǎng)上找的LED程序,自己寫了一遍,可是...
已經(jīng)跟著入門書籍學(xué)了一遍LabVIEW基礎(chǔ)知識(shí),現(xiàn)在該怎么練手呢
IAP15W413AS灌程序要先用串口燒錄一遍
6678點(diǎn)擊ccml文件debug時(shí)當(dāng)前的out文件會(huì)給所有的core都下載一遍
怎么讓液晶把每種顏色都顯示一遍
請(qǐng)問在bootloader里面已經(jīng)包含的配置在app里面還需要在配置一遍嗎?
英偉達(dá)AI機(jī)器人開發(fā)新技能 看一遍就能自學(xué)成才
一個(gè)深度學(xué)習(xí)模型能完成幾項(xiàng)NLP任務(wù)?
自動(dòng)裝配線有哪些設(shè)計(jì)
深度盤點(diǎn)一遍自動(dòng)裝配原理(上)

評(píng)論