簡單的一個需求,要求在項目啓動過程中,完成線程池的初始化,加載初始化加載緩存等功能,你會怎麼做?如果沒想好答案,請接着往下看。今天介紹幾種在Spring Boot中進行資源初始化的方式,幫助大家解決和回答這個問題
一:CommandLineRunner
定義初始化類 MyCommandLineRunner
實現 CommandLineRunner 接口,並實現它的 run() 方法,在該方法中編寫初始化邏輯
註冊成Bean,添加 @Component註解即可
示例代碼如下:
@Component
public class MyCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("...init resources by implements CommandLineRunner");
}
}
實現了 CommandLineRunner 接口的 Component 會在所有 Spring Beans 初始化完成之後, 在 SpringApplication.run() 執行之前完成。
二:ApplicationRunner
定義初始化類 MyApplicationRunner
實現 ApplicationRunner 接口,並實現它的 run() 方法,在該方法中編寫初始化邏輯
註冊成Bean,添加 @Component註解即可
示例代碼如下:
@Component
public class MyApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments applicationArguments) throws Exception {
System.out.println("...init resources by implements ApplicationRunner");
}
}
可以看到,通過實現 ApplicationRunner 接口,和通過實現 CommandLineRunner 接口都可以完成項目的初始化操作,實現相同的效果。兩者之間唯一的區別是 run() 方法中自帶的形參不相同,在 CommandLineRunner 中只是簡單的String... args形參,而 ApplicationRunner 則是包含了 ApplicationArguments 對象,可以幫助獲得更豐富的項目信息。
如圖:
比較:
如果項目中既有實現了 ApplicationRunner 接口的初始化類,又有實現了 CommandLineRunner 接口的初始化類,那麼會是哪一個先執行呢?測試告訴我們,答案是實現了 ApplicationRunner 接口的初始化類先執行,我想這點倒是不需要大家過分去關注爲什麼。但如果需要改變兩個初始化類之間的默認執行順序,那麼使用 @Order 註解就可以幫助我們解決這個問題。
@Component
@Order(1)
public class MyCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("...init resources by implements CommandLineRunner");
}
}
@Component
@Order(2)
public class MyApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments applicationArguments) throws Exception {
System.out.println("...init resources by implements ApplicationRunner");
}
}
最終,控制檯中打印如下。通過控制檯輸出我們發現, @Order
註解值越小,該初始化類也就越早執行。
2020-03-29 10:27:31.450 INFO 28304 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
...init resources by implements CommandLineRunner
...init resources by implements ApplicationRunner
2020-03-29 10:27:31.453 INFO 28304 --- [ main] cn.demo.DemoApplication : Started DemoApplication in 6.146 seconds (JVM running for 2.977)
三:@PostConstruct
使用 @PostConstruct
註解同樣可以幫助我們完成資源的初始化操作,前提是這些初始化操作不需要依賴於其它Spring beans的初始化工作。源碼的註解如圖:
看到 @PostConstruct
註解是用在方法上的,寫一個方法測試吧!!!!!
@PostConstruct
public void postConstruct() {
System.out.println("... PostConstruct");
}
看看打印日誌:
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.11.RELEASE)
。。。。。。(此處省略一堆打印信息)
... PostConstruct
。。。。。。(此處省略一堆打印信息)
2020-03-29 10:28:22.300 INFO 29796 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
...init resources by implements CommandLineRunner
...init resources by implements ApplicationRunner
2020-03-29 10:28:22.303 INFO 29796 --- [ main] cn.demo.DemoApplication : Started DemoApplication in 6.387 seconds (JVM running for 3.267)
... end SpringApplication.run()
四:綜合總結:
使用 @PostConstruct
註解進行初始化操作的順序是最快的,前提是這些操作不能依賴於其它Bean的初始化完成。通過添加 @Order
註解,我們可以改變同層級之間不同Bean的加載順序。