這一節(jié)會(huì)深入Spring Boot的細(xì)節(jié)。我們將帶你了解幾個(gè)重要特性床未,這些是你可能會(huì)用到和自定義的飘庄。如果你沒(méi)有了解過(guò)Spring Boot,可以從getting-started.html酌泰,using-spring-boot.html開(kāi)始媒佣,以便你有一個(gè)好基礎(chǔ)。
1.Spring應(yīng)用
運(yùn)行main方法下的SpringApplication類(lèi)為我們提供了一種便利途徑去引導(dǎo)一個(gè)Spring應(yīng)用宫莱。多數(shù)情況下丈攒,都是委托靜態(tài)的SpringApplication.run方法,如下:
public static void main(String[] args) {
SpringApplication.run(MySpringConfiguration.class, args);
}
應(yīng)用啟動(dòng)成功后授霸,應(yīng)該能看到如下的輸出:
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: v2.2.1.RELEASE
2019-04-31 13:09:54.117 INFO 56603 --- [ main] o.s.b.s.app.SampleApplication : Starting SampleApplication v0.1.0 on mycomputer with PID 56603 (/apps/myapp.jar started by pwebb)
2019-04-31 13:09:54.166 INFO 56603 --- [ main] ationConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@6e5a8246: startup date [Wed Jul 31 00:08:16 PDT 2013]; root of context hierarchy
2019-04-01 13:09:56.912 INFO 41370 --- [ main] .t.TomcatServletWebServerFactory : Server initialized with port: 8080
2019-04-01 13:09:57.501 INFO 41370 --- [ main] o.s.b.s.app.SampleApplication : Started SampleApplication in 2.992 seconds (JVM running for 3.658)
默認(rèn)情況下巡验,日志級(jí)別是INFO,還有一些與啟動(dòng)細(xì)節(jié)相關(guān)的信息碘耳,比如啟動(dòng)應(yīng)用的user显设。如果想要設(shè)置更高的日志級(jí)別,請(qǐng)參考Log Levels辛辨。
1.1 啟動(dòng)失敗
如果應(yīng)用啟動(dòng)失敗了捕捂,自動(dòng)注冊(cè)的FailureAnalyzers會(huì)提供錯(cuò)誤信息和解決問(wèn)題的具體方法瑟枫。例如,如果在8080端口啟動(dòng)web應(yīng)用指攒,但是這個(gè)端口被占用慷妙,你會(huì)看到如下信息:
***************************
APPLICATION FAILED TO START
***************************
Description:
Embedded servlet container failed to start. Port 8080 was already in use.
Action:
Identify and stop the process that's listening on port 8080 or configure this application to listen on another port.
Spring Boot提供了很多FailureAnalyzer 實(shí)現(xiàn),你也可以用自己的 add your own允悦。
如果失敗分析器不能處理異常膝擂,你也可以獲得完整的報(bào)告信息以便知道哪兒出了問(wèn)題。開(kāi)啟debug屬性 (enable the debug
property)或者為org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener開(kāi)啟DEBUG日志(enable DEBUG
logging)隙弛。
如果你用java -jar命令啟動(dòng)應(yīng)用架馋,可以用以下方式開(kāi)啟debug屬性。
$ java -jar myproject-0.0.1-SNAPSHOT.jar --debug
1.2 懶初始化
SpringApplication可以實(shí)現(xiàn)懶初始化全闷,懶初始化時(shí)所有的beans在需要的時(shí)候才會(huì)被創(chuàng)建叉寂,而不是應(yīng)用一啟動(dòng)就創(chuàng)建。因此总珠,懶初始化可以減少應(yīng)用啟動(dòng)時(shí)間屏鳍。在web應(yīng)用中,開(kāi)啟懶初始化會(huì)導(dǎo)致與網(wǎng)絡(luò)相關(guān)的beans直到收到HTTP請(qǐng)求時(shí)才進(jìn)行初始化局服。
懶初始化的缺點(diǎn)是不能讓我們及時(shí)發(fā)現(xiàn)問(wèn)題孕蝉。如果一個(gè)沒(méi)有配置的bean是懶初始化的,啟動(dòng)時(shí)就不會(huì)再失敗腌逢,只有當(dāng)這個(gè)bean被初始化時(shí)問(wèn)題才顯示出來(lái)降淮。還要小心保證JVM有足夠的內(nèi)存容納所有的應(yīng)用beans而不僅僅是哪些啟動(dòng)時(shí)被初始化的beans。由于以上原因搏讶,懶初始化默認(rèn)關(guān)閉佳鳖,開(kāi)啟懶初始化之前建議調(diào)整一下JVM堆內(nèi)存大小。
懶初始化可以在程序中開(kāi)啟媒惕,使用SpringApplicationBuilder 的lazyInitialization 方法系吩、SpringApplication的setLazyInitialization 方法,也可以在配置中開(kāi)啟:
spring.main.lazy-initialization=true
可以使用@Lazy(false)注解單獨(dú)為類(lèi)設(shè)置懶初始化屬性妒蔚。
1.3 自定義Banner
應(yīng)用啟動(dòng)時(shí)打印的banner可以自定義穿挨,在classpath下增加一個(gè)banner.txt文件或者把這個(gè)文件的路徑設(shè)置為spring.banner.location屬性的值。如果文件的編碼不是UTF-8肴盏,也可以設(shè)置spring.banner.charset科盛。除了文本文件,也可以在classpath下增加banner.gif, banner.jpg, 或者 banner.png這些圖片文件菜皂,或者設(shè)置spring.banner.image.location屬性贞绵。圖片會(huì)被轉(zhuǎn)換成ASCII 的藝術(shù)表現(xiàn)形式并打印在文本banner上。
在banner.txt文件中恍飘,可以使用以下的占位符(placeholders)榨崩,點(diǎn)擊鏈接查看:https://www.cnblogs.com/mihasha/p/11882617.html
SpringApplication.setBanner(…?)可以讓我們?cè)诔绦蛑猩蒪anner谴垫。使用org.springframework.boot.Banner接口實(shí)現(xiàn)自己的printBanner()方法。
你也可以使用spring.main.banner-mode屬性來(lái)決定Banner是打印到控制臺(tái)上母蛛,發(fā)到日志中或者干脆不要banner翩剪。打印的banner是一個(gè)單例的bean,名為SpringBootBanner彩郊。
1.4 自定義SpringApplication
如果SpringApplication的默認(rèn)選項(xiàng)不合你的口味肢专,你可以創(chuàng)建一個(gè)本地實(shí)例然后對(duì)其進(jìn)行自定義。例如焦辅,關(guān)閉banner,你可以這么寫(xiě):
public static void main(String[] args) {
SpringApplication app = new SpringApplication(MySpringConfiguration.class);
app.setBannerMode(Banner.Mode.OFF);
app.run(args);
}
SpringApplication的構(gòu)造參數(shù)是Spring beans的配置源椿胯。大多數(shù)情況下筷登,都會(huì)使用@Configuration 注解的類(lèi) ,但也可以使用xml配置或者掃描包哩盲。
也可以使用application.properties文件進(jìn)行配置前方。查看 Externalized Configuration
了解更多細(xì)節(jié)。
配置項(xiàng)的完整列表查看這里 SpringApplication
Javadoc
1.5 流暢的Builder API
如果你想構(gòu)建一個(gè)ApplicationContext 層級(jí)(具有父子關(guān)系的多context)或者更喜歡使用“流暢的”builder API廉油。你可以使用SpringApplicationBuilder惠险。
SpringApplicationBuilder支持方法調(diào)用鏈,包括有父子關(guān)系的方法抒线,如下所示班巩。
new SpringApplicationBuilder()
.sources(Parent.class)
.child(Application.class)
.bannerMode(Banner.Mode.OFF)
.run(args);
ApplicationContext層級(jí)關(guān)系有很多限制。例如嘶炭,web組件必須在子context中抱慌,父子context必須是同樣的環(huán)境。點(diǎn)擊
SpringApplicationBuilder
Javadoc
了解完整細(xì)節(jié)眨猎。
1.6 應(yīng)用事件和監(jiān)聽(tīng)器抑进。
除了類(lèi)似ContextRefreshedEvent
這樣平常的Spring框架事件外,SpringApplication 會(huì)send一些額外的應(yīng)用事件睡陪。
有些事件實(shí)際上在ApplicationContext 創(chuàng)建之前就被觸發(fā)了寺渗,所以你無(wú)法在那些@Bean注解的類(lèi)上注冊(cè)監(jiān)聽(tīng)器。SpringApplication.addListeners(…?) 或者 SpringApplicationBuilder.listeners(…?)方法可以用來(lái)注冊(cè)監(jiān)聽(tīng)器兰迫。
隨著應(yīng)用的啟動(dòng)信殊,事件順序如下:
1.ApplicationStartingEvent : 除了監(jiān)聽(tīng)器和初始化器之外,開(kāi)始運(yùn)行后汁果,進(jìn)行其他處理之前鸡号;
2.ApplicationEnvironmentPreparedEvent :明確context的環(huán)境時(shí),context創(chuàng)建之前须鼎;
3.ApplicationContextInitializedEvent : ApplicationContext 準(zhǔn)備完畢鲸伴,ApplicationContextInitializers 調(diào)用之后府蔗,定義的bean加載之前;
4.ApplicationPreparedEvent : bean加載后汞窗,refresh開(kāi)始之前姓赤;
5.ApplicationStartedEvent : after the context has been refreshed but before any application and command-line runners have been called.
6.ApplicationReadyEvent :after any application and command-line runners have been called. It indicates that the application is ready to service requests.
7.ApplicationFailedEvent : 啟動(dòng)異常時(shí)。
以上列表僅包含與SpringApplication綁定的SpringApplicationEvents 仲吏。除此之外不铆,在ApplicationPreparedEvent 與ApplicationStartedEvent之間的事件:
1.ContextRefreshedEvent :ApplicationContext 刷新時(shí);
2.WebServerInitializedEvent :WebServer 準(zhǔn)備完畢后裹唆。ServletWebServerInitializedEvent and ReactiveWebServerInitializedEvent are the servlet and reactive variants respectively誓斥。
你可能不會(huì)用到應(yīng)用事件,但是了解他們也很有用许帐。Spring Boot內(nèi)部使用事件來(lái)處理各種各樣的任務(wù)劳坑。
使用Spring框架的事件發(fā)布機(jī)制發(fā)送應(yīng)用事件。部分機(jī)制確保發(fā)布到子context listener的事件也會(huì)發(fā)布到任何父級(jí)context的listener成畦。因此距芬,如果你的應(yīng)用使用了SpringApplication實(shí)例的層級(jí)關(guān)系,一個(gè)listener可能會(huì)收到多個(gè)同種類(lèi)型的應(yīng)用事件實(shí)例循帐。
為了讓listener能夠區(qū)分來(lái)自自己context的事件和來(lái)自下級(jí)context的事件框仔,要求應(yīng)用的context要被注入,然后比較注入的context和事件的context拄养±胝叮可以實(shí)現(xiàn)ApplicationContextAware 來(lái)注入context,如果listener是一個(gè)bean瘪匿,可以使用@Autowired捐腿。
1.7 Web Environment
SpringApplication會(huì)努力為你創(chuàng)建正確的ApplicationContext類(lèi)型,決定WebApplicationType 的算法相當(dāng)?shù)暮?jiǎn)單:
- 如果使用了Spring MVC柿顶,就用AnnotationConfigServletWebServerApplicationContext
- 如果沒(méi)用Spring MVC而是Spring WebFlux茄袖,就用AnnotationConfigReactiveWebServerApplicationContext
- 其他情況就用AnnotationConfigApplicationContext
這就意味著在一個(gè)應(yīng)用中如果你既使用了Spring MVC又使用了Spring WebFlux的WebClient,那么會(huì)默認(rèn)使用Spring MVC嘁锯。當(dāng)然你可以調(diào)用setWebApplicationType(WebApplicationType)來(lái)覆蓋默認(rèn)值宪祥。
也可以通過(guò)setApplicationContextClass(…?)方法使用你希望的ApplicationContext類(lèi)型。
使用SpringApplication進(jìn)行JUnit test時(shí)家乘,調(diào)用setWebApplicationType(WebApplicationType.NONE)方法是可取的蝗羊。
1.8 獲取應(yīng)用參數(shù)
如果你需要傳給應(yīng)用的SpringApplication.run(…?)方法的參數(shù),你可以注入一個(gè)org.springframework.boot.ApplicationArguments bean仁锯。ApplicationArguments接口可以拿到未經(jīng)加工的String[] 形式的參數(shù)和解析過(guò)的option和non-option參數(shù)耀找,如下例所示:
import org.springframework.boot.*;
import org.springframework.beans.factory.annotation.*;
import org.springframework.stereotype.*;
@Component
public class MyBean {
@Autowired
public MyBean(ApplicationArguments args) {
boolean debug = args.containsOption("debug");
List<String> files = args.getNonOptionArgs();
// if run with "--debug logfile.txt" debug=true, files=["logfile.txt"]
}
}
Spring環(huán)境下,Spring Boot注冊(cè)了一個(gè)CommandLinePropertySource。它可以讓你使用@Value注解注入一個(gè)應(yīng)用參數(shù)野芒。
1.9 ApplicationRunner 或者CommandLineRunner
如果SpringApplication 啟動(dòng)時(shí)你要運(yùn)行一段特殊的代碼蓄愁,你可以實(shí)現(xiàn)ApplicationRunner或者CommandLineRunner接口。兩個(gè)接口原理相同狞悲,都只提供了一個(gè)run方法撮抓,這個(gè)方法會(huì)在SpringApplication.run(…?)完成前調(diào)用。
CommandLineRunner可以獲取應(yīng)用的字符串?dāng)?shù)組形式的參數(shù)摇锋,ApplicationRunner使用之前提到過(guò)的ApplicationArguments 接口丹拯。下面是一個(gè)CommandLineRunner 的例子:
import org.springframework.boot.*;
import org.springframework.stereotype.*;
@Component
public class MyBean implements CommandLineRunner {
public void run(String... args) {
// Do something...
}
}
如果你定義了多個(gè)CommandLineRunner 或者ApplicationRunner 的bean,但想要他們以特定的順序進(jìn)行調(diào)用荸恕,可以實(shí)現(xiàn)org.springframework.core.Ordered接口或者使用org.springframework.core.annotation.Order注解乖酬。
1.10 結(jié)束應(yīng)用
每個(gè)SpringApplication都在JVM中注冊(cè)了一個(gè)shutdown鉤子以確保程序結(jié)束運(yùn)行時(shí)ApplicationContext 能優(yōu)雅的關(guān)閉。所有的Spring生命周期回調(diào)都能使用(例如DisposableBean 接口或者@PreDestroy注解)融求。
此外咬像,調(diào)用SpringApplication.exit()時(shí),實(shí)現(xiàn)了org.springframework.boot.ExitCodeGenerator接口的beans可以返回一個(gè)exit code双肤。這個(gè)退出碼會(huì)傳給System.exit()作為狀態(tài)碼返回,如下所示:
@SpringBootApplication
public class ExitCodeApplication {
@Bean
public ExitCodeGenerator exitCodeGenerator() {
return () -> 42;
}
public static void main(String[] args) {
System.exit(SpringApplication.exit(SpringApplication.run(ExitCodeApplication.class, args)));
}
}
ExitCodeGenerator 接口也可以被異常實(shí)現(xiàn)钮惠。當(dāng)出現(xiàn)實(shí)現(xiàn)這個(gè)接口的異常時(shí)茅糜,Spring Boot會(huì)返回實(shí)現(xiàn)接口的getExitCode()方法提供的狀態(tài)碼。
1.11 Admin Features
通過(guò)設(shè)置spring.application.admin.enabled屬性素挽,可以開(kāi)啟管理相關(guān)的功能蔑赘。這樣會(huì)在MBeanServer平臺(tái)上暴露SpringApplicationAdminMXBean
。你可以使用這個(gè)功能遠(yuǎn)程管理Spring Boot應(yīng)用预明。This feature could also be useful for any service wrapper implementation(服務(wù)包裝器缩赛?).
如果你想知道應(yīng)用運(yùn)行在哪個(gè)HTTP端口上,通過(guò)local.server.port鍵來(lái)獲取撰糠。