Spring Boot 之訂製 logo

dead_lee發表於2021-09-09
Spring BootGo

Spring Boot 啟動時預設會顯示以下 logo：

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

實際上，Spring Boot 支援自定義 logo 的功能。

讓我們來看看如何實現的。

簡介

只要你在 resources 目錄下放置名為 banner.txt、banner.gif 、banner.jpg 或 banner.png 的檔案，Spring Boot 會自動載入，將其作為啟動時列印的 logo。

  • 對於文字檔案，Spring Boot 會將其直接輸出。

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

變數

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

變數 描述
${application.version} MANIFEST.MF 中定義的版本。如：1.0
${application.formatted-version} MANIFEST.MF 中定義的版本，並新增一個 v 字首。如：v1.0
${spring-boot.version} Spring Boot 版本。如：2.1.1.RELEASE.
${spring-boot.formatted-version} Spring Boot 版本，並新增一個 v 字首。如：v2.1.1.RELEASE
${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME}) ANSI 顏色、字型。更多細節，參考：。
${application.title} MANIFEST.MF 中定義的應用名。

示例：

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

${AnsiColor.BRIGHT_YELLOW}${AnsiStyle.BOLD}
 ________  ___  ___  ________   ___       __   ___  ___|   ___ |  |  |   ___  |       |  |  |  
   _|    \     \                \  
     \    \     \        __      \  
     _\    \     \      |___     \  
    _______ _______ __\ __ ____________ _______
    |_______||_______||__| |__||____________||_______|${AnsiBackground.WHITE}${AnsiColor.RED}${AnsiStyle.UNDERLINE}:: Spring Boot ::             (v${spring-boot.version}):: Spring Boot Tutorial ::    (v1.0.0)

注：${} 設定字型顏色的變數之間不能換行或空格分隔，否則會導致除最後一個變數外，都不生效。

啟動應用後，控制檯將列印如下 logo：

圖片描述

推薦兩個生成字元畫的網站，可以將生成的字串放入這個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:  main:    banner-mode: off

程式設計

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

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

原始碼

完整示例：

使用方法：

mvn clean packagecd target
java -jar sbe-core-banner.jar

引申和引用

引申

參考

作者：

原文出處： https://www.cnblogs.com/jingmoxukong/p/10159493.html  

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/4686/viewspace-2819122/，如需轉載，請註明出處，否則將追究法律責任。

相關文章