如何定製 Spring Boot 的 Banner？

時間 2019-11-13

原文原文鏈接

相信用過 Spring Boot 的朋友們必定在啓動日誌中見過相似以下的內容，好比在啓動 Spring Boot 時，控制檯默認會打印 Spring Boot Logo 以及版本信息，這是 Spring Boot 固定的仍是可自定義的呢？php

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

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

Banner 是如何出現的？

初始 Banner 的代碼是 SpringApplicationBannerPrinter 類，Spring Boot 默認尋找 Banner 的順序是:java

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

通常是把 banner.* 文件放在 src/main/resources/ 目錄下。spring

咱們能夠用屬性 banner.location 設定 Spring Boot 在不一樣於 Classpath 下找以上 banner.txt 文件，banner.charset 設定 banner.txt 的字符集，默認爲 UTF-8。屬性 banner.image.location 用於指定尋找 banner.(gif|jpg|png) 文件的位置。springboot

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

對於文本文件，Spring Boot 會將其直接輸出。
對於圖像文件（ banner.gif 、banner.jpg 或 banner.png ），Spring Boot 會將圖像轉爲 ASCII 字符，而後輸出。

變量

banner.txt 文件中還能夠使用變量來設置字體、顏色、版本號。spring-boot

變量	描述
`${application.version}`	`MANIFEST.MF` 中定義的版本。如：`1.0`
`${application.formatted-version}`	`MANIFEST.MF` 中定義的版本，並添加一個 `v` 前綴。如：`v1.0`
`${spring-boot.version}`	Spring Boot 版本。如：`1.5.7.RELEASE`
`${spring-boot.formatted-version}`	Spring Boot 版本，並添加一個 `v` 前綴。如：`v1.5.7.RELEASE`
`${Ansi.NAME}` (or `${AnsiColor.NAME}`, `${AnsiBackground.NAME}`, `${AnsiStyle.NAME}`)	ANSI 顏色、字體
`${application.title}`	`MANIFEST.MF` 中定義的應用名

配置

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 以下：