怎么定制Spring Boot的Banner

這篇文章主要介紹怎么定制Spring Boot的Banner，文中介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們一定要看完！

相信用過 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 文件：

• http://www.network-science.de/ascii/

• http://patorjk.com/software/taag

• http://www.degraeve.com/img2txt.php

總結

默認 Spring Boot 會注冊一個 SpringBootBanner 的單例 Bean，用來負責打印 Banner。

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

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

以上是“怎么定制Spring Boot的Banner”這篇文章的所有內容，感謝各位的閱讀！希望分享的內容對大家有幫助，更多相關知識，歡迎關注億速云行業資訊頻道！