Spring Boot实例教程 - 自定义Banner


启动Spring Boot应用的时候,细心的同学可能会看到这个输出:

是不是很好奇这么好看的东西是怎么输出来的,好奇的同时是不是也想自己定义一下这个输出内容,比如输出自己的项目名、自己的名字、靓照等等。

本文就介绍如何定义Spring Boot的启动Banner。

Spring Boot提供了一个接口,也就是Banner,来打印启动Banner。下面我们来说下如何自定义Spring Boot启动Banner。

实现Sprig Boot自定义Banner有两种方式,一种是配置式,一种是编程式。

配置式Banner

1、在classpath下新建banner.txt。(注意这里也可以通过banner.location属性配置banner文件路径)

2、生成ASCII字符Banner。

ASCII字符生成器网上有很多,本文使用Spring Boot官方的Banner生成器:

https://spring-boot-banner-gen.cfapps.io/banner

第一步,选择图片

第二步,点击生成按钮,并将内容复制到banner.txt中,如图所示:

3、配置Banner的输出模式(默认CONSOLE):

/**
 * Banner实例
 *
 */
@SpringBootApplication
public class App 
{
    public static void main( String[] args )
    {
    	SpringApplication application = new SpringApplication(App.class);
    	application.setBannerMode(Banner.Mode.CONSOLE);
    	application.run(args);
    }
}

这里有三种模式可供配置:

        /**
		 * Disable printing of the banner.
		 */
		OFF,

		/**
		 * Print the banner to System.out.
		 */
		CONSOLE,

		/**
		 * Print the banner to the log file.
		 */
		LOG

4、启动应用,就可以看到自定义Banner的输出:

到这里就完成了自定义Banner的所有步骤。

编程式Banner

编程式Banner即通过编程的方式实现自定义的Banner。

Spring Boot提供了一个Banner接口,实现并重写打印方法即可。这里不再多说了。

副:可以在banner.txt中使用的变量

变量 描述
${application.version} 定义在MANIFEST.MF里的应用版本号。
${application.formatted-version} 定义在MANIFEST.MF里的应用版本号显示格式,如v1.0。
${spring-boot.version} 当前正在使用的Spring Boot版本号。如1.5.6.RELEASE。
${spring-boot.formatted-version} 当前正在使用的Spring Boot版本号展示格式。如v1.5.6.RELEASE。
${Ansi.NAME} (or ${AnsiColor.NAME},${AnsiBackground.NAME}, ${AnsiStyle.NAME}) ANSI转义码名字。
${application.title} 定义在MANIFEST.MF里的应用标题。

下载实例源码

马军伟
关于作者 马军伟
写的不错,支持一下

先给自己定个小目标,日更一新。