Spring Boot中如何自定义启动Banner？

在Spring Boot中自定义启动Banner是一个简单的过程，可以让你的Spring Boot应用程序启动时显示自定义的信息。下面是如何自定义启动Banner的步骤：

1. 使用文本Banner

你可以创建一个文本文件来作为启动Banner，Spring Boot会自动检测并使用它。文本Banner文件应命名为 banner.txt 或 banner.ascii 并放置在以下位置之一：

• 应用程序的主类所在的目录。
• 应用程序的 resources 目录中。

示例

假设你的主类位于 src/main/java/com/example/myapp 目录中，那么你可以创建一个名为 banner.txt 的文件，内容如下：

  _____                  _           _     
 / ____|                | |         (_)    
| (___   ___ _ __   ___ | |__   _ __ _  ___ 
 \___ \ / _ \ '_ \ / _ \| '_ \ | '__| |/ __|
 ____) |  __/ |_) | (_) | |_) || |  | |\__ \
|_____/ \___| .__/ \___/|_.__/ |_|  |_||___/
          | |                                 
          |_|                                 

将这个文件放在 src/main/resources 目录下。

2. 使用图片Banner

如果你想要一个更复杂的Banner，可以使用图片文件。Spring Boot支持PNG格式的图片作为Banner。图片文件应该命名为 banner.png，并且放置在 resources 目录中。

3. 自定义Banner逻辑

如果你想完全自定义Banner的生成逻辑，可以实现 Banner 接口并注入到Spring Boot中。

示例代码

import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;

public class CustomBanner implements Banner {

    @Override
    public void printBanner(SpringApplication application, Class<?> sourceClass, PrintStream out) {
        out.println(" _____                  _           _     ");
        out.println("/ ____|                | |         (_)    ");
        out.println("| (___   ___ _ __   ___ | |__   _ __ _  ___ ");
        out.println("\\___ \\ / _ \\ '_ \\ / _ \\| '_ \\ | '__| |/ __|");
        out.println(" ____) |  __/ |_) | (_) | |_) || |  | |\\__ \\");
        out.println("|_____/ \\___| .__/ \\___/|_.__/ |_|  |_|___/");
        out.println("          | |                                 ");
        out.println("          |_|                                 ");
        out.println();
        out.println("Application Name: " + application.getName());
        out.println("Version: " + application.getVersion());
        out.println("Active Profiles: " + Arrays.toString(application.getActiveProfiles()));
    }
}

// 在Spring Boot主类中注入自定义Banner
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(Application.class);
        app.setBannerMode(Banner.Mode.OFF); // 关闭默认Banner
        app.addInitializers((ApplicationArguments args) -> {
            app.setBanner(new CustomBanner());
        });
        app.run(args);
    }
}

在这个示例中，我们创建了一个 CustomBanner 类实现了 Banner 接口，并在 printBanner 方法中自定义了Banner的输出。然后在 Application 类中通过 SpringApplication 的 addInitializers 方法添加了一个初始化器来设置自定义的Banner。

4. 使用命令行参数

如果你不想修改代码或配置文件，也可以通过命令行参数来设置Banner文件的位置。例如：

java -jar myapp.jar --spring.banner.location=classpath:/my-custom-banner.txt

在这个命令中，--spring.banner.location 参数指定了自定义Banner文件的位置。

总结

Spring Boot提供了多种方式来自定义启动Banner，你可以根据自己的需求选择合适的方法。无论是使用简单的文本文件还是实现 Banner 接口，都可以让你的应用程序在启动时显示个性化的信息。