SpringBoot自定义banner

环境

• Ubuntu 22.04
• IntelliJ IDEA 2022.1.3
• JDK 17.0.3
• SpringBoot 2.7.3

准备

新建SpringBoot应用，启动程序时，在控制台会输出Spring的banner：

我们可以定制banner内容，也可以配置banner是否显示。

banner模式

在 application.properties 文件中添加配置项：spring.main.banner-mode=console | log | off

• console ：在控制台输出
• log ：在日志输出
• off ：关闭banner

banner内容

从上面的图片可见，banner由两部分组成，上面是一个字符图片，下面是一段文本。

要想定制化banner的内容，只需在 src/main/resources 目录下添加文件：

• banner.gif | jpg | png ：banner图片，SpringBoot会自动把它转化为字符图片；
• banner.txt ：banner文本；

自定义banner 图片

首先找一张图片，比如：

将其复制到 src/main/resources 目录下，并命名为 banner.jpg 。

在 application.properties 文件中可以配置图片的高度、宽度、颜色深度等：

spring.banner.image.width=100
spring.banner.image.height=20
spring.banner.image.bitdepth=4
1
2
3

自定义banner文本

在 src/main/resources 目录下创建 banner.txt 文件，内容如下：

Hello world!  ${spring-boot.formatted-version}
1

其中， ${spring-boot.formatted-version} 表示格式化的SpringBoot版本号。

运行程序，控制台输出如下：

此外，还可以指定任意路径，任意文件名的banner文本和图片，例如：

spring.banner.location=classpath:com/example/test0903/xxx.txt
spring.banner.image.location=classpath:com/example/test0903/inter.jpg
1
2

注意：测试时， xxx.txt 文件和 inter.jpg 文件位于源码目录的 com.example.test0903 包下，默认情况下，不会把这两个文件复制到 target 目录下的对应位置（因为它们不是Java文件），需要修改 pom.xml 文件，设置resource目录，详见我另一篇文档。

或者如果只想简单试一下，可以直接把文件复制到目标位置。