在日常開發(fā)時(shí),我們常常需要 在SpringBoot 應(yīng)用啟動(dòng)時(shí)執(zhí)行某一段邏輯,如下面的場(chǎng)景:
創(chuàng)新互聯(lián)成立與2013年,公司以做網(wǎng)站、成都網(wǎng)站建設(shè)、系統(tǒng)開發(fā)、網(wǎng)絡(luò)推廣、文化傳媒、企業(yè)宣傳、平面廣告設(shè)計(jì)等為主要業(yè)務(wù),適用行業(yè)近百種。服務(wù)企業(yè)客戶上1000+,涉及國(guó)內(nèi)多個(gè)省份客戶。擁有多年網(wǎng)站建設(shè)開發(fā)經(jīng)驗(yàn)。為企業(yè)提供專業(yè)的網(wǎng)站建設(shè)、創(chuàng)意設(shè)計(jì)、宣傳推廣等服務(wù)。 通過專業(yè)的設(shè)計(jì)、獨(dú)特的風(fēng)格,為不同客戶提供各種風(fēng)格的特色服務(wù)。獲取一些當(dāng)前環(huán)境的配置或變量
向數(shù)據(jù)庫(kù)寫入一些初始數(shù)據(jù)
在實(shí)現(xiàn)這些功能時(shí),我們可能會(huì)遇到一些"坑"。為了利用SpringBoot框架的便利性,我們不得不將整個(gè)應(yīng)用的執(zhí)行控制權(quán)交給容器,于是造成了大家對(duì)于細(xì)節(jié)是一無所知的。那么在實(shí)現(xiàn)初始化邏輯代碼時(shí)就需要小心了,比如,我們并不能簡(jiǎn)單的將初始化邏輯在Bean類的構(gòu)造方法中實(shí)現(xiàn),類似下面的代碼:
@Component
public class InvalidInitExampleBean {
@Autowired
private Environment env;
public InvalidInitExampleBean() {
env.getActiveProfiles();
}
}
這里,我們?cè)贗nvalidInitExampleBean的構(gòu)造方法中試圖訪問一個(gè)自動(dòng)注入的env字段,當(dāng)真正執(zhí)行時(shí),你一定會(huì)得到一個(gè)空指針異常(NullPointerException)。
原因在于,當(dāng)構(gòu)造方法被調(diào)用時(shí),Spring上下文中的Environment這個(gè)Bean很可能還沒有被實(shí)例化,同時(shí)也仍未注入到當(dāng)前對(duì)象,所以并不能這樣進(jìn)行調(diào)用。
下面,我們來看看在SpringBoot中實(shí)現(xiàn)"安全初始化"的一些方法:
@PostConstruct 注解其實(shí)是來自于 javax的擴(kuò)展包中(大多數(shù)人的印象中是來自于Spring框架),它的作用在于聲明一個(gè)Bean對(duì)象初始化完成后執(zhí)行的方法。
來看看它的原始定義:
The?PostConstruct?annotation?is?used?on?a?method?that?needs?to?be?executed??after?dependency?injection?is?done?to?perform?any?initialization
也就是說,該方法會(huì)在所有依賴字段注入后才執(zhí)行,當(dāng)然這一動(dòng)作也是由Spring框架執(zhí)行的。
下面的代碼演示了使用@PostConstruct的例子:
InitializingBean 是由Spring框架提供的接口,其與@PostConstruct注解的工作原理非常類似。如果不使用注解的話,你需要讓Bean實(shí)例繼承 InitializingBean接口,并實(shí)現(xiàn)afterPropertiesSet()這個(gè)方法。
下面的代碼,展示了這種用法:
我們?cè)诼暶饕粋€(gè)Bean的時(shí)候,可以同時(shí)指定一個(gè)initMethod屬性,該屬性會(huì)指向Bean的一個(gè)方法,表示在初始化后執(zhí)行。
如下所示:
然后,這里將initMethod指向init方法,相應(yīng)的我們也需要在Bean中實(shí)現(xiàn)這個(gè)方法:
上面的代碼是基于Java注解的方式,使用Xml配置也可以達(dá)到同樣的效果:
該方式在早期的?Spring版本中大量被使用
如果依賴的字段在Bean的構(gòu)造方法中聲明,那么Spring框架會(huì)先實(shí)例這些字段對(duì)應(yīng)的Bean,再調(diào)用當(dāng)前的構(gòu)造方法。此時(shí),構(gòu)造方法中的一些操作也是安全的,如下:
ApplicationListener 是由 spring-context組件提供的一個(gè)接口,主要是用來監(jiān)聽 "容器上下文的生命周期事件"。它的定義如下:
這里的event可以是任何一個(gè)繼承于ApplicationEvent的事件對(duì)象。對(duì)于初始化工作來說,我們可以通過監(jiān)聽ContextRefreshedEvent這個(gè)事件來捕捉上下文初始化的時(shí)機(jī)。如下面的代碼:
在Spring上下文初始化完成后,這里定義的方法將會(huì)被執(zhí)行。與前面的InitializingBean不同的是,通過ApplicationListener監(jiān)聽的方式是全局性的,也就是當(dāng)所有的Bean都初始化完成后才會(huì)執(zhí)行方法。
Spring 4.2 之后引入了新的 @EventListener注解,可以實(shí)現(xiàn)同樣的效果:
SpringBoot 提供了一個(gè)CommanLineRunner接口,用來實(shí)現(xiàn)在應(yīng)用啟動(dòng)后的邏輯控制,其定義如下:
這里的run方法會(huì)在Spring 上下文初始化完成后執(zhí)行,同時(shí)會(huì)傳入應(yīng)用的啟動(dòng)參數(shù)。如下面的代碼:
此外,對(duì)于多個(gè)CommandLineRunner的情況下可以使用@Order注解來控制它們的順序。
與 CommandLineRunner接口類似, Spring boot 還提供另一個(gè)ApplicationRunner 接口來實(shí)現(xiàn)初始化邏輯。不同的地方在于 ApplicationRunner.run()方法接受的是封裝好的ApplicationArguments參數(shù)對(duì)象,而不是簡(jiǎn)單的字符串參數(shù)。
ApplicationArguments對(duì)象提供了一些非常方便的方法,可以用來直接獲取解析后的參數(shù),比如:
java -jar application.jar --debug --ip=xxxx
此時(shí)通過 ApplicationArguments的getOptionNames就會(huì)得到["debug","ip"]這樣的值。
下面,通過一個(gè)小測(cè)試來演示幾種初始化方法的執(zhí)行次序。
按如下代碼實(shí)現(xiàn)一個(gè)復(fù)合式的Bean:
執(zhí)行這個(gè)Bean的初始化,會(huì)發(fā)現(xiàn)日志輸出如下:
所以,這幾種初始化的順序?yàn)椋?/p>
構(gòu)造器方法
@PostConstruct 注解方法
InitializingBean的afterPropertiesSet()
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)cdcxhl.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì),專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。