相信用過 Spring Boot 的朋友們一定在啟動日誌中見過類似如下的內容，比如在啟動 Spring Boot 時，控制檯預設會列印 Spring Boot Logo 以及版本資訊，這是 Spring Boot 固定的還是可自定義的呢？

  .   ____          _            __ _ _
 /\ / ___'_ __ _ _(_)_ __  __ _    
( ( )___ | '_ | '_| | '_ / _` |    
 \/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |___, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v1.5.7.RELEASE)

答案是，Spring Boot 支援自定義 Banner，接下來本文將詳細討論如何定製 Banner 內容，首先來了解下 Banner 是如何出現的。

Banner 是如何出現的？

初始 Banner 的程式碼是 SpringApplicationBannerPrinter 類，Spring Boot 預設尋找 Banner 的順序是:

• 首先依次在 Classpath 下找檔案 banner.gif，banner.jpg 和 banner.png，使用優先找到的
• 若沒找到上面檔案的話，繼續 Classpath 下找 banner.txt
• 若上面都沒有找到的話, 用預設的 SpringBootBanner，也就是上面輸出的 Spring Boot Logo

一般是把 banner.* 檔案放在 src/main/resources/ 目錄下。

我們可以用屬性 banner.location 設定 Spring Boot 在不同於 Classpath 下找以上 banner.txt 檔案，banner.charset 設定 banner.txt 的字符集，預設為 UTF-8。屬性 banner.image.location 用於指定尋找 banner.(gif|jpg|png) 檔案的位置。

如果同時存在圖片(如 banner.jpg) 和 banner.txt , 則它們會同時顯示出來，先圖片後文字，但同時存在多個圖片 banner.(gif|jpg|png)，則只會顯示第一張圖片。

• 對於文字檔案，Spring Boot 會將其直接輸出。
• 對於影像檔案（ banner.gif 、banner.jpg 或 banner.png ），Spring Boot 會將影像轉為 ASCII 字元，然後輸出。

變數

banner.txt 檔案中還可以使用變數來設定字型、顏色、版本號。

配置

application.properties 中與 Banner 相關的配置：

# banner 模式。有三種模式：console/log/off
# console 列印到控制檯（透過 System.out）
# log - 列印到日誌中
# off - 關閉列印
spring.main.banner-mode = off
# banner 檔案編碼
spring.banner.charset = UTF-8
# banner 文字檔案路徑
spring.banner.location = classpath:banner.txt
# banner 影像檔案路徑（可以選擇 png,jpg,gif 檔案）
spring.banner.image.location = classpath:banner.gif
used).
# 影像 banner 的寬度（字元數）
spring.banner.image.width = 76
# 影像 banner 的高度（字元數）
spring.banner.image.height =
# 影像 banner 的左邊界（字元數）
spring.banner.image.margin = 2
# 是否將影像轉為黑色控制檯主題
spring.banner.image.invert = false

當然，也可以在 YAML 檔案中配置，例如：

spring:
    banner:
        charset: UTF-8
        location: classpath:banner.txt

示例

新建 Spring Boot 專案（基於 Spring Boot 1.5.7）

package com.wupx.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class BannerApplication {

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

}

在 Spring Boot 專案中的 resources 目錄下新增 banner.txt 檔案，內容如下：

${AnsiColor.BRIGHT_YELLOW}${AnsiStyle.BOLD}
__  _  ___________  ___
 / / /____   /  /
      / |  |_> >    <
  /_/  |   __/__/_ 
         |__|        /
${AnsiColor.CYAN}${AnsiStyle.BOLD}
::  Java                 ::  (v${java.version})
::  Spring Boot          ::  (v${spring-boot.version})
${AnsiStyle.NORMAL}

啟動 Spring Boot 應用後，控制檯輸出的 Banner 如下：

推薦幾個生成字元畫的網站，可以將生成的字元畫放入這個 banner.txt 檔案：

總結

預設 Spring Boot 會註冊一個 SpringBootBanner 的單例 Bean，用來負責列印 Banner。

如果想完全個人定製 Banner，可以先實現 org.springframework.boot.Banner#printBanner 介面來自己定製 Banner。在將這個 Banner 透過 SpringApplication.setBanner() 方法注入 Spring Boot。

一般自定義 Spring Boot Banner 是企業/團隊/專案的 Slogan。

參考

https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-banner