如何定製 Spring Boot 的 Banner?

来源:https://www.cnblogs.com/wupeixuan/archive/2019/10/27/11749141.html
-Advertisement-
Play Games

相信用過 Spring Boot 的朋友們一定在啟動日誌中見過類似如下的內容,比如在啟動 Spring Boot 時,控制台預設會列印 Spring Boot Logo 以及版本信息,這是 Spring Boot 固定的還是可自定義的呢? . ____ _ __ _ _ /\\ / ___'_ __ ...


相信用過 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.gifbanner.jpgbanner.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 版本。如: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 如下:

logo

推薦幾個生成字元畫的網站,可以將生成的字元畫放入這個 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。

參考

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 新聞 "F eXchange 2020——徵文通知" "FSSF在忙什麼?2019年第三季度版本" "Miguel強烈推薦使用TensorFlow.NET" "運行在ASP.NET Core 3上的SAFE BookStore" "新的Thoth.Json站點" "Rider 2019.3早期可訪問 ...
  • 1 介紹 集合類可謂是學習必知、編程必用、面試必會的,而且集合的操作十分重要;本文主要講解如何合併集合類,如合併兩個數組,合併兩個List等。通過例子講解幾種不同的方法,有JDK原生的方法,還有使用第三庫的方法。 2 第三方庫 引入十分常用的優秀的第三方庫 和`Apache Commons pom. ...
  • A. Equalize Prices Again time limit per test 1 second memory limit per test 256 megabytes input standard input output standard output You are both a s ...
  • 當我們開始開發項目部署運行時,項目規模不大,只是在一個JVM實例中運行,對同一資源的併發訪問用JDK自帶的鎖機制就可以解決資源同時訪問的問題。而隨著項目的不斷發展,單體應用已經無法滿足日益增長的訪問需求,我們開始考慮多台部署,提高接收客戶端的連接請求,提高項目的吞吐量。一臺變多台,其中不可避免的問題 ...
  • Hello,各位小伙伴大家好,我是小棧君,昨天也就是2019年10月26日,有幸在成都參加了由阿裡舉辦的“Dubbo社區開發者日”。 本次活動匯聚了各方面的大神歡聚一堂,主要是對現有微服務狀態下的技術的痛點和執行流程的分享和解析。近距離的接觸到技術大佬們,面對面的交流,讓人獲益良多。 所以小棧君這裡 ...
  • 1.什麼是rpc RPC全稱為Remote Procedure Call,翻譯過來為“遠程過程調用”。目前,主流的平臺中都支持各種遠程調用技術,以滿足分散式系統架構中不同的系統之間的遠程通信和相互調用。遠程調用的應用場景極其廣泛,實現的方式也各式各樣。 2.從通信協議的層面 基於HTTP協議的(例如 ...
  • 前言 本方法基於web2py框架,使用web2py的完整網站數據包創建簡單網站。 web2py 是一個為Python語言提供的全功能Web應用框架,旨在敏捷快速的開發Web應用,具有快速、安全以及可移植的資料庫驅動的應用,相容 Google App Engine。 (百度百科:https://bai ...
  • lambda表達式是什麼? lambda 表達式是 Python 中創建匿名函數的一個特殊語法. 我稱 lambda 語法本身為 lambda 表達式,而它返回的函數我稱之為 lambda 函數。或者稱為匿名函數。 Python 的 lambda 表達式允許在一行代碼中創建一個函數並傳遞。 看下麵的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...