快捷導(dǎo)航

詳解SpringBoot如何自定義啟動畫面

更新時間：2023年07月27日 09:19:27 作者：Jimmy

當(dāng)我們在啟動SpringBoot項目時候會在控制臺上看到一些單調(diào)的圖案，有些朋友覺得這些圖案很單調(diào)，那我們是否可以自定義啟動畫面呢，接下來小編就給大家介紹一下SpringBoot是如何實現(xiàn)自定義啟動畫面，感興趣的同學(xué)跟著小編一起來看看吧

自定 Banner

上面??的截圖信息就是 Banner 信息，我們可以在項目的 resources 下新建 banner.txt 來實現(xiàn)，比如：

// banner.txt
Jimmy

然后我們重新啟動項目，則有：

獲取屬性

當(dāng)然，我們可以獲取項目的屬性，通過 ${屬性名} 來獲取，比如：

${spring-boot.version}

獲取的屬性可以有：

AnsiColor.BRIGHT_RED: 設(shè)置控制臺中輸出內(nèi)容的顏色，具體參考 org.springframework.boot.ansi.AnsiColor
application.version: 用來獲取 MANIFEST.MF 文件的版本信息
application.formatted-version: 格式化后的 application.version 版本信息
spring-boot.version: Spring Boot 的版本號
spring-boot.formatted-version: 格式化后的 sprin-boot.version 版本信息

設(shè)置顏色

剛才我們提到了 AnsiColor 可以設(shè)置控制臺輸出內(nèi)容的顏色。那么，我們應(yīng)該如何設(shè)置呢？

這很簡單，只需要在這段文本前面加入 ${AnsiColor.BRIGHT_RED} 即可。添加的枚舉類型顏色根據(jù)個人喜好更改

// 枚舉值
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package org.springframework.boot.ansi;
public enum AnsiColor implements AnsiElement {
    DEFAULT("39"),
    BLACK("30"),
    RED("31"),
    GREEN("32"),
    YELLOW("33"),
    BLUE("34"),
    MAGENTA("35"),
    CYAN("36"),
    WHITE("37"),
    BRIGHT_BLACK("90"),
    BRIGHT_RED("91"),
    BRIGHT_GREEN("92"),
    BRIGHT_YELLOW("93"),
    BRIGHT_BLUE("94"),
    BRIGHT_MAGENTA("95"),
    BRIGHT_CYAN("96"),
    BRIGHT_WHITE("97");
    private final String code;
    private AnsiColor(String code) {
        this.code = code;
    }
    public String toString() {
        return this.code;
    }
}

實操

OK，我們了解得差不多了，來實操一下。通過 Text to ASCII Art Generator 獲取生成的藝術(shù)字。

然后在 banner.txt 上添加文本如下：

啟動成功！
${AnsiColor.BRIGHT_RED}
       _ _
      | (_)
      | |_ _ __ ___  _ __ ___  _   _
  _   | | | '_ ` _ | '_ ` _ | | | |
 | |__| | | | | | | | | | | | | |_| |
  ____/|_|_| |_| |_|_| |_| |_|__, |
                                __/ |
                               |___/
${AnsiColor.BRIGHT_WHITE}
歡迎使用～
spring boot 版本為 ${spring-boot.version}

我們重新運行下項目，效果如下：

關(guān)閉 Banner

我們不想使用 Banner，那么，我們在入口文件中進行關(guān)閉即可。

PS，我這里使用的 spring boot 版本為 3.1.2

原先入口文件：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class LaunchApplication {
    public static void main(String[] args) {
        SpringApplication.run(LaunchApplication.class, args);
    }
}

上面代碼其實可以寫成這樣：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class LaunchApplication {
    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(LaunchApplication.class);
        app.run(args);
    }
}

我們添加一行代碼禁用 banner.txt，更改后：

import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class LaunchApplication {
    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(LaunchApplication.class);
        app.setBannerMode(Banner.Mode.OFF); // 設(shè)置 Banner 模式為關(guān)閉
        app.run(args);
    }
}

啟動后，控制臺就沒有相關(guān)的 banner 信息了：