SpringBoot開發 - 如何定製自己的Banner？還能用圖片？

来源:https://www.cnblogs.com/pengdai/archive/2022/07/09/16461673.html
-Advertisement-
Play Games

SpringBoot開發 - 如何定製自己的Banner？還能用圖片？ 我們在啟動Spring Boot程式時，有SpringBoot的Banner信息，那麼如何自定義成自己項目的信息呢？ @pdai SpringBoot開發 - 如何定製自己的Banner？還能用圖片？ 什麼是Banner 如何更 ...


SpringBoot開發 - 如何定製自己的Banner？還能用圖片？

我們在啟動Spring Boot程式時，有SpringBoot的Banner信息，那麼如何自定義成自己項目的信息呢？ @pdai

什麼是Banner

我們在啟動Spring Boot程式時，有如下Banner信息：

那麼如何自定義成自己項目的名稱呢？

如何更改Banner

更改Banner有如下幾種方式：

  • banner.txt配置（最常用）

在application.yml中添加配置

spring:
  banner:
    charset: UTF-8
    location: classpath:banner.txt

在resource下創建banner.txt，內容自定義：

----welcome----
https://pdai.tech
---------------

修改後，重啟的app的效果

  • SpringApplication啟動時設置參數
SpringApplication application = new SpringApplication(App.class);
/**
* Banner.Mode.OFF:關閉;
* Banner.Mode.CONSOLE:控制台輸出，預設方式;
* Banner.Mode.LOG:日誌輸出方式;
*/
application.setBannerMode(Banner.Mode.OFF); // here
application.run(args);

SpringApplication還可以設置自定義的Banner的介面類

文字Banner的設計

如何設計上面的文字呢？

一些設計Banner的網站

可以通過這個網站進行設計：patorjk Banner

比如：

我們修改banner.txt, 運行的效果如下

IDEA中Banner的插件

IDEA中也有插件，不過沒有預覽功能

其它工具

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

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

http://www.bootschool.net/ascii

Banner中其它配置信息

除了文件信息，還有哪些信息可以配置呢？比如Spring預設還帶有SpringBoot當前的版本號信息。

在banner.txt中，還可以進行一些設置：

# springboot的版本號 
${spring-boot.version}             
 
# springboot的版本號前面加v後上括弧 
${spring-boot.formatted-version}

# MANIFEST.MF文件中的版本號 
${application.version}              
 
# MANIFEST.MF文件的版本號前面加v後上括弧 
${application.formatted-version}

# MANIFEST.MF文件中的程式名稱
${application.title}

# ANSI樣色/樣式等
${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME})

簡單的測試如下（註意必須打包出Jar, 才會生成resources/META-INF/MANIFEST.MF）：

動畫Banner的設計

那我能不能設置動態的Banner呢？比如一個圖片？

SpringBoot2是支持圖片形式的Banner，

spring:
  main:
    banner-mode: console
    show-banner: true
  banner:
    charset: UTF-8
    image:
      margin: 0
      height: 10
      invert: false
      location: classpath:pdai.png

效果如下（需要選擇合適的照片，不然效果不好, 所以這種方式很少使用），

註意： 格式不能太大，不然會報錯

org.springframework.boot.ImageBanner     : Image banner not printable: class path resource [banner.gif] (class java.lang.ArrayIndexOutOfBoundsException: '4096')

進一步思考

圖片Banner是如何起作用的？

發現 Springboot 可以把圖片轉換成 ASCII 圖案，那麼它是怎麼做的呢？以此為例，我們看下Spring 的Banner是如何生成的呢？

  • 獲取Banner
    • 優先順序是環境變數中的Image優先,格式在IMAGE_EXTENSION中
    • 然後才是banner.txt
    • 沒有的話就用SpringBootBanner
  • 如果是圖片
    • 獲取圖片Banner（屬性配置等）
    • 轉換成ascii

獲取banner

class SpringApplicationBannerPrinter {
    static final String BANNER_LOCATION_PROPERTY = "spring.banner.location";
    static final String BANNER_IMAGE_LOCATION_PROPERTY = "spring.banner.image.location";
    static final String DEFAULT_BANNER_LOCATION = "banner.txt";
    static final String[] IMAGE_EXTENSION = new String[]{"gif", "jpg", "png"};
    private static final Banner DEFAULT_BANNER = new SpringBootBanner(); // 預設的Spring Banner
    private final ResourceLoader resourceLoader;
    private final Banner fallbackBanner;

    // 獲取Banner，優先順序是環境變數中的Image優先,格式在IMAGE_EXTENSION中，然後才是banner.txt
    private Banner getBanner(Environment environment) {
        SpringApplicationBannerPrinter.Banners banners = new SpringApplicationBannerPrinter.Banners();
        banners.addIfNotNull(this.getImageBanner(environment));
        banners.addIfNotNull(this.getTextBanner(environment));
        if (banners.hasAtLeastOneBanner()) {
            return banners;
        } else {
            return this.fallbackBanner != null ? this.fallbackBanner : DEFAULT_BANNER;
        }
    }

獲取圖片Banner

private Banner getImageBanner(Environment environment) {
    String location = environment.getProperty("spring.banner.image.location");
    if (StringUtils.hasLength(location)) {
        Resource resource = this.resourceLoader.getResource(location);
        return resource.exists() ? new ImageBanner(resource) : null;
    } else {
        String[] var3 = IMAGE_EXTENSION;
        int var4 = var3.length;

        for(int var5 = 0; var5 < var4; ++var5) {
            String ext = var3[var5];
            Resource resource = this.resourceLoader.getResource("banner." + ext);
            if (resource.exists()) {
                return new ImageBanner(resource);
            }
        }

        return null;
    }
}

獲取圖片的配置等

private void printBanner(Environment environment, PrintStream out) throws IOException {
    int width = (Integer)this.getProperty(environment, "width", Integer.class, 76);
    int height = (Integer)this.getProperty(environment, "height", Integer.class, 0);
    int margin = (Integer)this.getProperty(environment, "margin", Integer.class, 2);
    boolean invert = (Boolean)this.getProperty(environment, "invert", Boolean.class, false); // 圖片的屬性
    BitDepth bitDepth = this.getBitDepthProperty(environment);
    ImageBanner.PixelMode pixelMode = this.getPixelModeProperty(environment);
    ImageBanner.Frame[] frames = this.readFrames(width, height); // 讀取圖片的幀

    for(int i = 0; i < frames.length; ++i) {
        if (i > 0) {
            this.resetCursor(frames[i - 1].getImage(), out);
        }

        this.printBanner(frames[i].getImage(), margin, invert, bitDepth, pixelMode, out);
        this.sleep(frames[i].getDelayTime());
    }

}

轉換成ascii

private void printBanner(BufferedImage image, int margin, boolean invert, BitDepth bitDepth, ImageBanner.PixelMode pixelMode, PrintStream out) {
    AnsiElement background = invert ? AnsiBackground.BLACK : AnsiBackground.DEFAULT;
    out.print(AnsiOutput.encode(AnsiColor.DEFAULT));
    out.print(AnsiOutput.encode(background));
    out.println();
    out.println();
    AnsiElement lastColor = AnsiColor.DEFAULT;
    AnsiColors colors = new AnsiColors(bitDepth);

    for(int y = 0; y < image.getHeight(); ++y) {
        int x;
        for(x = 0; x < margin; ++x) {
            out.print(" ");
        }

        for(x = 0; x < image.getWidth(); ++x) {
            Color color = new Color(image.getRGB(x, y), false);
            AnsiElement ansiColor = colors.findClosest(color);
            if (ansiColor != lastColor) {
                out.print(AnsiOutput.encode(ansiColor));
                lastColor = ansiColor;
            }

            out.print(this.getAsciiPixel(color, invert, pixelMode)); // // 像素點轉換成字元輸出
        }

        out.println();
    }

    out.print(AnsiOutput.encode(AnsiColor.DEFAULT));
    out.print(AnsiOutput.encode(AnsiBackground.DEFAULT));
    out.println();
}

示例源碼

https://github.com/realpdai/tech-pdai-spring-demos

更多內容

告別碎片化學習，無套路一站式體系化學習後端開發: Java 全棧知識體系(https://pdai.tech)

更多文章請參考 [Java 全棧知識體系](https://pdai.tech)
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 聊聊數據溢出的事
    1、前言 直接看代碼 uint32_t Time_Interval() { static uint32_t old_time_tick; uint32_t data; data = sys_time_tick_ms - old_time_tick; old_time_tick = sys_time_ ...
  • 板級電源究竟該怎麼選型晶元？（實戰篇）
    寫在前面 大家在做板級電源設計的時候往往會有一種慣性思維： 要麼選擇自己曾經用過的電源晶元來搭建電路； 要麼直接選公司或者實驗室里現有的一些模塊； 但是你選的這個電源器件很有可能是不符合你的使用場景的，這就會造成很多的問題。 經典的不一定是最好的，經典也有過時的時候！ 當然涉及到板級電源的設計是一個 ...
  • mongodb 數據塊遷移的源碼分析
    零除的處理 用NULLIF(col, 0)可以避免複雜的WHEN...CASE判斷, 例如 ROUND(COUNT(view_50.amount_in)::NUMERIC / NULLIF(COUNT(view_50.amount_out)::NUMERIC, 0),2) AS out_divide ...
  • Css3入門詳解
    一、Css基本語法 1.Html和Css沒分開時 點擊查看代碼 <!DOCTYPE html> <html lang="en"> <head> <!--規範，<style>可以編寫css的代碼，每一個聲明，最好使用分號隔開 語法： 選擇器{ 聲明1； 聲明2； 聲明3； } --> <meta ch ...
  • thymeleaf實現前後端數據交換
    1.前端傳數據後端接收： 用戶在登錄界面輸入用戶名和密碼傳給後端controller，由後端判斷是否正確！ 在html界面中要傳遞的數據name命名，通過表單的提交按鈕會傳遞給響應的controller，在controller將需要的name接收！ <input type="text" name=" ...
  • 程式分析與優化 - 10 指令級並行
    本章是系列文章的第十章，主要介紹CPU流水線、超標量體系架構等硬體設計，和編譯器怎麼使能這些功能來減少計算的時鐘周期。 本文中的所有內容來自學習DCC888的學習筆記或者自己理解的整理，如需轉載請註明出處。周榮華@燧原科技 10.1 概念 指令級並行是是讓一個程式中的多個操作同時執行的方法 指令級並 ...
  • 單機高併發模型設計
    在微服務架構下，我們習慣使用多機器、分散式存儲、緩存去支持一個高併發的請求模型，而忽略了單機高併發模型是如何工作的。這篇文章通過解構客戶端與服務端的建立連接和數據傳輸過程，闡述下如何進行單機高併發模型設計。 ...
  • 【C++】學生管理系統
    在項目中，有些代碼需要被各個模塊調用。為瞭解耦，可以把這些公共部分的代碼整合到一個子項目中，併發布到本地，實現多個項目共用代碼。 新建子項目。 maven -clean 命令，測試maven環境；測試通過後使用maven -install 將項目打包併發布到本地倉庫。 在其他項目中，通過<depen ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類