從零開始學Spring Boot系列-SpringApplication

代码匠心發表於2024-04-07
Spring BootAPP

SpringApplication類提供了一種從main()方法啟動Spring應用的便捷方式。在很多情況下， 你只需委託給 SpringApplication.run這個靜態方法 ：

    @SpringBootApplication
    public class SpringbootLearningApplication {

        public static void main(String[] args) {
            SpringApplication.run(SpringbootLearningApplication.class, args);
        }

    }

當應用啟動時， 你應該會看到類似下面的東西:
20240407182652
預設情況下會顯示INFO級別的日誌資訊， 包括一些相關的啟動詳情， 比如啟動應用的使用者等。

自定義Banner

透過在classpath下新增一個banner.txt或設定banner.location來指定相應的檔案可以改變啟動過程中列印的banner。如果這個檔案有特殊的編碼，你可以使用banner.encoding設定它（預設為UTF-8）。
在banner.txt中可以使用如下的變數:

變數 描述
application.version MANIFEST.MF中宣告的應用版本號， 例如1.0
application.formatted- version MANIFEST.MF中宣告的被格式化後的應用版本號（被括號包裹且以v作為字首），用於顯 示，例如(v1.0)
spring-boot.version 正在使用的Spring Boot版本號， 例如3.2.3
spring-boot.formatted-version 正在使用的Spring Boot被格式化後的版本號（被括號包裹且以v作為字首）, 用於顯示，例如(v3.2.3)

注：如果想以程式設計的方式產生一個banner，可以使用SpringBootApplication.setBanner(…)方法。使用org.springframework.boot.Banner介面，實現你自己的printBanner()方法。

自定義SpringApplication

如果預設的SpringApplication不符合你的口味，你可以建立一個本地的例項並自定義它。例如，關閉banner你可以這樣寫：

@SpringBootApplication
public class SpringbootLearningApplication {

 public static void main(String[] args) {
  SpringApplication app =new SpringApplication(SpringbootLearningApplication.class);
  app.setBannerMode(Banner.Mode.OFF);
  app.run(args);
 }

}

注：傳遞給SpringApplication的構造器引數是spring beans的配置源。在大多數情況下，這些將是@Configuration類的引用，但它們也可能是XML配置或要掃描包的引用。

Application事件和監聽器

除了常見的Spring框架事件，比如ContextRefreshedEvent，一個SpringApplication也傳送一些額外的應用事件。一些事件實際上是在ApplicationContext被建立前觸發的。
你可以使用多種方式註冊事件監聽器，最普通的是使用SpringApplication.addListeners(…)方法。在你的應用執行時，應用事件會以下面的次序傳送：

  1. 在執行開始，但除了監聽器註冊和初始化以外的任何處理之前，會傳送一個ApplicationStartedEvent。
  2. 在Environment將被用於已知的上下文，但在上下文被建立前，會傳送一個ApplicationEnvironmentPreparedEvent。
  3. 在refresh開始前，但在bean定義已被載入後，會傳送一個ApplicationPreparedEvent。
  4. 啟動過程中如果出現異常，會傳送一個ApplicationFailedEvent。

注 ：你通常不需要使用應用程式事件， 但知道它們的存在會很方便（在某些場合可能會使用到）。在Spring內部， Spring Boot使用事件處理各種各樣的任務。

Web環境

一個SpringApplication將嘗試為你建立正確型別的ApplicationContext。在預設情況下，使用AnnotationConfigApplicationContext或AnnotationConfigEmbeddedWebApplicationContext取決於你正在開發的是否是web應用。

用於確定一個web環境的演算法相當簡單（基於是否存在某些類）。如果需要覆蓋預設行為，你可以使用setWebEnvironment(boolean webEnvironment)。透過呼叫setApplicationContextClass(…)，你可以完全控制ApplicationContext的型別。

注： 當JUnit測試裡使用SpringApplication時，呼叫setWebEnvironment(false)是可取的。

命令列啟動器

如果你想獲取原始的命令列引數，或一旦SpringApplication啟動，你需要執行一些特定的程式碼，你可以實現CommandLineRunner介面。在所有實現該介面的Spring beans上將呼叫run(String … args)方法。

@Component
public class MyBean implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("啟動前執行");
    }
}

如果一些CommandLineRunner beans被定義必須以特定的次序呼叫， 你可以額外實現org.springframework.core.Ordered介面或使用org.springframework.core.annotation.Order註解。

Application退出

每個SpringApplication在退出時為了確保ApplicationContext被優雅的關閉， 將會註冊一個JVM的shutdown鉤子。所有標準的Spring生命週期回撥（比如， DisposableBean介面或@PreDestroy註解）都能使用。

此外， 如果beans想在應用結束時返回一個特定的退出碼（exit code），可以實現org.springframework.boot.ExitCodeGenerator介面。

相關文章