1. 什么是 Banner

啟動(dòng) Spring Boot 時(shí)，幾乎總是能在控制臺(tái)上方看到如下橫幅，這個(gè)也叫字符畫(huà)、英文ASCII藝術(shù)字

2. 如何修改 Banner

默認(rèn)情況下，只需在 resources 根目錄（準(zhǔn)確說(shuō)是 classpath）下新建一個(gè) banner.txt 文件，內(nèi)容即為 Banner

在 banner.txt 文件中，可以使用可用的任何鍵 Environment 以及以下任何占位符

3. IDEA 中演示

banner.txt 內(nèi)容如下，使用一個(gè)經(jīng)典的佛祖保佑 Banner，并演示占位符的使用

${spring-boot.formatted-version}
————————————————————————————————————————————————————————————————————
//                          _ooOoo_                               //
//                         o8888888o                              //
//                         88" . "88                              //
//                         (| ^_^ |)                              //
//                         O\  =  /O                              //
//                      ____/`---'\____                           //
//                    .'  \\|     |//  `.                         //
//                   /  \\|||  :  |||//  \                        //
//                  /  _||||| -:- |||||-  \                       //
//                  |   | \\\  -  /// |   |                       //
//                  | \_|  ''\---/''  |   |                       //
//                  \  .-\__  `-`  ___/-. /                       //
//                ___`. .'  /--.--\  `. . ___                     //
//              ."" '<  `.___\_<|>_/___.'  >'"".                  //
//            | | :  `- \`.;`\ _ /`;.`/ - ` : | |                 //
//            \  \ `-.   \_ __\ /__ _/   .-` /  /                 //
//      ========`-.____`-.___\_____/___.-`____.-'========         //
//                           `=---='                              //
//      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^        //
//            佛祖保佑       永不宕機(jī)     永無(wú)BUG                    //
————————————————————————————————————————————————————————————————————

運(yùn)行如下，符合預(yù)期

4. 快速生成 Banner

對(duì)于復(fù)雜的 Banner（譬如上面的佛祖），手打顯然是很浪費(fèi)時(shí)間精力的，通常會(huì)借助一些 Banner 生成工具快速生成

推薦一個(gè) Banner 在線生成工具

可以將輸入的文本轉(zhuǎn)換為 Banner，并且有多種字體可選

5. 指定 banner.txt 的位置

上面提到默認(rèn)情況下，banner.txt 必須放在 classpath（resources 根目錄 ）下方可生效，假設(shè)現(xiàn)在需要放在 resources/static 目錄下，在 application.yml 添加如下配置項(xiàng)即可

spring:
  banner:
  	# 或者 static/banner.txt
    location: classpath:static/banner.txt

需要說(shuō)明的是，在沒(méi)有顯式設(shè)置上述配置項(xiàng)時(shí)，Banner 文件只能為 banner.txt；顯式設(shè)置后，Banner 文件名就可以為 xxx.txt

6. 在 Spring Boot 2 中的說(shuō)明

6.1 圖片生成 Banner

在 3.0.x 的版本中，Banner 僅能通過(guò)文本文件（banner.txt）的方式設(shè)置，但在 2 的版本中，除了文本文件，還可以通過(guò)圖片的方式設(shè)置，查看 spring.banner 下的配置項(xiàng)就可以發(fā)現(xiàn)

通過(guò)配置項(xiàng) spring.banner.image.location 的默認(rèn)值可以看出，只需在 classpath 下放入一個(gè) banner.gif 圖片即可，經(jīng)過(guò)測(cè)試，除了 gif 格式的圖片，jpg、jpg 也能被識(shí)別，實(shí)際效果就是將圖片轉(zhuǎn)換為字符畫(huà)

以下圖為例（盒馬.jpg）

spring:
  banner:
    image:
      location: static/盒馬.jpg
      width: 38

由于默認(rèn)寬度（76）下在控制臺(tái)中生成的Banner過(guò)大，不便截圖，故此處指定了 width 屬性

生成效果：

可以看出，生成的 Banner 和原圖十分相似，甚至連顏色都還原了（用了某種算法）

6.2 增強(qiáng)顯示效果

還可以進(jìn)一步增強(qiáng)顯示效果，通過(guò)設(shè)置 spring.banner.image.pixelmode，將渲染圖像時(shí)使用的像素模式由默認(rèn)的 text 模式改為 block 模式

spring:
  banner:
    image:
      location: static/盒馬.jpg
      width: 38
      pixelmode: block

生成效果：

6.3 更多配置項(xiàng)

至于 spring.banner.image 的其他屬性不再逐一演示，因?yàn)槭趾?jiǎn)單，參照文檔一試便知，附上

遺憾的是，在 Spring Boot 3 中有關(guān) spring.banner.image.* 的配置項(xiàng)均已棄用，該功能已被剔除，僅支持文本文件的方式生成 Banner

7. 補(bǔ)充

在 2 版本中，可以同時(shí)指定文本文件和圖片生成 Banner。

若同時(shí)指定，控制臺(tái) Banner 打印順序?yàn)椋何谋疚募?、圖片

到此這篇關(guān)于SpringBoot自定義Banner使用詳解的文章就介紹到這了,更多相關(guān)SpringBoot自定義Banner內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論